Webhooks
Update webhook
POST
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
The version of the API for which you registered the webhook. This helps to maintain backward compatibility. If in newer versions the event payload is changed, your webhook will keep receiving the payload from this api version. This will be 'v1.0' for now and we will come up with more versions and a changelog later.
Optional name to define the purpose of the webhook.
If the webhook is active or not. If a webhook is disabled it won't be called when a topic is triggered.
Available options:
ENABLED
, DISABLED
An array of topics to listen to. When any of these topics are triggered, the webhook will be pinged.
Available options:
REGISTRATIONS.EXISTING.VALIDATION.FAILED
, REGISTRATIONS.EXISTING.VALIDATION.SUCCEEDED
, REGISTRATIONS.NEW.SUCCEEDED
, REGISTRATIONS.NEW.INVALID
, EXEMPTION_CERTIFICATES.VERIFICATION.FAILED
, EXEMPTION_CERTIFICATES.VERIFICATION.SUCCEEDED
, EXEMPTION_CERTIFICATES.EXPIRATION
, NEXUS.THRESHOLD.STATE.ALERT
, CUSTOMS_DUTY.CUSTOMS_CODE.UPDATE
Response
200 - application/json