Payloads

Schema definitions for the various payloads sent to webhooks.

Properties

Webhook request bodies includes the following properties:

Property

Type

Description

type

string

The type of payload.

id

string

A unique ID representing the specific payload.

version

string

A version identifier for the payload.

occurred_at

datetime

An ISO-8601 timestamp for when the event occurred.

payload

object

An object representing the relevant resource (e.g. an Event).

event.created

This payload is sent when someone schedules a new event via one of your scheduling links. The payload property contains the Event resource. Here's an example request body:

{
"type": "event.created",
"id": "payload_7RDQF0G5VT8PAV4ERN90B5Q27Y",
"version": "2020-11-18",
"occurred_at": "2020-11-20T19:53:47Z",
"payload": {
// See Event resource
}
}

event.rescheduled

This payload is sent when someone reschedules an existing event. The payload property contains the Event resource. Here's an example request body:

{
"type": "event.rescheduled",
"id": "payload_7RDQF0G5VT8PAV4ERN90B5Q27Y",
"version": "2020-11-18",
"occurred_at": "2020-11-20T19:53:47Z",
"payload": {
// See Event resource
}
}

event.canceled

This payload is sent when someone cancels an event. The payload property contains the Event resource. Here's an example request body:

{
"type": "event.canceled",
"id": "payload_7RDQF0G5VT8PAV4ERN90B5Q27Y",
"version": "2020-11-18",
"occurred_at": "2020-11-20T19:53:47Z",
"payload": {
// See Event resource
}
}