Create Cal.com Function

Endpoint used to create a Cal.com integration function.

Request Example

curl --request POST \
  --url https://converflow.api.prod.toolzz.media/api/v1/calcom/integration \
  --header 'Authorization: Bearer TOKEN_HERE' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "string",
  "unitId": "uuid",
  "apiKey": "string",
  "calcomUsername": "string",
  "timezone": "string",
  "prompt": "string",
  "checkAvailabilityEnabled": boolean,
  "createBookingEnabled": boolean
}
'

Response Example

{
  "id": "uuid",
  "botId": null,
  "unitId": "uuid",
  "title": "string",
  "calcomUsername": "string",
  "apiKey": "string",
  "isActive": true,
  "isTokenMasked": true,
  "timezone": "string",
  "prompt": "string",
  "checkAvailabilityEnabled": true,
  "createBookingEnabled": true,
  "defaultEventTypeId": null,
  "defaultEventTypeSlug": null,
  "createdAt": "YYYY-MM-DD HH:mm:ss.SSSSSS",
  "updatedAt": "YYYY-MM-DD HH:mm:ss.SSS"
}

Request description

Access Token

Parameter	Type	Description	Required
Authorization	String	Access token (“Bearer” must be before the token)	Yes

Body Parameters

Key	Type	Description	Required
title	String	Integration identifier name in the panel (e.g., “Calcom”).	Yes
unitId	UUID	Unique identifier of the owning organizational unit.	Yes
apiKey	String	API key (Live Key) for secure authentication with Cal.com.	Yes
calcomUsername	String	Username or slug of the user on the Cal.com platform.	Yes
timezone	String	Default timezone for appointments (e.g., UTC, America/Sao_Paulo).	Yes
prompt	String	Function Instruction: Guides the AI on how and when to use the scheduler.	Yes
checkAvailabilityEnabled	Boolean	If true, the AI can check available times in the calendar.	Yes
createBookingEnabled	Boolean	If true, the AI is allowed to make meeting bookings.	Yes

---

Response description

Key	Type	Description	Required
id	UUID	Unique identifier of the integration in the database.	Yes
botId	Null/UUID	Toolzz AI Agent ID: Linked AI identifier (null if none).	No
unitId	UUID	Unique identifier of the owning organizational unit.	Yes
title	String	Integration identifier name (e.g., “Calcom”).	Yes
calcomUsername	String	Username/Slug on the Cal.com platform.	Yes
apiKey	String	Cal.com API key (masked for security).	Yes
isActive	Boolean	Defines if the integration is enabled for use.	Yes
isTokenMasked	Boolean	Indicates that the apiKey is hidden by asterisks in the response.	Yes
timezone	String	Configured default timezone (e.g., UTC).	Yes
prompt	String	Function Instruction: Behavioral guidelines for the AI.	Yes
checkAvailabilityEnabled	Boolean	If true, the AI can read the calendar availability.	Yes
createBookingEnabled	Boolean	If true, the AI can create new appointments/bookings.	Yes
defaultEventTypeId	Null/Number	Default event type ID for quick bookings.	No
defaultEventTypeSlug	Null/Str	Default event type slug (e.g., 30min).	No
createdAt	String	Record creation date and time (ISO 8601).	Yes
updatedAt	String	Date and time of the last data update.	Yes

---

Security

To access this endpoint, it is necessary to send a valid access token through the authorization header (Authorization) of the request. Additionally, the API is protected by other security measures to safeguard user data.

To access your access token, follow these steps:

1. Log in to the ToolzzAI platform
2. Click on “Settings”
3. Click on “Access Token”
4. Copy the access token