Browse the API reference

Object

AssistantCalendar

View as Markdown

Fields

  • idstringrequired
  • assistant_idstringrequired
  • handlestringrequirednullable

    How the prompt names this calendar, as @handle: the provider, then the connected account (e.g. google_calendar_aric_at_getrevox.com). Null until an account is connected, unique within the assistant, kept when it is disconnected.

    max length 255

  • providerenum (string)required

    One ofgoogle-calendarcalendlycal-com-oauth

  • statusenum (string)required

    One ofnot_connectedneeds_setupready

  • connectionone ofrequirednullable

    The connected account, on the calendar's provider. Null until one is connected.

    Show 3 variants
    1. One ofprovider: "google-calendar"object

      • providerstring (constant)required

        Always "google-calendar"

      • connection_idstringrequired
      • settingsobjectrequirednullable
        Show 7 fields
        • calendar_idstringrequired

          The Google calendar to book on. (eg: primary)

        • time_zonestringrequired

          The timezone of the opening hours. (eg: Europe/Paris)

        • duration_minutesintegerrequired

          min 5 · max 480Default 30

        • daysarray of integerrequired

          The open days, 0 is Sunday.

          Default [1,2,3,4,5]

        • start_timestringrequired

          pattern ^\d{2}:\d{2}$Default "09:00"

        • end_timestringrequired

          pattern ^\d{2}:\d{2}$Default "18:00"

        • google_meetbooleanrequired

          Adds a Google Meet link to the meeting.

          Default true

    2. One ofprovider: "calendly"object

      • providerstring (constant)required

        Always "calendly"

      • connection_idstringrequired
      • settingsobjectrequirednullable
        Show 1 field
        • event_type_idstringrequired

          The Calendly event type to schedule. (eg: https://api.calendly.com/event_types/b2330295-2a91-4a1d-bb73-99e7707663d5)

          min length 1

    3. One ofprovider: "cal-com-oauth"object

      • providerstring (constant)required

        Always "cal-com-oauth"

      • connection_idstringrequired
      • settingsobjectrequirednullable
        Show 1 field
        • event_type_idstringrequired

          The Cal.com event type to schedule. (eg: 7081322)

          min length 1

  • account_labelstringrequirednullable

    The connected account, usually its email. Null when not connected, or when the provider did not say.

  • connected_via_invitebooleanrequired

    True when the account was connected by a colleague from the invite link.

  • inviteobjectrequirednullable
    Show 4 fields
    • urlstringrequirednullable

      Page where a colleague without a Revox account connects their own calendar to this one. Anyone holding the link can, until it expires. Only given by the calendar endpoints, null on a calendar listed in an assistant.

    • statusenum (string)required

      One ofpendingcompletedexpired

    • created_atanyrequired
    • expires_atanyrequired
  • created_atanyrequired