Webhook event types

Learn about the event types that are available to you for consumption

Codat supports the following event types you can consume using the Codat Portal or our API. Use them to respond to changes in your companies and their data.

Navigate to Monitor > Webhooks > Events > Event Catalog to view this list and each event's payload directly in the Portal.

Still using our legacy rules?

See our migration guide to switch to new event types.

Platform-wide event types

Event type	Event description
company.created	Called when a company is created in Codat.
company.deleted	Called when a company is deleted in Codat.
connection.created	Called when a connection is created by the SMB.
connection.connected	Called when a connection is successfully linked by the SMB.
connection.disconnected	Called when a connection is disconnected either due to being unlinked or de-authorized by the SMB or integration.
connection.reconnected	Called when a connection is reconnected after becoming disconnected.
connection.failed	Called when a connection failed linking to the SMB.
connection.deleted	Called when a connection is deleted.
read.completed	Indicates that the read of data types for a product has completed.
read.completed.initial	Indicates that the initial read of data types for a product has completed.
{dataType}.write.successful	Indicates that the specified data type has been successfully created, updated, deleted, or had an attachment uploaded in the accounting software.
{dataType}.write.unsuccessful	Indicates that an attempt to create, update, delete a data type, or upload an attachment to a data type in the accounting software has been unsuccessful.
client.rateLimit.reached	Called when the client’s request count to Codat's API surpasses the allocated quota.
client.rateLimit.reset	Called when the client's rate limit quota is reset, allowing additional requests to Codat's API.

Product-specific event types

Product	Event type	Event description
Bank Feeds API	bankFeeds.sourceAccount.connected	Indicates a bank feed source account has changed to a status of connected.
Bank Feeds API	bankFeeds.sourceAccount.disconnected	Indicates a bank feed source account has changed to a status of disconnected.
Sync for Expenses	expenses.sync.successful	Called when an expense sync successfully completes without any errors or warnings.
Sync for Expenses	expenses.sync.unsuccessful	Called when an expense sync fails to complete successfully, resulting in at least one error or warning.
Lending API	report.categorizedBankStatement.generate.successful	Called when a categorized bank statement is successfully generated for a company.
Lending API	AccountCategoriesUpdated	Called when Codat AI had categorized accounts for a company.

---

Read next

• See how you can consume webhooks and manage consumers using the Portal or our API