Home Schema Example JSON Schema

Event Metadata

Type: object

Metadata for the event. Usually populated by the provider.

 No Additional Properties

root acuity

Acuity

Type: object

Event metadata for Acuity.

 No Additional Properties

root acuity scheduled_event

Scheduled Event

Type: object

The scheduled_event object from Acuity.

Additional Properties of any type are allowed.

root acuity scheduled_event additionalProperties
Type: object

root acuity webhook_payload

Webhook Payload

Type: object

The most recent webhook payload for this event.

Additional Properties of any type are allowed.

root acuity webhook_payload additionalProperties
Type: object

root calendly

Calendly

Type: object

Event metadata for Calendly. Calendly events are determined by scheduled_event/invitee combination.

 No Additional Properties

root calendly scheduled_event

Scheduled Event

Type: object

The scheduled_event object from Calendly.

Additional Properties of any type are allowed.

root calendly scheduled_event additionalProperties
Type: object

root calendly webhook_payload

Webhook Payload

Type: object

The most recent webhook payload for this event.

Additional Properties of any type are allowed.

root calendly webhook_payload additionalProperties
Type: object

root cleo

Cleo

Type: object

Event metadata for Cleo.

 No Additional Properties

root cleo webhook_payloads

Webhook Payloads

Type: array

The webhook payloads for this event.

 No Additional Items

root google_calendar

Google Calendar

Type: object

Event metadata for Google Calendar.

root google_calendar event_resource

Event Resource

Type: object

The event resource object returned from Google Calendar. See https://developers.google.com/calendar/api/v3/reference/events#resource

The following properties are required:

  • etag
  • id

Additional Properties of any type are allowed.

root google_calendar event_resource additionalProperties
Type: object

Additional Properties of any type are allowed.

root google_calendar additionalProperties
Type: object

root hummingbird

HummingBird

Type: object

Event metadata for HummingBird.

 No Additional Properties

root hummingbird scheduled_event

Scheduled Event

Type: object

The scheduled_event object from HummingBird.

Additional Properties of any type are allowed.

root hummingbird scheduled_event additionalProperties
Type: object

root hummingbird webhook_payloads

Webhook Payloads

Type: array

All webhook payloads received for this event.

 No Additional Items

root icalendar

Google Calendar

Type: object

Event metadata for iCalendar.

root icalendar ical_string

iCal String

Type: string

The event in iCal format.

Must be at least 1 characters long

root icalendar etag

ETag

Type: string

Hash digest of content to detect changes. We currently use SHA-256.

Must be at least 1 characters long

Additional Properties of any type are allowed.

root icalendar additionalProperties
Type: object

root mandaya

Mandaya

Type: object

Event metadata for Mandaya.

 No Additional Properties

root mandaya webhook_payloads

Webhook Payloads

Type: array

The webhook payloads for this event.

 No Additional Items

root additional_data

Additional Data

Type: array

Additional data that may be provided as part of the event payload stored here as key-value pairs.

Must contain a minimum of 1 items

No Additional Items

root qa_parser

QA Parser

Type: object

Data extracted by the QAParserMixin.

 No Additional Properties

root qa_parser extracted_data

Extracted Data

Type: object

Normalized data extracted by the QAParserMixin.

Additional Properties of any type are allowed.

root qa_parser extracted_data additionalProperties
Type: object

root qa_parser qa_pairs

QA Pairs

Type: array

QA Pairs generated by the provider.

 No Additional Items