Skip to content

Commit

Permalink
Update migration-guide-advanced.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@pzaichkina
pzaichkina authored Mar 7, 2024
1 parent 644f6b4 commit 7b5015a
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/using-the-api/webhooks/migration-guide-advanced.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ If you are considering using Codat's new webhook management endpoints, check tha

| I am using... | Action and impact |
|----------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ...email notification functionality | * Do not migrate to the new webhook service <br/> * Review the [critical considerations](/using-the-api/webhooks/migration-guide-advanced#email-notification-functionality) |
| ...event log endpoints (e.g. `/rules/alerts`) | * Do not migrate until you have removed all calls to logs endpoints from your application logic <br/> * Review the [critical considerations](/using-the-api/webhooks/migration-guide-advanced#event-log-endpoints) |
| ...`RuleId` in my application's existing logic | * Do not migrate until you have removed all application logic using the `RuleId` property <br/> * Review the [critical considerations](/using-the-api/webhooks/migration-guide-advanced#ruleid-in-existing-logic) |
| ...only company-agnostic webhook functionality | * Request to migrate to the new webhook service <br/> |
| ...company-specific webhook functionality | * Request to migrate to the new webhook service <br/> * Review the [additional considerations](/using-the-api/webhooks/migration-guide-advanced#company-specific-webhooks) |
| ...`X-Codat-ClientId` header to determine the source Codat instance of the event | * Request to migrate to the new webhook service <br/> * Configure a custom header, as described in [additional considerations](/using-the-api/webhooks/migration-guide-advanced#source-client-header) |
| ...webhook auth header via the `/profile` endpoint | * Request to migrate to the new webhook service <br/> * Configure a custom header using the Portal, as described in [additional considerations](/using-the-api/webhooks/migration-guide-advanced#webhook-auth-header) |
| ...webhook auth header via the Portal | * Request to migrate to the new webhook service <br/> * Configure a custom header using the Portal, as described in [additional considerations](/using-the-api/webhooks/migration-guide-advanced#webhook-auth-header) |
| ...`Retry-After` header to control the time between retries | * Request to migrate to the new webhook service <br/> * Review the [additional considerations](/using-the-api/webhooks/migration-guide-advanced#retry-after-header) |
| ...email notification functionality | - Do not migrate to the new webhook service <br/> - Review the [critical considerations](/using-the-api/webhooks/migration-guide-advanced#email-notification-functionality) |
| ...event log endpoints (e.g. `/rules/alerts`) | - Do not migrate until you have removed all calls to logs endpoints from your application logic <br/> - Review the [critical considerations](/using-the-api/webhooks/migration-guide-advanced#event-log-endpoints) |
| ...`RuleId` in my application's existing logic | - Do not migrate until you have removed all application logic using the `RuleId` property <br/> - Review the [critical considerations](/using-the-api/webhooks/migration-guide-advanced#ruleid-in-existing-logic) |
| ...only company-agnostic webhook functionality | - Request to migrate to the new webhook service <br/> |
| ...company-specific webhook functionality | - Request to migrate to the new webhook service <br/> - Review the [additional considerations](/using-the-api/webhooks/migration-guide-advanced#company-specific-webhooks) |
| ...`X-Codat-ClientId` header to determine the source Codat instance of the event | - Request to migrate to the new webhook service <br/> - Configure a custom header, as described in [additional considerations](/using-the-api/webhooks/migration-guide-advanced#source-client-header) |
| ...webhook auth header via the `/profile` endpoint | - Request to migrate to the new webhook service <br/> - Configure a custom header using the Portal, as described in [additional considerations](/using-the-api/webhooks/migration-guide-advanced#webhook-auth-header) |
| ...webhook auth header via the Portal | - Request to migrate to the new webhook service <br/> - Configure a custom header using the Portal, as described in [additional considerations](/using-the-api/webhooks/migration-guide-advanced#webhook-auth-header) |
| ...`Retry-After` header to control the time between retries | - Request to migrate to the new webhook service <br/> - Review the [additional considerations](/using-the-api/webhooks/migration-guide-advanced#retry-after-header) |

## Critical considerations

Expand Down

0 comments on commit 7b5015a

Please sign in to comment.