v1

latestOpenAPI 3.0.22026-07-26128245430.3 KB

Webhooks

Create a webhook endpoint

Create a new webhook endpoint to receive events from Bridge. Webhook endpoints begin in a disabled state and can be enabled with a PUT request. A maximum of 5 webhooks can be active or disabled at one time. Webhook endpoints can be created in Sandbox, but no webhook events will be sent.

post/webhooks

Headers

Idempotency-Keystring required

Request body

urlstring required

The URL that the webhook will send events to. It must use the HTTPS scheme and have a valid X.509 certificate. The URL doesn't need to be live, but the host must be reachable.

event_epoch'webhook_creation' | 'beginning_of_time' required

Specifies the starting point from which this webhook will receive events. This should usually be set to "webhook_creation", unless there is a reason why this webhook needs to process events from before its creation. When this value is set to "webhook_creation", the webhook will receive a small number of events preceding its creation for convenience.

event_categoriesWebhookEventCategory[]

The list of event categories that the webhook endpoint will receive

Response

Webhook endpoint created

idstring required

An identifier that uniquely identifies the webhook endpoint

urlstring required

The URL that the webhook will send events to

status'active' | 'disabled' | 'deleted' required

The status of the webhook. Only active webhooks will receive events automatically.

public_keystring required

The public key (in PEM format) that should be used to verify the authenticity of webhook events

event_categoriesWebhookEventCategory[]

The list of event categories that the webhook endpoint will receive