Skip to main content
Webhooks let your application react to Cal ID activity in real time. You register a subscriber URL and choose which events to receive; Cal ID then sends an HTTP POST with a JSON payload each time one of those events occurs.

Subscribe to events

Create a subscription with the Create a webhook endpoint:
string
required
The URL that receives the webhook POST requests.
string[]
required
The events to subscribe to — one or more of the triggers below.
string
Optional shared secret used to sign each payload so you can verify it’s genuinely from Cal ID.
string
Optional custom template for the payload delivered to your subscriber URL.
You can manage subscriptions with the List, Get, Update, and Delete webhook endpoints, or from the Cal ID dashboard.

Event triggers

Payload

Each delivery is a JSON body containing the trigger, a timestamp, and the event payload:
The exact fields in payload vary by event. If you set a payloadTemplate when creating the webhook, Cal ID delivers that template instead.

Verify deliveries

If you set a secret, use it to confirm each incoming request is authentic and hasn’t been tampered with before you act on it. Reject any request whose signature doesn’t match. Respond with a 2xx status quickly — do the heavy work asynchronously so deliveries aren’t retried unnecessarily.

Webhooks in the dashboard

Prefer a no-code setup? Create and manage webhooks from Settings → Webhooks in Cal ID.