> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # cal-platform > Cal.com Platform - OAuth clients, API keys, webhooks, Stripe, and user profile **Server path:** `/cal-platform` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | | [`cal_platform_api_keys_controller_refresh`](#cal_platform_api_keys_controller_refresh) | Refresh API Key | | [`cal_platform_me_controller_get_me`](#cal_platform_me_controller_get_me) | Get my profile | | [`cal_platform_me_controller_update_me`](#cal_platform_me_controller_update_me) | Update my profile | | [`cal_platform_oauth_client_users_controller_create_user`](#cal_platform_oauth_client_users_controller_create_user) | Create a managed user | | [`cal_platform_oauth_client_users_controller_delete_user`](#cal_platform_oauth_client_users_controller_delete_user) | Delete a managed user | | [`cal_platform_oauth_client_users_controller_force_refresh`](#cal_platform_oauth_client_users_controller_force_refresh) | Force refresh tokens | | [`cal_platform_oauth_client_users_controller_get_managed_users`](#cal_platform_oauth_client_users_controller_get_managed_users) | Get all managed users | | [`cal_platform_oauth_client_users_controller_get_user_by_id`](#cal_platform_oauth_client_users_controller_get_user_by_id) | Get a managed user | | [`cal_platform_oauth_client_users_controller_update_user`](#cal_platform_oauth_client_users_controller_update_user) | Update a managed user | | [`cal_platform_oauth_client_webhooks_controller_create_oauth_client_webhook`](#cal_platform_oauth_client_webhooks_controller_create_oauth_client_webhook) | Create a webhook | | [`cal_platform_oauth_client_webhooks_controller_delete_all_oauth_client_webhooks`](#cal_platform_oauth_client_webhooks_controller_delete_all_oauth_client_webhooks) | Delete all webhooks | | [`cal_platform_oauth_client_webhooks_controller_delete_oauth_client_webhook`](#cal_platform_oauth_client_webhooks_controller_delete_oauth_client_webhook) | Delete a webhook | | [`cal_platform_oauth_client_webhooks_controller_get_oauth_client_webhook`](#cal_platform_oauth_client_webhooks_controller_get_oauth_client_webhook) | Get a webhook | | [`cal_platform_oauth_client_webhooks_controller_get_oauth_client_webhooks`](#cal_platform_oauth_client_webhooks_controller_get_oauth_client_webhooks) | Get all webhooks | | [`cal_platform_oauth_client_webhooks_controller_update_oauth_client_webhook`](#cal_platform_oauth_client_webhooks_controller_update_oauth_client_webhook) | Update a webhook | | [`cal_platform_oauth_clients_controller_create_oauth_client`](#cal_platform_oauth_clients_controller_create_oauth_client) | Create an OAuth client | | [`cal_platform_oauth_clients_controller_delete_oauth_client`](#cal_platform_oauth_clients_controller_delete_oauth_client) | Delete an OAuth client | | [`cal_platform_oauth_clients_controller_get_oauth_client_by_id`](#cal_platform_oauth_clients_controller_get_oauth_client_by_id) | Get an OAuth client | | [`cal_platform_oauth_clients_controller_get_oauth_clients`](#cal_platform_oauth_clients_controller_get_oauth_clients) | Get all OAuth clients | | [`cal_platform_oauth_clients_controller_update_oauth_client`](#cal_platform_oauth_clients_controller_update_oauth_client) | Update an OAuth client | | [`cal_platform_oauth_flow_controller_refresh_tokens`](#cal_platform_oauth_flow_controller_refresh_tokens) | Refresh managed user tokens | | [`cal_platform_stripe_controller_check`](#cal_platform_stripe_controller_check) | Check Stripe connection | | [`cal_platform_stripe_controller_redirect`](#cal_platform_stripe_controller_redirect) | Get Stripe connect URL | | [`cal_platform_stripe_controller_save`](#cal_platform_stripe_controller_save) | Save Stripe credentials | | [`cal_platform_webhooks_controller_create_webhook`](#cal_platform_webhooks_controller_create_webhook) | Create a webhook | | [`cal_platform_webhooks_controller_delete_webhook`](#cal_platform_webhooks_controller_delete_webhook) | Delete a webhook | | [`cal_platform_webhooks_controller_get_webhook`](#cal_platform_webhooks_controller_get_webhook) | Get a webhook | | [`cal_platform_webhooks_controller_get_webhooks`](#cal_platform_webhooks_controller_get_webhooks) | Get all webhooks | | [`cal_platform_webhooks_controller_update_webhook`](#cal_platform_webhooks_controller_update_webhook) | Update a webhook | *** ## cal\_platform\_api\_keys\_controller\_refresh Refresh API Key **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------- | | `apiKeyDaysValid` | number | No | — | For how many days is managed organization api key valid. Defaults to 30 days. | | `apiKeyNeverExpires` | boolean | No | — | If true, organization api key never expires. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "apiKeyDaysValid": { "type": "number", "description": "For how many days is managed organization api key valid. Defaults to 30 days." }, "apiKeyNeverExpires": { "type": "boolean", "description": "If true, organization api key never expires." } }, "required": [ "PCID" ] } ``` *** ## cal\_platform\_me\_controller\_get\_me Get my profile ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## cal\_platform\_me\_controller\_update\_me Update my profile **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | | `avatarUrl` | string | No | — | URL of the user's avatar image | | `bio` | string | No | — | The bio value | | `defaultScheduleId` | number | No | — | Default Schedule Id | | `email` | string | No | — | The email value | | `locale` | string | No | — | Locale or language code | | `metadata` | object | No | — | You can store any additional data you want here. Metadata must have at most 50 keys, each key up to 40 characters, and values up to 500 characters. | | `name` | string | No | — | The name value | | `timeFormat` | number | No | — | Must be 12 or 24 | | `timeZone` | string | No | — | Timezone identifier | | `weekStart` | string | No | — | Week Start | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "avatarUrl": { "type": "string", "description": "URL of the user's avatar image" }, "bio": { "type": "string", "description": "The bio value" }, "defaultScheduleId": { "type": "number", "description": "Default Schedule Id" }, "email": { "type": "string", "description": "The email value" }, "locale": { "type": "string", "description": "Locale or language code", "enum": [ "ar", "ca", "de", "es", "eu", "he", "id", "ja", "lv", "pl", "ro", "sr", "th", "vi", "az", "cs", "el", "es-419", "fi", "hr", "it", "km", "nl", "pt", "ru", "sv", "tr", "zh-CN", "bg", "da", "en", "et", "fr", "hu", "iw", "ko", "no", "pt-BR", "sk", "ta", "uk", "zh-TW", "bn" ] }, "metadata": { "type": "object", "description": "You can store any additional data you want here. Metadata must have at most 50 keys, each key up to 40 characters, and values up to 500 characters." }, "name": { "type": "string", "description": "The name value" }, "timeFormat": { "type": "number", "description": "Must be 12 or 24", "enum": [ 12, 24 ] }, "timeZone": { "type": "string", "description": "Timezone identifier" }, "weekStart": { "type": "string", "description": "Week Start", "enum": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ] } }, "required": [ "PCID" ] } ``` *** ## cal\_platform\_oauth\_client\_users\_controller\_create\_user Create a managed user **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `clientId` | string | Yes | — | Client Id | | `avatarUrl` | string | No | — | URL of the user's avatar image | | `bio` | string | No | — | The bio value | | `email` | string | Yes | — | The email value | | `locale` | string | No | — | Locale or language code | | `metadata` | object | No | — | You can store any additional data you want here. Metadata must have at most 50 keys, each key up to 40 characters, and values up to 500 characters. | | `name` | string | Yes | — | Managed user's name is used in emails | | `timeFormat` | number | No | — | Must be a number 12 or 24 | | `timeZone` | string | No | — | Timezone is used to create user's default schedule from Monday to Friday from 9AM to 5PM. If it is not passed then user does not have a default schedule and it must be created manually via the /schedules endpoint. Until the schedule is created, the user can't access availability atom to set his / her availability nor booked. It will default to Europe/London if not passed. | | `weekStart` | string | No | — | Week Start | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "clientId": { "type": "string", "description": "Client Id" }, "avatarUrl": { "type": "string", "description": "URL of the user's avatar image" }, "bio": { "type": "string", "description": "The bio value" }, "email": { "type": "string", "description": "The email value" }, "locale": { "type": "string", "description": "Locale or language code", "enum": [ "ar", "ca", "de", "es", "eu", "he", "id", "ja", "lv", "pl", "ro", "sr", "th", "vi", "az", "cs", "el", "es-419", "fi", "hr", "it", "km", "nl", "pt", "ru", "sv", "tr", "zh-CN", "bg", "da", "en", "et", "fr", "hu", "iw", "ko", "no", "pt-BR", "sk", "ta", "uk", "zh-TW", "bn" ] }, "metadata": { "type": "object", "description": "You can store any additional data you want here. Metadata must have at most 50 keys, each key up to 40 characters, and values up to 500 characters." }, "name": { "type": "string", "description": "Managed user's name is used in emails" }, "timeFormat": { "type": "number", "description": "Must be a number 12 or 24", "enum": [ 12, 24 ] }, "timeZone": { "type": "string", "description": "Timezone is used to create user's default schedule from Monday to Friday from 9AM to 5PM. If it is not passed then user does not have a default schedule and it must be created manually via the /schedules endpoint. Until the schedule is created, the user can't access availability atom to set his / her availability nor booked. It will default to Europe/London if not passed." }, "weekStart": { "type": "string", "description": "Week Start", "enum": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ] } }, "required": [ "PCID", "clientId", "email", "name" ] } ``` *** ## cal\_platform\_oauth\_client\_users\_controller\_delete\_user Delete a managed user **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ----------- | | `clientId` | string | Yes | — | Client Id | | `userId` | number | Yes | — | User Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "clientId": { "type": "string", "description": "Client Id" }, "userId": { "type": "number", "description": "User Id" } }, "required": [ "PCID", "clientId", "userId" ] } ``` *** ## cal\_platform\_oauth\_client\_users\_controller\_force\_refresh Force refresh tokens **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ----------- | | `userId` | number | Yes | — | User Id | | `clientId` | string | Yes | — | Client Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userId": { "type": "number", "description": "User Id" }, "clientId": { "type": "string", "description": "Client Id" } }, "required": [ "PCID", "userId", "clientId" ] } ``` *** ## cal\_platform\_oauth\_client\_users\_controller\_get\_managed\_users Get all managed users **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------- | | `clientId` | string | Yes | — | Client Id | | `limit` | number | No | — | The number of items to return | | `offset` | number | No | — | The number of items to skip | | `emails` | string\[] | No | — | Filter managed users by email. If you want to filter by multiple emails, separate them with a comma. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "clientId": { "type": "string", "description": "Client Id" }, "limit": { "type": "number", "description": "The number of items to return" }, "offset": { "type": "number", "description": "The number of items to skip" }, "emails": { "type": "array", "items": { "type": "string" }, "description": "Filter managed users by email. If you want to filter by multiple emails, separate them with a comma." } }, "required": [ "PCID", "clientId" ] } ``` *** ## cal\_platform\_oauth\_client\_users\_controller\_get\_user\_by\_id Get a managed user **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ----------- | | `clientId` | string | Yes | — | Client Id | | `userId` | number | Yes | — | User Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "clientId": { "type": "string", "description": "Client Id" }, "userId": { "type": "number", "description": "User Id" } }, "required": [ "PCID", "clientId", "userId" ] } ``` *** ## cal\_platform\_oauth\_client\_users\_controller\_update\_user Update a managed user **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | | `clientId` | string | Yes | — | Client Id | | `userId` | number | Yes | — | User Id | | `avatarUrl` | string | No | — | URL of the user's avatar image | | `bio` | string | No | — | The bio value | | `defaultScheduleId` | number | No | — | Default Schedule Id | | `email` | string | No | — | The email value | | `locale` | string | No | — | Locale or language code | | `metadata` | object | No | — | You can store any additional data you want here. Metadata must have at most 50 keys, each key up to 40 characters, and values up to 500 characters. | | `name` | string | No | — | The name value | | `timeFormat` | number | No | — | Must be 12 or 24 | | `timeZone` | string | No | — | Timezone identifier | | `weekStart` | string | No | — | Week Start | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "clientId": { "type": "string", "description": "Client Id" }, "userId": { "type": "number", "description": "User Id" }, "avatarUrl": { "type": "string", "description": "URL of the user's avatar image" }, "bio": { "type": "string", "description": "The bio value" }, "defaultScheduleId": { "type": "number", "description": "Default Schedule Id" }, "email": { "type": "string", "description": "The email value" }, "locale": { "type": "string", "description": "Locale or language code", "enum": [ "ar", "ca", "de", "es", "eu", "he", "id", "ja", "lv", "pl", "ro", "sr", "th", "vi", "az", "cs", "el", "es-419", "fi", "hr", "it", "km", "nl", "pt", "ru", "sv", "tr", "zh-CN", "bg", "da", "en", "et", "fr", "hu", "iw", "ko", "no", "pt-BR", "sk", "ta", "uk", "zh-TW", "bn" ] }, "metadata": { "type": "object", "description": "You can store any additional data you want here. Metadata must have at most 50 keys, each key up to 40 characters, and values up to 500 characters." }, "name": { "type": "string", "description": "The name value" }, "timeFormat": { "type": "number", "description": "Must be 12 or 24", "enum": [ 12, 24 ] }, "timeZone": { "type": "string", "description": "Timezone identifier" }, "weekStart": { "type": "string", "description": "Week Start", "enum": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ] } }, "required": [ "PCID", "clientId", "userId" ] } ``` *** ## cal\_platform\_oauth\_client\_webhooks\_controller\_create\_oauth\_client\_webhook Create a webhook **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `clientId` | string | Yes | — | Client Id | | `active` | boolean | Yes | — | The active value | | `payloadTemplate` | string | No | — | The template of the payload that will be sent to the subscriberUrl, check cal.com/docs/core-features/webhooks for more information | | `secret` | string | No | — | The secret value | | `subscriberUrl` | string | Yes | — | Subscriber Url | | `triggers` | string\[] | Yes | — | The triggers value | | `version` | string | No | — | The version of the webhook | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "clientId": { "type": "string", "description": "Client Id" }, "active": { "type": "boolean", "description": "The active value" }, "payloadTemplate": { "type": "string", "description": "The template of the payload that will be sent to the subscriberUrl, check cal.com/docs/core-features/webhooks for more information" }, "secret": { "type": "string", "description": "The secret value" }, "subscriberUrl": { "type": "string", "description": "Subscriber Url" }, "triggers": { "type": "array", "items": { "type": "string", "enum": [ "BOOKING_CREATED", "BOOKING_PAYMENT_INITIATED", "BOOKING_PAID", "BOOKING_RESCHEDULED", "BOOKING_REQUESTED", "BOOKING_CANCELLED", "BOOKING_REJECTED", "BOOKING_NO_SHOW_UPDATED", "FORM_SUBMITTED", "MEETING_ENDED", "MEETING_STARTED", "RECORDING_READY", "INSTANT_MEETING", "RECORDING_TRANSCRIPTION_GENERATED", "OOO_CREATED", "AFTER_HOSTS_CAL_VIDEO_NO_SHOW", "AFTER_GUESTS_CAL_VIDEO_NO_SHOW", "FORM_SUBMITTED_NO_EVENT", "ROUTING_FORM_FALLBACK_HIT", "DELEGATION_CREDENTIAL_ERROR", "WRONG_ASSIGNMENT_REPORT" ] }, "description": "The triggers value" }, "version": { "type": "string", "description": "The version of the webhook", "enum": [ "2021-10-20" ] } }, "required": [ "PCID", "clientId", "active", "subscriberUrl", "triggers" ] } ``` *** ## cal\_platform\_oauth\_client\_webhooks\_controller\_delete\_all\_oauth\_client\_webhooks Delete all webhooks **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ----------- | | `clientId` | string | Yes | — | Client Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "clientId": { "type": "string", "description": "Client Id" } }, "required": [ "PCID", "clientId" ] } ``` *** ## cal\_platform\_oauth\_client\_webhooks\_controller\_delete\_oauth\_client\_webhook Delete a webhook **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ----------- | | `webhookId` | string | Yes | — | Webhook Id | | `clientId` | string | Yes | — | Client Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "webhookId": { "type": "string", "description": "Webhook Id" }, "clientId": { "type": "string", "description": "Client Id" } }, "required": [ "PCID", "webhookId", "clientId" ] } ``` *** ## cal\_platform\_oauth\_client\_webhooks\_controller\_get\_oauth\_client\_webhook Get a webhook **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ----------- | | `webhookId` | string | Yes | — | Webhook Id | | `clientId` | string | Yes | — | Client Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "webhookId": { "type": "string", "description": "Webhook Id" }, "clientId": { "type": "string", "description": "Client Id" } }, "required": [ "PCID", "webhookId", "clientId" ] } ``` *** ## cal\_platform\_oauth\_client\_webhooks\_controller\_get\_oauth\_client\_webhooks Get all webhooks **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | --------------------------------- | | `clientId` | string | Yes | — | Client Id | | `take` | number | No | — | Maximum number of items to return | | `skip` | number | No | — | Number of items to skip | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "clientId": { "type": "string", "description": "Client Id" }, "take": { "type": "number", "description": "Maximum number of items to return" }, "skip": { "type": "number", "description": "Number of items to skip" } }, "required": [ "PCID", "clientId" ] } ``` *** ## cal\_platform\_oauth\_client\_webhooks\_controller\_update\_oauth\_client\_webhook Update a webhook **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `webhookId` | string | Yes | — | Webhook Id | | `clientId` | string | Yes | — | Client Id | | `active` | boolean | No | — | The active value | | `payloadTemplate` | string | No | — | The template of the payload that will be sent to the subscriberUrl, check cal.com/docs/core-features/webhooks for more information | | `secret` | string | No | — | The secret value | | `subscriberUrl` | string | No | — | Subscriber Url | | `triggers` | string\[] | No | — | The triggers value | | `version` | string | No | — | The version of the webhook | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "webhookId": { "type": "string", "description": "Webhook Id" }, "clientId": { "type": "string", "description": "Client Id" }, "active": { "type": "boolean", "description": "The active value" }, "payloadTemplate": { "type": "string", "description": "The template of the payload that will be sent to the subscriberUrl, check cal.com/docs/core-features/webhooks for more information" }, "secret": { "type": "string", "description": "The secret value" }, "subscriberUrl": { "type": "string", "description": "Subscriber Url" }, "triggers": { "type": "array", "items": { "type": "string", "enum": [ "BOOKING_CREATED", "BOOKING_PAYMENT_INITIATED", "BOOKING_PAID", "BOOKING_RESCHEDULED", "BOOKING_REQUESTED", "BOOKING_CANCELLED", "BOOKING_REJECTED", "BOOKING_NO_SHOW_UPDATED", "FORM_SUBMITTED", "MEETING_ENDED", "MEETING_STARTED", "RECORDING_READY", "INSTANT_MEETING", "RECORDING_TRANSCRIPTION_GENERATED", "OOO_CREATED", "AFTER_HOSTS_CAL_VIDEO_NO_SHOW", "AFTER_GUESTS_CAL_VIDEO_NO_SHOW", "FORM_SUBMITTED_NO_EVENT", "ROUTING_FORM_FALLBACK_HIT", "DELEGATION_CREDENTIAL_ERROR", "WRONG_ASSIGNMENT_REPORT" ] }, "description": "The triggers value" }, "version": { "type": "string", "description": "The version of the webhook", "enum": [ "2021-10-20" ] } }, "required": [ "PCID", "webhookId", "clientId" ] } ``` *** ## cal\_platform\_oauth\_clients\_controller\_create\_oauth\_client Create an OAuth client **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------------ | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `areCalendarEventsEnabled` | boolean | No | — | If true and if managed user has calendar connected, calendar events will be created. Disable it if you manually create calendar events. Default to true. | | `areDefaultEventTypesEnabled` | boolean | No | — | If true, when creating a managed user the managed user will have 4 default event types: 30 and 60 minutes without Cal video, 30 and 60 minutes with Cal video. Set this as false if you want to create a managed user and then manually create event types for the user. | | `areEmailsEnabled` | boolean | No | — | Are Emails Enabled | | `bookingCancelRedirectUri` | string | No | — | Booking Cancel Redirect Uri | | `bookingRedirectUri` | string | No | — | Booking Redirect Uri | | `bookingRescheduleRedirectUri` | string | No | — | Booking Reschedule Redirect Uri | | `logo` | string | No | — | The logo value | | `name` | string | Yes | — | The name value | | `permissions` | string\[] | Yes | — | Array of permission keys like \["BOOKING\_READ", "BOOKING\_WRITE"]. Use \["\*"] to grant all permissions. | | `redirectUris` | string\[] | Yes | — | Redirect Uris | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "areCalendarEventsEnabled": { "type": "boolean", "description": "If true and if managed user has calendar connected, calendar events will be created. Disable it if you manually create calendar events. Default to true." }, "areDefaultEventTypesEnabled": { "type": "boolean", "description": "If true, when creating a managed user the managed user will have 4 default event types: 30 and 60 minutes without Cal video, 30 and 60 minutes with Cal video. Set this as false if you want to create a managed user and then manually create event types for the user." }, "areEmailsEnabled": { "type": "boolean", "description": "Are Emails Enabled" }, "bookingCancelRedirectUri": { "type": "string", "description": "Booking Cancel Redirect Uri" }, "bookingRedirectUri": { "type": "string", "description": "Booking Redirect Uri" }, "bookingRescheduleRedirectUri": { "type": "string", "description": "Booking Reschedule Redirect Uri" }, "logo": { "type": "string", "description": "The logo value" }, "name": { "type": "string", "description": "The name value" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "EVENT_TYPE_READ", "EVENT_TYPE_WRITE", "BOOKING_READ", "BOOKING_WRITE", "SCHEDULE_READ", "SCHEDULE_WRITE", "APPS_READ", "APPS_WRITE", "PROFILE_READ", "PROFILE_WRITE", "*" ] }, "description": "Array of permission keys like [\"BOOKING_READ\", \"BOOKING_WRITE\"]. Use [\"*\"] to grant all permissions." }, "redirectUris": { "type": "array", "items": { "type": "string" }, "description": "Redirect Uris" } }, "required": [ "PCID", "name", "permissions", "redirectUris" ] } ``` *** ## cal\_platform\_oauth\_clients\_controller\_delete\_oauth\_client Delete an OAuth client **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ----------- | | `clientId` | string | Yes | — | Client Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "clientId": { "type": "string", "description": "Client Id" } }, "required": [ "PCID", "clientId" ] } ``` *** ## cal\_platform\_oauth\_clients\_controller\_get\_oauth\_client\_by\_id Get an OAuth client **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ----------- | | `clientId` | string | Yes | — | Client Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "clientId": { "type": "string", "description": "Client Id" } }, "required": [ "PCID", "clientId" ] } ``` *** ## cal\_platform\_oauth\_clients\_controller\_get\_oauth\_clients Get all OAuth clients ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## cal\_platform\_oauth\_clients\_controller\_update\_oauth\_client Update an OAuth client **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------------ | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `clientId` | string | Yes | — | Client Id | | `areCalendarEventsEnabled` | boolean | No | — | If true and if managed user has calendar connected, calendar events will be created. Disable it if you manually create calendar events. Default to true. | | `areDefaultEventTypesEnabled` | boolean | No | — | If true, when creating a managed user the managed user will have 4 default event types: 30 and 60 minutes without Cal video, 30 and 60 minutes with Cal video. Set this as false if you want to create a managed user and then manually create event types for the user. | | `areEmailsEnabled` | boolean | No | — | Are Emails Enabled | | `bookingCancelRedirectUri` | string | No | — | Booking Cancel Redirect Uri | | `bookingRedirectUri` | string | No | — | Booking Redirect Uri | | `bookingRescheduleRedirectUri` | string | No | — | Booking Reschedule Redirect Uri | | `logo` | string | No | — | The logo value | | `name` | string | No | — | The name value | | `redirectUris` | string\[] | No | — | Redirect Uris | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "clientId": { "type": "string", "description": "Client Id" }, "areCalendarEventsEnabled": { "type": "boolean", "description": "If true and if managed user has calendar connected, calendar events will be created. Disable it if you manually create calendar events. Default to true." }, "areDefaultEventTypesEnabled": { "type": "boolean", "description": "If true, when creating a managed user the managed user will have 4 default event types: 30 and 60 minutes without Cal video, 30 and 60 minutes with Cal video. Set this as false if you want to create a managed user and then manually create event types for the user." }, "areEmailsEnabled": { "type": "boolean", "description": "Are Emails Enabled" }, "bookingCancelRedirectUri": { "type": "string", "description": "Booking Cancel Redirect Uri" }, "bookingRedirectUri": { "type": "string", "description": "Booking Redirect Uri" }, "bookingRescheduleRedirectUri": { "type": "string", "description": "Booking Reschedule Redirect Uri" }, "logo": { "type": "string", "description": "The logo value" }, "name": { "type": "string", "description": "The name value" }, "redirectUris": { "type": "array", "items": { "type": "string" }, "description": "Redirect Uris" } }, "required": [ "PCID", "clientId" ] } ``` *** ## cal\_platform\_oauth\_flow\_controller\_refresh\_tokens Refresh managed user tokens **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | ----------------------------- | | `clientId` | string | Yes | — | Client Id | | `refreshToken` | string | Yes | — | Managed user's refresh token. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "clientId": { "type": "string", "description": "Client Id" }, "refreshToken": { "type": "string", "description": "Managed user's refresh token." } }, "required": [ "PCID", "clientId", "refreshToken" ] } ``` *** ## cal\_platform\_stripe\_controller\_check Check Stripe connection ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## cal\_platform\_stripe\_controller\_redirect Get Stripe connect URL ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## cal\_platform\_stripe\_controller\_save Save Stripe credentials **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | --------------- | | `state` | string | Yes | — | The state value | | `code` | string | Yes | — | The code value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "state": { "type": "string", "description": "The state value" }, "code": { "type": "string", "description": "The code value" } }, "required": [ "PCID", "state", "code" ] } ``` *** ## cal\_platform\_webhooks\_controller\_create\_webhook Create a webhook **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `active` | boolean | Yes | — | The active value | | `payloadTemplate` | string | No | — | The template of the payload that will be sent to the subscriberUrl, check cal.com/docs/core-features/webhooks for more information | | `secret` | string | No | — | The secret value | | `subscriberUrl` | string | Yes | — | Subscriber Url | | `triggers` | string\[] | Yes | — | The triggers value | | `version` | string | No | — | The version of the webhook | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "active": { "type": "boolean", "description": "The active value" }, "payloadTemplate": { "type": "string", "description": "The template of the payload that will be sent to the subscriberUrl, check cal.com/docs/core-features/webhooks for more information" }, "secret": { "type": "string", "description": "The secret value" }, "subscriberUrl": { "type": "string", "description": "Subscriber Url" }, "triggers": { "type": "array", "items": { "type": "string", "enum": [ "BOOKING_CREATED", "BOOKING_PAYMENT_INITIATED", "BOOKING_PAID", "BOOKING_RESCHEDULED", "BOOKING_REQUESTED", "BOOKING_CANCELLED", "BOOKING_REJECTED", "BOOKING_NO_SHOW_UPDATED", "FORM_SUBMITTED", "MEETING_ENDED", "MEETING_STARTED", "RECORDING_READY", "INSTANT_MEETING", "RECORDING_TRANSCRIPTION_GENERATED", "OOO_CREATED", "AFTER_HOSTS_CAL_VIDEO_NO_SHOW", "AFTER_GUESTS_CAL_VIDEO_NO_SHOW", "FORM_SUBMITTED_NO_EVENT", "ROUTING_FORM_FALLBACK_HIT", "DELEGATION_CREDENTIAL_ERROR", "WRONG_ASSIGNMENT_REPORT" ] }, "description": "The triggers value" }, "version": { "type": "string", "description": "The version of the webhook", "enum": [ "2021-10-20" ] } }, "required": [ "PCID", "active", "subscriberUrl", "triggers" ] } ``` *** ## cal\_platform\_webhooks\_controller\_delete\_webhook Delete a webhook **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ----------- | | `webhookId` | string | Yes | — | Webhook Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "webhookId": { "type": "string", "description": "Webhook Id" } }, "required": [ "PCID", "webhookId" ] } ``` *** ## cal\_platform\_webhooks\_controller\_get\_webhook Get a webhook **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ----------- | | `webhookId` | string | Yes | — | Webhook Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "webhookId": { "type": "string", "description": "Webhook Id" } }, "required": [ "PCID", "webhookId" ] } ``` *** ## cal\_platform\_webhooks\_controller\_get\_webhooks Get all webhooks **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | --------------------------------- | | `take` | number | No | — | Maximum number of items to return | | `skip` | number | No | — | Number of items to skip | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "take": { "type": "number", "description": "Maximum number of items to return" }, "skip": { "type": "number", "description": "Number of items to skip" } }, "required": [ "PCID" ] } ``` *** ## cal\_platform\_webhooks\_controller\_update\_webhook Update a webhook **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `webhookId` | string | Yes | — | Webhook Id | | `active` | boolean | No | — | The active value | | `payloadTemplate` | string | No | — | The template of the payload that will be sent to the subscriberUrl, check cal.com/docs/core-features/webhooks for more information | | `secret` | string | No | — | The secret value | | `subscriberUrl` | string | No | — | Subscriber Url | | `triggers` | string\[] | No | — | The triggers value | | `version` | string | No | — | The version of the webhook | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "webhookId": { "type": "string", "description": "Webhook Id" }, "active": { "type": "boolean", "description": "The active value" }, "payloadTemplate": { "type": "string", "description": "The template of the payload that will be sent to the subscriberUrl, check cal.com/docs/core-features/webhooks for more information" }, "secret": { "type": "string", "description": "The secret value" }, "subscriberUrl": { "type": "string", "description": "Subscriber Url" }, "triggers": { "type": "array", "items": { "type": "string", "enum": [ "BOOKING_CREATED", "BOOKING_PAYMENT_INITIATED", "BOOKING_PAID", "BOOKING_RESCHEDULED", "BOOKING_REQUESTED", "BOOKING_CANCELLED", "BOOKING_REJECTED", "BOOKING_NO_SHOW_UPDATED", "FORM_SUBMITTED", "MEETING_ENDED", "MEETING_STARTED", "RECORDING_READY", "INSTANT_MEETING", "RECORDING_TRANSCRIPTION_GENERATED", "OOO_CREATED", "AFTER_HOSTS_CAL_VIDEO_NO_SHOW", "AFTER_GUESTS_CAL_VIDEO_NO_SHOW", "FORM_SUBMITTED_NO_EVENT", "ROUTING_FORM_FALLBACK_HIT", "DELEGATION_CREDENTIAL_ERROR", "WRONG_ASSIGNMENT_REPORT" ] }, "description": "The triggers value" }, "version": { "type": "string", "description": "The version of the webhook", "enum": [ "2021-10-20" ] } }, "required": [ "PCID", "webhookId" ] } ```