Documentation Index Fetch the complete documentation index at: https://docs.layerfi.com/llms.txt
Use this file to discover all available pages before exploring further.
Event Types Data entity events follow EntityName.operation and generally use thin payloads. Example payload: { "id" : "Customer_created_7bcef4fd-9458-49d0-a7e7-589f5e6f2683_03f6c94f-574d-42ca-a6cd-fecf2a2aeccb" , "type" : "Customer.created" , "business_id" : "8e7a359e-7af5-4f6e-b786-6ddfd1807c32" , "business_external_id" : "biz_101" , "data" : { "entity_id" : "7bcef4fd-9458-49d0-a7e7-589f5e6f2683" , "entity_external_id" : "cust_2001" } }
Entity Events BankTransaction BankTransaction.created, BankTransaction.updated, BankTransaction.archivedBill Bill.created, Bill.updated, Bill.archivedBillPayment BillPayment.created, BillPayment.updated, BillPayment.archivedBusiness Business.created, Business.updated, Business.archivedBusinessTask BusinessTask.created, BusinessTask.updated, BusinessTask.archivedCustomer Customer.created, Customer.updated, Customer.archivedCustomerCredit CustomerCredit.created, CustomerCredit.updated, CustomerCredit.archivedCustomerPayout CustomerPayout.created, CustomerPayout.updated, CustomerPayout.archivedCustomerRefund CustomerRefund.created, CustomerRefund.updated, CustomerRefund.archivedGeneralLedgerAccount GeneralLedgerAccount.created, GeneralLedgerAccount.updated, GeneralLedgerAccount.archivedInvoice Invoice.created, Invoice.updated, Invoice.archivedInvoicePayment InvoicePayment.created, InvoicePayment.updated, InvoicePayment.archivedInvoiceWriteOff InvoiceWriteOff.created, InvoiceWriteOff.updated, InvoiceWriteOff.archivedTaxProfile TaxProfile.created, TaxProfile.updated, TaxProfile.archivedTimeEntry TimeEntry.created, TimeEntry.updated, TimeEntry.archivedTrip Trip.created, Trip.updated, Trip.archivedVehicle Vehicle.created, Vehicle.updated, Vehicle.archivedVendor Vendor.created, Vendor.updated, Vendor.archivedVendorCredit VendorCredit.created, VendorCredit.updated, VendorCredit.archivedVendorPayout VendorPayout.created, VendorPayout.updated, VendorPayout.archivedVendorRefund VendorRefund.created, VendorRefund.updated, VendorRefund.archived
BusinessTask lifecycle webhooks include the current active task count for the business in addition to the standard lifecycle entity fields.Show BusinessTask example payload
{ "id" : "BusinessTask_created_7bcef4fd-9458-49d0-a7e7-589f5e6f2683_03f6c94f-574d-42ca-a6cd-fecf2a2aeccb" , "type" : "BusinessTask.created" , "business_id" : "8e7a359e-7af5-4f6e-b786-6ddfd1807c32" , "business_external_id" : "biz_101" , "data" : { "entity_id" : "7bcef4fd-9458-49d0-a7e7-589f5e6f2683" , "entity_external_id" : null , "open_task_count" : 3 } }
User activity events use the activity.* namespace. Example payload: { "id" : "activity_categorize_bank_transaction_44bb48bd-4af1-4e6f-a38a-fb24e5575dc7" , "type" : "activity.categorize_bank_transaction" , "business_id" : "8e7a359e-7af5-4f6e-b786-6ddfd1807c32" , "business_external_id" : "biz_101" , "data" : { "transaction_id" : "34db2910-5919-4985-8e7f-56dd83e76ed5" , "categorization_method" : "API" , "categorization" : null , "matchType" : "INVOICE_PAYMENT" , "created_at" : "2026-03-31T16:42:11Z" } }
activity.categorize_bank_transactionactivity.load_pnlactivity.load_balance_sheetactivity.load_cashflow_statementactivity.create_custom_accountactivity.archive_custom_accountactivity.reactivate_custom_accountactivity.upload_custom_account_csvactivity.export_pnl_csvactivity.export_pnl_excelactivity.export_pnl_comparison_csvactivity.export_pnl_month_over_monthactivity.export_pnl_line_item_excelactivity.export_balance_sheet_csvactivity.export_balance_sheet_excelactivity.export_cashflow_csvactivity.export_cashflow_excelactivity.export_transactions_csvactivity.export_transactions_excelactivity.export_pnl_pdfactivity.export_trial_balance_excelactivity.export_ar_aging_excelactivity.export_business_expenses_excelactivity.export_business_income_excelactivity.export_business_mileage_excelactivity.export_personal_expenses_excelactivity.export_personal_income_excelactivity.export_personal_mileage_excelactivity.export_time_tracking_excelactivity.export_schedule_c_excelactivity.generate_tax_packet SMS events use the sms.* namespace. Example payload: { "id" : "sms_message_received_SM1234567890" , "type" : "sms.message_received" , "business_id" : "8e7a359e-7af5-4f6e-b786-6ddfd1807c32" , "business_external_id" : "biz_101" , "data" : { "message_id" : "SM1234567890" , "direction" : "RECEIVED" , "body" : "Classify this as utilities" , "phone_number" : "+15551234567" , "delivery_status" : null , "at" : "2026-03-31T16:48:55Z" } }
sms.message_receivedsms.message_deliveredsms.message_delivery_failed External account events use the external_accounts.* namespace.
These events include the current count of external accounts that need repair for the business. Example payload: { "id" : "external_accounts_link_connected_03f6c94f-574d-42ca-a6cd-fecf2a2aeccb" , "type" : "external_accounts.link.connected" , "business_id" : "8e7a359e-7af5-4f6e-b786-6ddfd1807c32" , "business_external_id" : "biz_101" , "data" : { "provider" : "plaid" , "at" : "2026-03-31T16:50:29Z" , "link_id" : "719b0d31-ba7b-4f1b-982a-c6334b0a544b" , "external_link_id" : "plaid_item_123" , "account_ids" : [ "92762148-f10b-42a5-b37f-b1e23fa3faca" ], "external_account_ids" : [ "plaid_account_456" ], "accounts_needing_repair_count" : 1 } }
external_accounts.link.connectedexternal_accounts.link.disconnectedexternal_accounts.link.archivedexternal_accounts.link.reactivatedexternal_accounts.link.needs_repairexternal_accounts.link.repairedexternal_accounts.account.connectedexternal_accounts.account.archivedexternal_accounts.account.reactivatedexternal_accounts.account.needs_repairexternal_accounts.account.repaired Plaid-specific events use the plaid.* namespace. Example payload: { "id" : "plaid_link_token_created_Aim3b8jJC9eRyfy" , "type" : "plaid.link.token_created" , "business_id" : "8e7a359e-7af5-4f6e-b786-6ddfd1807c32" , "business_external_id" : "biz_101" , "data" : { "created_at" : "2026-03-31T16:50:29Z" , "plaid_request_id" : "Aim3b8jJC9eRyfy" } }
Payload Fields Field Type Description idstring Unique identifier for this webhook event. Suffixed with the Plaid request id. typestring Always plaid.link.token_created business_idstring (UUID) The Layer business ID business_external_idstring or null Your external identifier for the business, if set data.created_atstring (date-time) When the link token was created data.plaid_request_idstring The Plaid request_id returned by Plaid for the link-token-create call. Useful when correlating with Plaid logs or support tickets.
When This Webhook Fires The plaid.link.token_created webhook fires whenever Layer mints a Plaid link token for a business — this corresponds to the user initiating the Plaid Link flow (e.g. clicking “Add Account” or starting an update-mode reconnect). The event fires before the user selects an institution or completes the flow, so it can be used as a click-level signal. To know when a connection is actually established, listen for external_accounts.link.connected. Bookkeeping onboarding events notify your application at the end of a business’s Layer bookkeeping onboarding call, when their bookkeeping configuration’s onboarding_date is set for the first time. Example payload: { "id" : "bookkeeping_onboarding_completed_00000000-0000-0000-0000-000000000002_03f6c94f-574d-42ca-a6cd-fecf2a2aeccb" , "type" : "bookkeeping_onboarding.completed" , "business_id" : "8e7a359e-7af5-4f6e-b786-6ddfd1807c32" , "business_external_id" : "biz_101" , "data" : { "bookkeeping_configuration_id" : "00000000-0000-0000-0000-000000000002" , "onboarding_date" : "2024-01-15" } }
bookkeeping_onboarding.completed Payload Fields Field Type Description idstring Unique identifier for this webhook event typestring Always bookkeeping_onboarding.completed business_idstring (UUID) The Layer business ID business_external_idstring or null Your external identifier for the business, if set data.bookkeeping_configuration_idstring (UUID) The ID of the bookkeeping configuration that completed onboarding data.onboarding_datestring (date) The date when bookkeeping onboarding was completed, in YYYY-MM-DD format
When This Webhook Fires The bookkeeping_onboarding.completed webhook fires when Layer updates the business’s bookkeeping configuration at the end of their onboarding call. This webhook only fires when the onboarding_date transitions from unset (null) to a value. Subsequent updates to onboarding_date do not trigger additional webhooks.
