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
/rules
endpoints?The names of our new event types differ from our legacy rule types. You can find the list of legacy rule types in our Rule types documentation.
Event type | Event description |
---|---|
AccountCategoriesUpdated | Triggered anytime a company's accounts are categorized. This can be when Codat updates the suggested category fields or a user updates the confirmed category fields. See this event's schema in the API reference. |
bankFeeds.sourceAccount.connected | Indicates a bank feed source account has changed to a status of connected. Used for Bank Feeds API only. See this event's schema in the API reference. |
bankFeeds.sourceAccount.disconnected | Indicates a bank feed source account has changed to a status of disconnected. Used for Bank Feeds API only. See this event's schema in the API reference. |
ClientRateLimitReached | Triggered when the number of requests to Codat's API from the client exceeds the current quota. See this event's schema in the API reference. |
ClientRateLimitReset | Triggered when the rate limit quota has reset for the client, and more requests to the API are available. See this event's schema in the API reference. |
DataConnectionStatusChanged | Triggered when a data connection status of a specific company changes. See this event's schema in the API reference. |
DataSyncCompleted | Generated for each dataType to indicate that data synchronization is successfully completed for that specific data type. See this event's schema in the API reference. |
DataSyncStatusChangedToError | Triggered when the synchronization of a dataset fails. See this event's schema in the API reference. |
DatasetDataChanged | Generated for each dataType to indicate that dataset synchronization has completed and updated Codat's data cache through the creation of new records or a change to existing records. See this event's schema in the API reference. |
NewCompanySynchronized | Triggered when initial syncs are complete for all data types queued for a newly connected company, and at least one of those syncs is successful. See this event's schema in the API reference. |
PushOperationStatusChanged | Indicates that a create, update, or delete operation's status has changed. You can learn more about push operations at Codat. See this event's schema in the API reference. |
PushOperationTimedOut | Indicates that a create, update, or delete operation has timed out. You can learn more about timeouts for push operations at Codat. See this event's schema in the API reference. |
SyncCompleted | Triggered anytime an expense sync completes. Used for Sync for Expenses only. See this event's schema in the API reference. |
SyncConnectionDeleted | Indicates a Sync for Commerce connection has been deleted. Used for Sync for Commerce only. See this event's schema in the API reference. |
SyncFailed | Indicates a failure occurred during an expense sync. Used for Sync for Expenses only. See this event's schema in the API reference. |
Read next
- See how you can consume webhooks and manage consumers using the Portal or our API