Skip to main content
Webhooks

Create a webhook endpoint

POST
/webhooks
Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
eventsstring[]required

Non-empty list of: message.received, job.completed, lead.created, customer.created. Each event needs the read scope of its data: message.received needs messages:read, job.completed needs jobs:read, lead.created needs leads:read, customer.created needs customers:read.

urlstringrequired

Public https URL without an IP literal host.

Example: https://example.com/rotor-hook

Response

application/json

The endpoint, with its signing secret (shown only once)

X-RateLimit-Limitintegerheader

The company's daily request limit.

X-RateLimit-Remainingintegerheader

Requests left in the current daily window.

X-RateLimit-Resetstringheader

When the daily window resets (UTC ISO timestamp).

X-RateLimit-Minute-Limitintegerheader

The company's per-minute request limit.

X-RateLimit-Minute-Remainingintegerheader

Requests left in the current minute.

X-RateLimit-Minute-Resetstringheader

When the minute window resets (UTC ISO timestamp).

created_atstringrequired
enabledbooleanrequired
eventsenum<string>[]required
idstringrequired
secretstringrequired

Signing secret. Shown only in this response; store it now.

Example: whsec_0123456789abcdef0123456789abcdef0123456789abcdef
urlstringrequired