Webhooks API.

API Reference · Reference
01

List webhooks

GET /v1/webhooks: Returns all registered webhooks for your workspace, including URL, subscribed events, status (active/failed), and last delivery timestamp.

02

Create a webhook

POST /v1/webhooks: body requires { "url": "https://yourapp.com/webhook", "events": ["deal.created", "deal.stage_changed"], "secret": "optional_signing_secret" }. If you provide a secret, every payload will include an X-Baseerat-Signature header (HMAC-SHA256).

03

Update a webhook

PATCH /v1/webhooks/:id: Update the URL, events list, or secret. Active webhooks continue delivery with no interruption during the update.

04

Delete a webhook

DELETE /v1/webhooks/:id: Immediately stops delivery. In-flight deliveries already in the retry queue will be cancelled.

05

Replay a delivery

POST /v1/webhooks/:id/deliveries/:delivery_id/replay: Re-sends a specific past delivery to your endpoint. Useful for recovering from temporary downtime on your side.