url
with the https scheme and a valid X.509 certificate. When your endpoint is created, a PKI public key
in PEM
format will be assigned to it and shared with you. Refer to Webhook Event Signature Verification for details on how to verify the authenticity of incoming events.
When your endpoint is active, Bridge will deliver events with POST
with the application/json
content type. The endpoint should return a 200 status to Bridge as quickly as possible to avoid timeouts and retries on the Bridge side.
disabled
state.disabled
- This is the initial state of all newly created webhooks. Events will not automatically be delivered to the endpoint in this state. We recommend testing the webhook from this state using (see POST /send documentation). You can update the webhook to active
using PUT /webhooks. Webhooks must be disabled in order to change their URLactive
- Bridge will automatically deliver events to your webhook. Automatic delivery of events can be paused by updating the webhook to disabled
using PUT /webhooksdeleted
- This state is only visible as the result of a DELETE /webhooks request. This state is not considered a valid status input of PUT /webhooks. Webhooks in this state will no longer be accessible from subsequent API requests.