Webhooks

Endpoints the platform notifies when data changes, and the record of every delivery.

📄️Send a test delivery

Sends a sample payload of the event type you name to the subscribed URL and returns exactly what your receiver answered, including the status and body. Use it to prove connectivity before relying on real traffic. This is a probe: it does not appear in the delivery history. Requires `webhook.update`.

📄️List a webhook's deliveries

Returns recent delivery attempts with their status, duration and response, newest first. This is where to look when a receiver says it never heard from us. Requires `webhook.read`.

📄️Create a webhook subscription

Subscribes a URL of yours to a set of platform events, so your systems learn about a change without polling. The URL is checked before it is stored: an address that resolves inside the platform's own network is refused, which is what stops a subscription being used to reach internal services. Requires `webhook.create`.

📄️List webhook subscriptions

Returns the tenant's subscriptions with their URL, events and state. Requires `webhook.read`.

📄️Get a webhook subscription

Returns one subscription — its endpoint, the events it listens for, and whether it is active. The signing secret is never returned. Returns 404 if it does not exist or belongs to another tenant. Requires `webhook.read`.

📄️Update a webhook subscription

Changes a subscription's URL, event set or active state. A new URL is re-checked before it is accepted. Requires `webhook.update`.

📄️Delete a webhook subscription

Soft-deletes a subscription; deliveries stop immediately. Requires `webhook.delete`.