Skip to main content

Calendar Event Types

Tags: configuration, events, scheduling

Calendar event type definitions

Resources​

Request and response models used by the endpoints on this page.

CreateEventTypeRequest​

FieldTypeRequiredDescription
activeBooleanDefault: True
bufferAfterMinutesIntegerDefault: 0
bufferBeforeMinutesIntegerDefault: 0
colorString
defaultDurationMinutesInteger✓
descriptionString
eventRulesArray<EventRuleData> | null
maxAttendeesInteger
minAttendeesIntegerDefault: 1
nameString✓
slugString

Example:

{
"name": "string",
"defaultDurationMinutes": 1,
"bufferBeforeMinutes": 0,
"bufferAfterMinutes": 0,
"minAttendees": 1,
"active": true
}

EventRuleData​

FieldTypeRequiredDescription
actionParamsdict[str, Any]Parameters for the action
actionType<enum EventRuleActionType✓The action type to execute
activeBooleanWhether the rule is active (default: True)
conditionsStringCEL condition expression for conditional execution
delayIntegerDelay in seconds before executing the action (default: 0)
eventType<enum EventRuleEventType✓The event type that triggers this rule
nameStringDisplay name for the rule
objectTypeEventRuleObjectTypeThe object type this rule applies to (inferred from parent if not provided)
triggerParamsdict[str, Any]Parameters for the trigger (e.g., webhook config)
uuidString✓UUID for matching/creating event rules

Example:

{
"uuid": "string",
"eventType": null,
"actionType": null,
"active": true,
"delay": 0
}

EventTypeResponse​

FieldTypeRequiredDescription
activeBoolean✓
bufferAfterMinutesInteger✓
bufferBeforeMinutesInteger✓
colorString✓
createdAtDateTime✓
defaultDurationMinutesInteger✓
descriptionString✓
idInteger✓
maxAttendeesInteger✓
minAttendeesInteger✓
nameString✓
slugString✓
templateUuidString✓
updatedAtDateTime✓
uuidString✓

Example:

{
"id": 0,
"uuid": "string",
"templateUuid": "string",
"name": "string",
"slug": "string",
"description": "string",
"defaultDurationMinutes": 0,
"bufferBeforeMinutes": 0,
"bufferAfterMinutes": 0,
"minAttendees": 0,
"maxAttendees": 0,
"color": "string",
"active": false,
"createdAt": "2024-01-01T00:00:00Z",
"updatedAt": "2024-01-01T00:00:00Z"
}

PaginatedResponse[EventTypeResponse]​

FieldTypeRequiredDescription
itemsArray<EventTypeResponse>✓
pageInteger✓
pageSizeInteger✓
totalInteger✓
totalPagesInteger✓

Example:

{
"items": [],
"total": 0,
"page": 0,
"pageSize": 0,
"totalPages": 0
}

UpdateEventTypeRequest​

FieldTypeRequiredDescription
activeBoolean
bufferAfterMinutesInteger
bufferBeforeMinutesInteger
colorString
defaultDurationMinutesInteger
descriptionString
eventRulesArray<EventRuleData> | null
maxAttendeesInteger
minAttendeesInteger
nameString
slugString

Example:

{}

Endpoints​

List​

GET /api/v2/w/{workspace_uuid}/calendar-event-types

Description:

List all calendar event types.

Authorization: Requires calendars:read scope

Parameters:

  • page (Integer)
  • pageSize (Integer)
  • active_only (Boolean)

Response: See PaginatedResponse[EventTypeResponse]


Create​

POST /api/v2/w/{workspace_uuid}/calendar-event-types

Description:

Create a new calendar event type.

Authorization: Requires calendars:write scope

Parameters:

Response: See EventTypeResponse


Delete Event Type Id​

DELETE /api/v2/w/{workspace_uuid}/calendar-event-types/{event_type_id}

Description:

Delete a calendar event type.

Note: This will fail if there are existing events using this type. Consider deactivating instead by setting active=false.

Authorization: Requires calendars:admin scope

Parameters:

  • event_type_id (Integer)

Response: Object


Get Event Type Id​

GET /api/v2/w/{workspace_uuid}/calendar-event-types/{event_type_id}

Description:

Get a specific event type by ID.

Authorization: Requires calendars:read scope

Parameters:

  • event_type_id (Integer)

Response: See EventTypeResponse


Update Event Type Id​

PUT /api/v2/w/{workspace_uuid}/calendar-event-types/{event_type_id}

Description:

Update an existing calendar event type.

Authorization: Requires calendars:write scope

Parameters:

Response: See EventTypeResponse