Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Input for connecting a calendar account.

provider
enum<string>
required

Who holds the calendar. CAL_COM is the only provider that can be connected today; GOOGLE and CALENDLY are described by capabilities but not yet connectable.

Available options:
CAL_COM,
GOOGLE,
CALENDLY
label
string
required

Customer-facing name for this account, unique within the project. Required.

Required string length: 1 - 120
apiKey
string
required

For CAL_COM: a Cal.com API key (starts with cal_). It is verified against Cal.com before anything is stored, so an invalid key is a 400 and no connection is created. Stored encrypted and never returned.

Minimum string length: 1
timezone
string | null

The named IANA timezone to offer slots in, for example America/Los_Angeles. Omit to adopt the provider account’s own timezone. A fixed offset such as -08:00 is rejected: it does not observe DST.

Minimum string length: 1

Response

The connected calendar.

data
CalendarConnection · object
required

A project’s credential for one calendar account, the thing a calendar tool books against. The credential itself is never returned.