2025-01-10: Deprecation of legacy webhooks

On January 10, 2025, we will deprecate our legacy rule-based webhooksWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. service following the release of our new webhooks service and webhook event types.

Here's what our new webhooksWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. service provides:

⚙️ Smart retries: We automatically retry missed events and failed webhookWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. deliveries, ensuring your crucial messages reach their destination without hassle.

🔄 Event replay: We make it a breeze to replay successful and unsuccessful event deliveries, enabling you to recover from any system failures on your end.

📝 Detailed event logging: Use our detailed delivery attempt overview to gain deep insights into 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. events, resolve issues, and view event payloads.

🧪 Mocked events: Test, debug, and refine 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. consumers with ease using mocked events. Select the event type you want to trigger and we'll deliver it to your application. 

🛡️ Improved stability: Our new webhooksWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. service is engineered for resilience and delivers unmatched performance and uptime to support your critical operations.

Action required

If you are using our legacy rules-based 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, migrate to the new webhooksWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. service following our Migration guide for basic webhook setup.

Additionally, you need to change your notification configuration to use the new event types instead. Follow our New event types migration guide to switch to the new types.

CompanyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources.-specific rules

If you are currently using companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources.-specific rules with our legacy service, use companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources. tags with our updated 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 instead. You can add metadata to a companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources. using tags and filter the webhooksWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. based on them.

CompanyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources. information using tags

For example, if you previously passed companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources. information via 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. consumer's path (such as POST /region/{regionId}/accounts/{accountId}), you can use tags when creating or udating a companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources. as follows:

{
  "name": "{you company name}",
  "tags": {
    "region": "{regionId}",
    "account": "{accountId}"
  }
}

This metadata will then be passed 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 in the payload.referenceCompany.tags property. See Add metadata to a company

Filter webhooksWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. based on tags

To route specific companies to designated webhookWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. consumers, use the companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources. tags filter for 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. This allows you to send messages only for companies with tags that match any of the tags defined on 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. consumer.

For additional information, see Filter webhooks by company tags.

Expected impact

If no action is taken by January 10, 2025, you will no longer receive webhookWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. notifications from us.