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 APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms.. Use them to respond to changes in your companies and their data.
Navigate to Monitor > WebhooksWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. > 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 companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources. is created in Codat. |
company.deleted | Called when a companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources. is deleted in Codat. |
connection.created | Called when a connectionConnection A link between a Codat company and a data source (like an accounting platform). Each connection represents authorized access to pull or push data from that platform. is created by the SMBSMB The primary customer segment that Codat helps businesses serve, typically companies with annual revenues under $500 million.. |
connection.connected | Called when a connectionConnection A link between a Codat company and a data source (like an accounting platform). Each connection represents authorized access to pull or push data from that platform. is successfully linked by the SMBSMB The primary customer segment that Codat helps businesses serve, typically companies with annual revenues under $500 million.. |
connection.disconnected | Called when a connectionConnection A link between a Codat company and a data source (like an accounting platform). Each connection represents authorized access to pull or push data from that platform. is disconnected either due to being unlinked or de-authorized by the SMBSMB The primary customer segment that Codat helps businesses serve, typically companies with annual revenues under $500 million. or integration. |
connection.reconnected | Called when a connectionConnection A link between a Codat company and a data source (like an accounting platform). Each connection represents authorized access to pull or push data from that platform. is reconnected after becoming disconnected. |
connection.failed | Called when a connectionConnection A link between a Codat company and a data source (like an accounting platform). Each connection represents authorized access to pull or push data from that platform. failed linking to the SMBSMB The primary customer segment that Codat helps businesses serve, typically companies with annual revenues under $500 million.. |
connection.deleted | Called when a connectionConnection A link between a Codat company and a data source (like an accounting platform). Each connection represents authorized access to pull or push data from that platform. is deleted. |
read.completed | Indicates that the read of data types for a solution has completed. |
read.completed.initial | Indicates that the initial read of data types for a solution 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 APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. surpasses the allocated quota. |
client.rateLimit.reset | Called when the client's rate limit quota is reset, allowing additional requests to Codat's APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms.. |
Solution-specific event types
| Solution | Event type | Event description |
|---|---|---|
| Bank FeedsBank Feeds A Codat product that enables automatic synchronization of bank transaction data into a company's accounting software. | bankFeeds.sourceAccount.connected | Indicates a bank feed source account has changed to a status of connected. |
| Bank FeedsBank Feeds A Codat product that enables automatic synchronization of bank transaction data into a company's accounting software. | bankFeeds.sourceAccount.disconnected | Indicates a bank feed source account has changed to a status of disconnected. |
| Expenses | expenses.sync.successful | Called when an expense syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. successfully completes without any errors or warnings. |
| Expenses | expenses.sync.unsuccessful | Called when an expense syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. fails to complete successfully, resulting in at least one error or warning. |
| Lending | report.categorizedBankStatement.generate.successful | Called when a categorized bank statement is successfully generated for a companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources.. |
| Lending | AccountCategoriesUpdated | Called when Codat AI had categorized accounts for a companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources.. |
| Lending | reports.creditModel.generate.successful | Called when the Credit Model report is successfully generated for a companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources.. |
| Lending | reports.creditModel.generate.unsuccessful | Called when the Credit Model report fails to generate for a companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources.. |
| Spend Insights | reports.spendAnalysis.generate.successful | Called when a spend analysis report is successfully generated. |
| Spend Insights | reports.spendAnalysis.generate.unsuccessful | Called when a spend analysis report has failed to be generated for a companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources.. |
Read next
- See how you can consume webhooks and manage consumers using the Portal or our APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms.
Was this page useful?
👏
👍
🤔
👎
😭