Bridge's Webhooks API allows developers to receive real-time event notifications from Bridge systems, avoiding the need for inefficient polling. Webhooks provide a faster, more scalable way to stay updated on activity like customer creation, transfer status changes, and more.

Integration Steps

Here’s a typical step-by-step process to implement webhooks:

1. Create your webhook
   1. Call the Create a webhook endpoint — the webhook starts in a disabled state.
2. Implement signature verification.
   1. Follow the guide on Webhook Event Signature Verification to validate event authenticity.
3. Test your integration
   1. Use List upcoming events to preview upcoming events.
   2. Use Send event to simulate event delivery.
   3. View delivery attempts using View logs.
4. Enable your webhook
   1. Once verified, activate the endpoint using the Update a webhook endpoint.

Endpoint Requirements

When creating a webhook endpoint, you must provide:

• A url that uses the https:// scheme.
• A valid X.509 SSL certificate.
• Upon creation, Bridge will generate and assign a PKI public key (in PEM format) to your webhook. This is used to verify the authenticity of events delivered to your endpoint.

→ See Webhook Event Signature Verification for implementation details.

Event Delivery

• Events are delivered via POST requests with the application/json content type.
• Your endpoint must respond with a 200 OK status as quickly as possible.
• Failure to respond promptly will trigger automatic retries on Bridge’s side.

If Your Endpoint Is Down or Unavailable

If your endpoint is unavailable when Bridge attempts to deliver events, we will automatically retry for up to two days. After that period, retries stop and you’ll need to manually trigger redelivery:

• Use the Send Event endpoint to initiate immediate redelivery.
• Once the request succeeds, all outstanding events queued for that webhook endpoint will be resent automatically.

Webhook States

Each webhook endpoint has a status field that determines its current state.