Create a new webhook endpoint
post/webhook
Request body
legalEntityIdstring
The ID of the LegalEntity to create the webhook for. You can get this by calling GET /legal-entity. This field is required unless you are authenticating via API key.
urlstring required
The URL that will receive the webhook payload
namestring required
Response
OK
idstring required
createdAtstring required
archivedAtstring
urlstring required
The URL that will receive the webhook payload
namestring required
The name of the webhook
status'active' | 'paused' | 'backing-off' | 'disabled' required
The current status of the webhook endpoint:
- active: The webhook is enabled and receiving events normally.
- paused: The webhook has been paused by the user. Events are queued and will be delivered when the endpoint is set back to active.
- backing-off: The system is temporarily backing off due to delivery failures. Delivery will be automatically retried at backingOffUntil. You can also immediately re-enable by setting status to active via the PATCH endpoint.
- disabled: The webhook has been automatically disabled due to repeated delivery failures. Re-enable by setting status to active via the PATCH endpoint.
pausedAtstring
When the endpoint was paused by the user (ISO 8601 timestamp)
backingOffUntilstring
When the system will automatically retry delivery (ISO 8601 timestamp). Only present when status is backing-off.
disabledAtstring
When the endpoint was automatically disabled due to repeated failures (ISO 8601 timestamp). Only present when status is disabled.