webhooks-tag-description
Customaite can push data to your servers, via the webhook interface. Customaite supports two kinds of webhooks:
- Publish webhooks: which will push declarations (Import, Export, Transit, CHED) to you once they are published within Customaite
- Status webhooks: which will send an event to your server when a dossier status has been changed
You can register webhooks for either type, and use these endpoints to list the currently registered webhooks. It is possible to register multiple webhooks for the same type: in this case, all registered webhooks will be called.
For a webhook, we recommend either basic http authentication is configured or an api key is defined. In case of the latter, you must specify which header name Customaite should use.
Retry policy
In case of failures, we will attempt to retry for a short while. At most 20 times, and no longer than maxRetrySeconds in case this optional field is configured. We retry on 5xx server exception codes, and for a limited set of 4xx client error codes such as 408 (Request Timeout), 409 (Conflict) and 429 (Too Many Requests).