commonscomputer/cal.diy
5
0 Fork 0
Code Issues Pull Requests Actions 2.1k Packages Projects Releases Wiki Activity

fix: correct webhook triggers OpenAPI type from string to array (#28288)

Browse Source 
* fix(api): correct webhook triggers OpenAPI type from string to array

* chore: update .github/oasdiff-err-ignore.txt to allow schema change
This commit is contained in:
Romit authored and GitHub committed 2026-03-05 19:34:03 +05:30
1 parent e2add3f2c9
commit 658e65be4d
4 files changed
+654 -80
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api-reference/v2/openapi.json
+416 -79
View File
@@ -10234,6 +10234,64 @@
"tags": ["Bookings"]
}
},
"/v2/bookings/{bookingUid}/attendees": {
"post": {
"operationId": "BookingAttendeesController_2024_08_13_addAttendee",
"summary": "Add an attendee to a booking",
"description": "Add a new attendee to an existing booking by its UID.\n\n **Side effects:**\n - The booking's attendee list is updated in the database\n - The calendar event is updated on connected calendars (Google Calendar, Outlook, etc.) to include the new attendee\n - An email notification is sent to the new attendee with the booking details\n\n **Permissions:**\n - The authenticated user must be either the booking organizer, an existing attendee, or have the `booking.update` permission for the team\n\n <Note>The cal-api-version header is required for this endpoint. Without it, the request will fail with a 404 error.</Note>\n ",
"parameters": [
{
"name": "cal-api-version",
"in": "header",
"description": "Must be set to 2024-08-13. This header is required as this endpoint does not exist in older API versions.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "bookingUid",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
},
{
"name": "Authorization",
"in": "header",
"description": "value must be `Bearer <token>` where `<token>` is api key prefixed with cal_ or managed user access token",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddAttendeeInput_2024_08_13"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddAttendeeOutput_2024_08_13"
}
}
}
}
},
"tags": ["Bookings / Attendees"]
}
},
"/v2/bookings/{bookingUid}/guests": {
"post": {
"operationId": "BookingGuestsController_2024_08_13_addGuests",
@@ -24232,18 +24290,41 @@
"description": "The template of the payload that will be sent to the subscriberUrl, check cal.com/docs/core-features/webhooks for more information",
"example": "{\"content\":\"A new event has been scheduled\",\"type\":\"{{type}}\",\"name\":\"{{title}}\",\"organizer\":\"{{organizer.name}}\",\"booker\":\"{{attendees.0.name}}\"}"
},
"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"
]
}
},
"teamId": {
"type": "number"
},
"id": {
"type": "number"
},
"triggers": {
"type": "array",
"items": {
"type": "object"
}
},
"subscriberUrl": {
"type": "string"
},
@@ -24254,7 +24335,7 @@
"type": "string"
}
},
"required": ["payloadTemplate", "teamId", "id", "triggers", "subscriberUrl", "active"]
"required": ["payloadTemplate", "triggers", "teamId", "id", "subscriberUrl", "active"]
},
"TeamWebhooksOutputResponseDto": {
"type": "object",
@@ -24288,7 +24369,7 @@
"type": "string"
},
"triggers": {
"type": "string",
"type": "array",
"example": [
"BOOKING_CREATED",
"BOOKING_RESCHEDULED",
@@ -24299,28 +24380,32 @@
"BOOKING_NO_SHOW",
"BOOKING_REOPENED"
],
"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",
"DELEGATION_CREDENTIAL_ERROR",
"WRONG_ASSIGNMENT_REPORT"
]
"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"
]
}
},
"secret": {
"type": "string"
@@ -24363,7 +24448,7 @@
"type": "string"
},
"triggers": {
"type": "string",
"type": "array",
"example": [
"BOOKING_CREATED",
"BOOKING_RESCHEDULED",
@@ -24374,28 +24459,32 @@
"BOOKING_NO_SHOW",
"BOOKING_REOPENED"
],
"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",
"DELEGATION_CREDENTIAL_ERROR",
"WRONG_ASSIGNMENT_REPORT"
]
"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"
]
}
},
"secret": {
"type": "string"
@@ -29303,11 +29392,6 @@
"description": "The name of the attendee.",
"example": "John Doe"
},
"email": {
"type": "string",
"description": "The email of the attendee.",
"example": "john.doe@example.com"
},
"timeZone": {
"type": "string",
"description": "The time zone of the attendee.",
@@ -29368,6 +29452,11 @@
"description": "The preferred language of the attendee. Used for booking confirmation.",
"example": "it",
"default": "en"
},
"email": {
"type": "string",
"description": "The email of the attendee.",
"example": "john.doe@example.com"
}
},
"required": ["name", "timeZone"]
@@ -31491,6 +31580,185 @@
},
"required": ["status", "data"]
},
"AddAttendeeInput_2024_08_13": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the attendee.",
"example": "John Doe"
},
"timeZone": {
"type": "string",
"description": "The time zone of the attendee.",
"example": "America/New_York"
},
"phoneNumber": {
"type": "string",
"description": "The phone number of the attendee in international format.",
"example": "+919876543210"
},
"language": {
"type": "string",
"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"
],
"description": "The preferred language of the attendee. Used for booking confirmation.",
"example": "it",
"default": "en"
},
"email": {
"type": "string",
"description": "The email of the attendee.",
"example": "john.doe@example.com"
}
},
"required": ["name", "timeZone", "email"]
},
"BookingAttendeeOutput_2024_08_13": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "John Doe"
},
"email": {
"type": "string",
"example": "john@example.com"
},
"displayEmail": {
"type": "string",
"example": "john@example.com",
"description": "Clean email for display purposes"
},
"timeZone": {
"type": "string",
"example": "America/New_York"
},
"language": {
"type": "string",
"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"
],
"example": "en"
},
"absent": {
"type": "boolean",
"example": false
},
"phoneNumber": {
"type": "string",
"example": "+1234567890"
},
"id": {
"type": "number",
"example": 251
},
"bookingId": {
"type": "number",
"example": 313
}
},
"required": ["name", "email", "displayEmail", "timeZone", "absent", "id", "bookingId"]
},
"AddAttendeeOutput_2024_08_13": {
"type": "object",
"properties": {
"status": {
"type": "string",
"example": "success",
"enum": ["success", "error"]
},
"data": {
"$ref": "#/components/schemas/BookingAttendeeOutput_2024_08_13"
}
},
"required": ["status", "data"]
},
"Guest": {
"type": "object",
"properties": {
@@ -31905,18 +32173,41 @@
"description": "The template of the payload that will be sent to the subscriberUrl, check cal.com/docs/core-features/webhooks for more information",
"example": "{\"content\":\"A new event has been scheduled\",\"type\":\"{{type}}\",\"name\":\"{{title}}\",\"organizer\":\"{{organizer.name}}\",\"booker\":\"{{attendees.0.name}}\"}"
},
"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"
]
}
},
"userId": {
"type": "number"
},
"id": {
"type": "number"
},
"triggers": {
"type": "array",
"items": {
"type": "object"
}
},
"subscriberUrl": {
"type": "string"
},
@@ -31927,7 +32218,7 @@
"type": "string"
}
},
"required": ["payloadTemplate", "userId", "id", "triggers", "subscriberUrl", "active"]
"required": ["payloadTemplate", "triggers", "userId", "id", "subscriberUrl", "active"]
},
"UserWebhookOutputResponseDto": {
"type": "object",
@@ -31968,18 +32259,41 @@
"description": "The template of the payload that will be sent to the subscriberUrl, check cal.com/docs/core-features/webhooks for more information",
"example": "{\"content\":\"A new event has been scheduled\",\"type\":\"{{type}}\",\"name\":\"{{title}}\",\"organizer\":\"{{organizer.name}}\",\"booker\":\"{{attendees.0.name}}\"}"
},
"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"
]
}
},
"eventTypeId": {
"type": "number"
},
"id": {
"type": "number"
},
"triggers": {
"type": "array",
"items": {
"type": "object"
}
},
"subscriberUrl": {
"type": "string"
},
@@ -31990,7 +32304,7 @@
"type": "string"
}
},
"required": ["payloadTemplate", "eventTypeId", "id", "triggers", "subscriberUrl", "active"]
"required": ["payloadTemplate", "triggers", "eventTypeId", "id", "subscriberUrl", "active"]
},
"EventTypeWebhookOutputResponseDto": {
"type": "object",
@@ -32045,18 +32359,41 @@
"description": "The template of the payload that will be sent to the subscriberUrl, check cal.com/docs/core-features/webhooks for more information",
"example": "{\"content\":\"A new event has been scheduled\",\"type\":\"{{type}}\",\"name\":\"{{title}}\",\"organizer\":\"{{organizer.name}}\",\"booker\":\"{{attendees.0.name}}\"}"
},
"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"
]
}
},
"oAuthClientId": {
"type": "string"
},
"id": {
"type": "number"
},
"triggers": {
"type": "array",
"items": {
"type": "object"
}
},
"subscriberUrl": {
"type": "string"
},
@@ -32067,7 +32404,7 @@
"type": "string"
}
},
"required": ["payloadTemplate", "oAuthClientId", "id", "triggers", "subscriberUrl", "active"]
"required": ["payloadTemplate", "triggers", "oAuthClientId", "id", "subscriberUrl", "active"]
},
"OAuthClientWebhookOutputResponseDto": {
"type": "object",