Skip to main content

Event Types

Data entity events follow EntityName.operation and generally use thin payloads.Example payload:

Events with additional metadata

BankTransaction lifecycle webhooks include an optional category object on data when the transaction is categorized to a ledger account. category includes the account id, optional stable_name, and display_name. This is typically present on BankTransaction.updated after categorization.

Bank transaction document events

BankTransaction.document_attached fires when a document, such as a receipt or invoice, is attached to a bank transaction. BankTransaction.document_archived fires when that document is archived. Use these events to know whether a transaction has a document without polling List transaction documents. The current document IDs are also in document_ids on the bank transaction.BusinessTask lifecycle webhooks include the current active task count for the business in addition to the standard lifecycle entity fields.