Webhooks migration guide for complex scenarios
Learn about the additional impact of transitioning to our new service based on your specific setup
Should I migrate to the new service and endpoints?
If you are considering using Codat's new webhookWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. management endpoints, check that your setup is compatible first. Find the scenarios applicable to your existing setup and see if you can migrate.
| I am using... | Action and impact |
|---|---|
| ...email notification functionality | - Migrate to the new 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 - Review the critical considerations |
...event log endpoints (e.g. /rules/alerts) | - Do not migrate until you have removed all calls to logs endpoints from your application logic - Review the critical considerations |
...RuleId in my application's existing logic | - Do not migrate until you have removed all application logic using the RuleId property - Review the critical considerations |
| ...only companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources.-agnostic webhookWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. functionality | - Request to migrate to the new 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 |
| ...companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources.-specific webhookWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. functionality | - Request to migrate to the new 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 - Review the additional considerations |
...X-Codat-ClientId header to determine the source Codat instance of the event | - Request to migrate to the new 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 - Review the additional considerations |
...webhookWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. auth header via the /profile endpoint | - Request to migrate to the new 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 - Review the additional considerations |
| ...webhookWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. auth header via the Portal | - Request to migrate to the new 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 - Review the additional considerations |
...Retry-After header to control the time between retries | - Request to migrate to the new 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 - Review the additional considerations |