API v2

Calendar Event Cancelled

Calendar Event Cancelled payload structure

Payload Structure

FieldTypeRequiredDescription
dataobjectYes
eventstringYesThe webhook event type

Field Details

  • data (object) Required

    Properties:

    • calendar_id (string (uuid)) Required The UUID of the calendar connection where the event was cancelled

    • cancelled_instances (object[]) Required Array of event instances that were cancelled. For one-off events, this contains a single instance. For recurring events, this contains all instances that were cancelled

    • event_type ("one_off" | "recurring") Required The type of event. 'one_off' for single events, 'recurring' for events that are part of a recurring series

    • series_id (string (uuid) | null) Required The UUID of the event series. Null only in rare cases where the series relationship could not be established

  • event (string) Required The webhook event type

Example

{
  "data": {
    "calendar_id": "examplecalendar_id",
    "cancelled_instances": [],
    "event_type": "exampleevent_type",
    "series_id": null
  },
  "event": "exampleevent"
}

On this page