Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Payload reference

The exact JSON body and HTTP headers dCal sends to a webhook for each event: booking.created (personal and team), booking.rescheduled, booking.cancelled, booking.confirmed and the ping test, with samp

Every webhook delivery is a POST with a small JSON body: the event name and a data object whose fields depend on the event. This page lists each event's body and the headers that travel with it. The values in the samples are made up.

No screenshots here: everything on this page happens on your server.


Headers

Header
Example
Meaning

content-type

application/json

The body is always JSON.

X-Slate-Event

booking.created

The event name, the same as event in the body.

X-Slate-Signature

sha256=5d2c…

sha256= followed by the lowercase hex HMAC-SHA256 of the raw body, made with the webhook's signing secret. See Verify the signature.

X-Slate-Delivery

(an ID)

The ID of this delivery. Every retry of the same event to your endpoint carries the same ID, so you can skip a delivery you already handled. The Ping test does not carry it.

Header names are case-insensitive; most frameworks give them to you in lowercase. The headers carry no timestamp.


The envelope

Every body has the same two keys:

{
  "event": "booking.created",
  "data": {}
}
Field
Type
Meaning

event

string

The event name: booking.created, booking.rescheduled, booking.cancelled, booking.confirmed or ping.

data

object

The fields of that event, listed below.

Every booking event carries the booking's uid. It stays the same for the whole life of the booking, so use it to link a booking.created to the events that follow.

Every booking event (booking.created, booking.rescheduled, booking.cancelled and booking.confirmed) also carries utm, the booking's campaign, when the booking has one. It has the same shape on every event; see the utm row under booking.created. When the booking has no campaign, the key is left out.


booking.created

Sent when a booking is made, whether it is confirmed or a request waiting for your OK.

Field
Type
Meaning

uid

string

The booking's ID.

status

string

accepted for a confirmed booking, pending for a request that waits for your OK. See Require confirmation.

startUtc

string

Start time, ISO 8601 in UTC.

endUtc

string

End time, ISO 8601 in UTC.

title

string

The event's name when the booking was made.

utm

object

Only when the booking came with campaign parameters: the utm_source, utm_medium, utm_campaign, utm_term and utm_content it was booked with, each one only when present. They come from the booking page's address or, on an embedded page, from the address of the page that frames it. Bookings you make from the dashboard, and those made with an API key or over MCP, carry none.

On a team event

A booking on a team event sends a shorter data: no endUtc and no title, and utm only when the booking came with campaign parameters. Team bookings are always confirmed.


booking.rescheduled

Sent when the guest moves the booking from the link in their email, or your system moves it with PATCH /v1/machine/bookings/{uid}. The uid does not change.

Field
Type
Meaning

uid

string

The booking's ID.

startUtc

string

The new start time, ISO 8601 in UTC.

endUtc

string

The new end time, ISO 8601 in UTC.

utm

object

Only when the booking has a campaign. The same shape as in booking.created.

Moved through the Cal.com-compatible API

A move made with POST /v2/bookings/{uid}/reschedule gives the booking a new uid. The message carries the new uid and the previous one, and no times: read them with GET /v2/bookings/{uid} if you need them. See Cal.com-compatible API.

Field
Type
Meaning

uid

string

The booking's new ID. Later events use this one.

rescheduledFromUid

string

The ID the booking had before the move.

utm

object

Only when the booking has a campaign, which it keeps across the move. The same shape as in booking.created.


booking.cancelled

Sent when the guest, a host or the API cancels a booking, and when a host declines a request.

Field
Type
Meaning

uid

string

The booking's ID.

reason

string or null

The reason the guest typed when cancelling, or the one your system sent through the API. An empty string "" when the guest cancels without typing one. null when no reason was sent, which is always the case for cancellations and declines made from the dCal dashboard.

utm

object

Only when the booking has a campaign. The same shape as in booking.created.


booking.confirmed

Sent when a host confirms a request. The Add webhook dialog does not offer this event, and API keys cannot create webhooks, so the webhooks you add in dCal do not receive it.

Field
Type
Meaning

uid

string

The booking's ID.

utm

object

Only when the booking has a campaign. The same shape as in booking.created.


ping

Sent only when you click Ping on a webhook's row. It is signed like a real delivery, so it is the easiest way to test your signature check.


What the payload does not carry

  • Guest details. There is no name, email, phone or answers in any event. To get them into your CRM without code, use HubSpot.

  • Who made the booking. The payload does not say whether the guest, a host, a Dapta agent or the API made it.

  • A timestamp. To skip repeats, use the X-Slate-Delivery header: it is the same on every retry of one delivery.

💡 Tip: Your endpoint receives the events of every booking in the workspace. Keep the uid of the booking.created events you care about and match the later events on it.

Last updated