API v2

Calendar Event Updated

Calendar Event Updated payload structure

Payload Structure

FieldTypeRequiredDescription
dataobjectYes
eventstringYesThe webhook event type

Field Details

  • data (object) Required

    Properties:

    • affected_instances (object[]) Required Array of event instances that were affected by the update. This includes the instance that was directly updated and any related instances

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

    • 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

    • is_exception (boolean) Required Whether the updated instance is an exception to a recurring series. True if this instance has been modified differently from the recurring pattern

    • series_bot_scheduled (boolean) Required Whether a bot has been scheduled for all occurrences of this series. True if a calendar bot schedule exists for the entire 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": {
    "affected_instances": [],
    "calendar_id": "examplecalendar_id",
    "event_type": "exampleevent_type",
    "is_exception": true,
    "series_bot_scheduled": true,
    "series_id": null
  },
  "event": "exampleevent"
}

On this page