Webhooks update: new event types

We're excited to introduce our improved webhookWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. event types. They offer more contextual information within the webhookWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. message and provide better support for stateless architectures.

What's new?

We are replacing our existing rule types with an updated set of event types. They add context to our webhooksWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status., allow you to increase the precision of your webhookWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. messages, and provide detailed insights into the trigger events.

New event types

Check out the full range of our new webhook event types.

We have also adopted the payload structure recommended by the Standard Webhooks specification. As a result, here's what's new:

1. Standardized top-level schema

Event type schemas now conform to the same structure. It ensures the top-level properties are the same between all event types, making ingestion simpler.

Default schema structure

{
  "id": "bae71d36-ff47-420a-b4a6-f8c9ddf41140",
  "eventType": "company.created",
  "generatedDate": "2024-09-29T20:26:10.344522Z",
  "payload": {
    // Properties specific to event types
  }
}

2. Full payloads

We've chosen to support full webhookWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. payloads, providing complete data in each payload. This lets our webhooksWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. to function more like a reverse 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..

3. Reference companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources. property

WebhooksWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. that include information about a specific companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources. now have a referenceCompany property in their payload. It provides access to the companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources.’s ID, name, description, linksLink The authorization flow that allows end users to connect their accounting, banking, or commerce platforms to your application via Codat., and tags.

Tags are key-value pairs you can define when creating or updating a companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources.. Use them to pass metadata, such as a foreign key, to your webhookWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. consumer. Start with our documentation to Add tags to a company and Filter webhooks by company tags.

Reference company property

{
  "id": "bae71d36-ff47-420a-b4a6-f8c9ddf41140",
  "eventType": "company.created",
  "generatedDate": "2024-09-29T20:26:10.344522Z",
  "payload": {
    "referenceCompany": {
      "id": "5e505642-9024-474d-9434-e5a44f505cc5",
      "name": "Toft stores",
      "description": "Looking to get a loan for refurd.",
      "links": {
        "portal": "https://app.codat.io/companies/{companyId}/summary"
      },
      "tags": {
        "yourUserDefinedKey": "yourUserDefinedValue"
      }
    }
    // Properties specific to event types
  }
}

Who is this relevant for?

Any client currently using our webhooksWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. or clients looking to start using our webhookWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. service.

How to get started?

• Already using our legacy rules webhooksWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status.? Learn how to migrate to new event types.
• Implementing webhooksWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. for the first time? Learn how to use our webhook service.