Webhooks API reference

The endpoints for registering endpoints, subscriptions, secrets, deliveries, events and the event catalogue, in the generated API reference.

Every webhook endpoint is in the generated API reference, under Platform & integration: Webhooks, with its parameters, responses and a curl sample.

All paths are relative to https://api.bridgemoni.com. Every request carries Authorization, X-Tenant and X-Environment, and every response uses the standard envelope, { "data": …, "description": … }.

Acting for a business

organizationReference is an optional query parameter on every webhook endpoint. Leave it out and the endpoint acts for the caller; supply it and the caller must be the registered holder of that business. A business you have no authority over and one that doesn’t exist are both refused with a 403.

What’s there

Area Endpoints
Endpoints Register, list, read, update, delete, pause, resume, send a test
Subscriptions List, add one, replace all, remove one
Secrets List, rotate, retire one now
Deliveries List, read with every attempt, replay
Events Read one, replay to every endpoint
Catalogue List event types, read one

Errors carry a human-readable description and no machine-readable code. Branch on the HTTP status.