{"openapi":"3.0.0","info":{"title":"Scheduler Webhooks","description":"Scheduler webhooks allow developers to receive events for [Scheduler](https://developers.zoom.us/docs/zoom-scheduler/). ","version":"1.0.0"},"paths":{"scheduler.scheduled_event_created":{"post":{"tags":["webhooks"],"summary":"scheduler.scheduled_event_created","description":"The **Scheduled event created** event triggers each time one user schedules an event with the scheduler host through the public booking page.\n\n## Prerequisites\nEnable **Event subscriptions** for your Marketplace app with:\n\n* A valid **Event notification endpoint URL**.\n* The **Scheduled event created** subscription enabled under the **Scheduler** event.","operationId":"Scheduler.scheduled_event_createdWebhook","requestBody":{"description":"Webhook payload for the `scheduler.scheduled_event_created` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Scheduler.scheduled_event_createdEvent"},"examples":{"default":{"summary":"Example scheduler.scheduled_event_created event","value":{"event":"scheduler.scheduled_event_created","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","user_id":"dndhfdjdihd","object":{"invitee_email":"john.doe@example.com","invitee_first_name":"John","invitee_last_name":"Doe","invitee_id":"61mzpk6irznpqc5yfkcnafyse7","rescheduled_from_event_id":"t36axo1tnxvyte5w35x4zht964","rescheduled_from_invitee_id":"fl4ulj7pa0ez23jmfq980ydae7","manage_url":"https://scheduler.zoom.us/manage/m0o1uf25uq89wllenxxxxxxxxxxxx","time_zone":"Asia/Shanghai","questions_and_answers":[{"question":"Please share anything that will help prepare for our meeting.","position":0,"answer":["First line","Second line"]}],"scheduled_event":{"event_id":"woft7torlatbw8ek24bmit5k60","attendees":[{"display_name":"Jane Doe","email":"jane@example.com"},{"display_name":"David Smith","email":"david@example.com"}],"end_date_time":"2023-12-21T16:30:00Z","guests":["guest1@example.com","guest2@example.com"],"location_kind":"zoom","location":{"custom_location":"123 Main St","location_type":"in-person_meeting","additional_info":"additional information"},"external_location":{"kind":"zoom","meeting_id":"94777886776","personal_meeting_id":"98656786887","meeting_passcode":"958000","meeting_description":"Invite you to meeting","meeting_join_url":"https://zoom.us/j/7427752805"},"start_date_time":"2023-12-21T16:00:00Z","status":"confirmed","summary":"30 minute meeting","updated":"2023-12-21T06:19:28.309Z","created":"2023-12-21T06:18:28.309Z","meeting_notes":"meeting notes","invitee_counters":{"total":1,"active":1,"limit":3}},"tracking":{"utm_source":"email","utm_medium":"newsletter","utm_campaign":"spring_sale","utm_content":"booking_link","utm_term":"shopping","salesforce_ids":[{"sf_person":"0035g00000AbCdEAAZ"},{"sf_relates":"0015g00000AbCdEAAZ"}]},"rescheduled":true,"created":"2023-12-21T06:18:28.309Z","text_phone_number":"+1 83798773"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"scheduler.scheduled_event_canceled":{"post":{"tags":["webhooks"],"summary":"scheduler.scheduled_event_canceled","description":"The **Scheduled event canceled** event triggers each time the host or booker cancels the scheduled event.\n\n## Prerequisites\nEnable **Event subscriptions** for your Marketplace app with:\n\n* A valid **Event notification endpoint URL**.\n* The **Scheduled event canceled** subscription enabled under the **Scheduler** event.","operationId":"Scheduler.scheduled_event_canceledWebhook","requestBody":{"description":"Webhook payload for the `scheduler.scheduled_event_canceled` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Scheduler.scheduled_event_canceledEvent"},"examples":{"default":{"summary":"Example scheduler.scheduled_event_canceled event","value":{"event":"scheduler.scheduled_event_canceled","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","user_id":"dndhfdjdihd","object":{"invitee_email":"john.doe@example.com","invitee_first_name":"John","invitee_last_name":"Doe","invitee_id":"61mzpk6irznpqc5yfkcnafyse7","rescheduled_to_event_id":"t36axo1tnxvyte5w35x4zht964","rescheduled_to_invitee_id":"fl4ulj7pa0ez23jmfq980ydae7","manage_url":"https://scheduler.zoom.us/manage/m0o1uf25uq89wllenxxxxxxxxxxxx","cancellation":{"canceled_by":"aa@bb.c","canceler_type":"host","cancel_at":"2023-12-21T16:30:00+08:00","reason":"Time conflict"},"time_zone":"Asia/Shanghai","questions_and_answers":[{"question":"Please share anything that will help prepare for our meeting.","position":0,"answer":["First line","Second line"]}],"scheduled_event":{"event_id":"woft7torlatbw8ek24bmit5k60","attendees":[{"display_name":"Jane Doe","email":"jane@example.com"},{"display_name":"David Smith","email":"david@example.com"}],"end_date_time":"2023-12-21T16:30:00Z","guests":["guest1@example.com","guest2@example.com"],"location_kind":"custom","location":{"custom_location":"123 Main St","location_type":"in-person_meeting","additional_info":"additional information"},"external_location":{"kind":"zoom","meeting_id":"94777886776","personal_meeting_id":"98656786887","meeting_passcode":"958000","meeting_description":"Invite you to meeting","meeting_join_url":"https://zoom.us/j/7427752805"},"start_date_time":"2023-12-21T16:00:00Z","status":"confirmed","summary":"30 minute meeting","updated":"2023-12-21T06:19:28.309Z","created":"2023-12-21T06:18:28.309Z","meeting_notes":"meeting notes","invitee_counters":{"total":1,"active":1,"limit":3}},"tracking":{"utm_source":"email","utm_medium":"newsletter","utm_campaign":"spring_sale","utm_content":"booking_link","utm_term":"shopping","salesforce_ids":[{"sf_person":"0035g00000AbCdEAAZ"},{"sf_relates":"0015g00000AbCdEAAZ"}]},"rescheduled":true,"created":"2023-12-21T06:18:28.309Z","text_phone_number":"+1 48837847"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}}},"components":{"schemas":{"Scheduler.scheduled_event_createdEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"The timestamp when the event was created.","format":"int64"},"payload":{"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the scheduled event host."},"user_id":{"type":"string","description":"The user ID of the scheduled event host."},"object":{"type":"object","properties":{"invitee_email":{"type":"string","description":"The email address of the invitee who scheduled the event.","example":"example@example.com"},"invitee_first_name":{"type":"string","description":"The first name of the invitee who scheduled the event.","example":"John"},"invitee_last_name":{"type":"string","description":"The last name of the invitee who scheduled the event.","example":"Doe"},"invitee_id":{"type":"string","description":"The unique identifier of the invitee record.","example":"61mzpk6irznpqc5yfkcnafyse7"},"rescheduled_from_event_id":{"type":"string","description":"The unique identifier of the event from which this invitee was rescheduled.","example":"t36axo1tnxvyte5w35x4zht964"},"rescheduled_from_invitee_id":{"type":"string","description":"The unique identifier of the invitee record associated with the event from which this invitee was rescheduled.","example":"t36axo1tnxvyte5w35x4zht964"},"manage_url":{"type":"string","description":"The URL for the user to reschedule or cancel the scheduled event.","example":"https://scheduler.zoom.us/manage/m0o1uf25uq89wllenxxxxxxxxxxxx"},"time_zone":{"type":"string","description":"The user's time zone.","example":"Asia/Shanghai"},"questions_and_answers":{"type":"array","description":"The collection of questions and answers from the booking form.","items":{"required":["answer","position","question"],"type":"object","properties":{"question":{"type":"string","description":"The question from the booking page.","example":"Please share anything that will help prepare for our meeting."},"position":{"type":"integer","description":"The index of the question."},"answer":{"type":"array","description":"The answers to the question.","items":{"type":"string","description":"The answer to the question."}}}}},"scheduled_event":{"type":"object","properties":{"event_id":{"type":"string","description":"The unique identifier of the event.","example":"woft7torlatbw8ek24bmit5k60"},"attendees":{"type":"array","description":"The attendees of the event.","items":{"type":"object","properties":{"display_name":{"type":"string","description":"The attendee's name.","example":"bob"},"email":{"type":"string","description":"The attendee's email address.","example":"abc@zoom.us"}}}},"invitee_counters":{"type":"object","properties":{"total":{"type":"integer","description":"The total count of invitees in the event.","format":"int64"},"active":{"type":"integer","description":"The count of active invitees in the event.","format":"int64"},"limit":{"type":"integer","description":"The maximum number of invitees allowed for the event.","format":"int64"}},"description":"The event's guest counters."},"end_date_time":{"type":"string","description":"The scheduled event's end date and time.","example":"2023-12-21T16:30:00Z"},"guests":{"type":"array","description":"The collection of guests.","items":{"type":"string","description":"The guest's email address.","example":"tom@zoom.us"}},"location_kind":{"type":"string","description":"Unified location type for both location and external_location objects. If location type is online meeting, location info is in external_location object. If not, location info is in location object.","example":"zoom","enum":["custom","in-person_meeting","outbound_call","inbound_call","invitee_specified","zoom","google_meet","microsoft_teams"]},"location":{"oneOf":[{"title":"zoom","type":"object","properties":{"zoom_join_url":{"maxLength":1024,"type":"string","description":"The URL to join a meeting.","example":"https://success.zoom.us/j/xxxxxxxx?pwd=xxxxxxxx"},"location_type":{"type":"string","description":"Whether it's a Zoom meeting.","enum":["zoom"]},"zoom_meeting_data":{"type":"object","properties":{"zoom_meeting_id":{"maxLength":1024,"type":"string","description":"The unique identifier of the meeting in string format. This field is also known as the meeting number.","example":"1234567890"},"zoom_meeting_passcode":{"maxLength":1024,"type":"string","description":"The passcode of the meeting.","example":"dnjchd"},"zoom_personal_meeting_id":{"maxLength":1024,"type":"string","description":"The personal meeting ID in string format.","example":"98656786887"}},"description":"The extra info for the meeting."},"zoom_meeting_status":{"type":"string","description":"The status of meeting.","enum":["scheduled","failed"]}},"description":"All the information about the Zoom meeting.","deprecated":true},{"title":"Non-online meeting location","type":"object","properties":{"custom_location":{"maxLength":1024,"type":"string","description":"The information for a location. May be a phone number or a physical location.","example":"AAA office"},"location_type":{"type":"string","description":"The location type.","enum":["custom","in-person_meeting","outbound_call","inbound_call","invitee_specified"]},"additional_info":{"type":"string","description":"Additional info for location.","example":"extra info"}},"description":"All the information about the Non-online meeting location."}]},"external_location":{"description":"The meeting details in the scheduled event.","readOnly":true,"oneOf":[{"type":"object","properties":{"kind":{"type":"string","description":"The type of meeting specified in the schedule.","example":"zoom","enum":["zoom","google_meet","microsoft_teams"]},"meeting_id":{"type":"string","description":"The unique identifier of the meeting in string format.","example":"94777886776"},"personal_meeting_id":{"type":"string","description":"The personal meeting ID in string format.","example":"98656786887"},"meeting_passcode":{"type":"string","description":"The meeting passcode.","example":"958000"},"meeting_description":{"type":"string","description":"The Zoom meeting description.","example":"Invite you to meeting"},"meeting_join_url":{"type":"string","description":"The URL to join the meeting.","example":"https://zoom.us/j/7427752805"}}}]},"start_date_time":{"type":"string","description":"The scheduled event's start date and time.","example":"2023-12-21T16:00:00Z"},"status":{"type":"string","description":"The event status: confirmed or cancelled.","example":"confirmed","enum":["confirmed","cancelled"]},"summary":{"maxLength":256,"type":"string","description":"The schedule name.","example":"daily meeting"},"updated":{"type":"string","description":"The moment the scheduled event was updated.","readOnly":true,"example":"2023-12-21T06:18:32.087Z"},"created":{"type":"string","description":"The moment the scheduled event was created.","readOnly":true,"example":"2023-12-21T06:18:32.087Z"},"meeting_notes":{"maxLength":1024,"type":"string","description":"The scheduled event's meeting notes.","example":"meeting notes"}},"additionalProperties":false,"description":"The scheduled event information."},"tracking":{"type":"object","properties":{"utm_source":{"type":"string","description":"This field identifies which site sent the traffic and is a required parameter.","example":"zoom"},"utm_medium":{"type":"string","description":"This field identifies what type of link was used, such as pay-per-click or email.","example":"pay-per-clik"},"utm_campaign":{"type":"string","description":"This field identifies a specific product promotion or strategic campaign.","example":"spring_sale"},"utm_content":{"type":"string","description":"This field identifies what specifically was clicked to bring the user to the site, such as a banner ad or a text link. It is often used for A/B testing and content-targeted ads.","example":"schedule link"},"utm_term":{"type":"string","description":"This field identifies the search terms.","example":"learning"},"salesforce_ids":{"type":"array","description":"The tracking of Salesforce IDs.","items":{"type":"object"}}},"description":"The information to track the invitee source. This field is present when UTM parameters or Salesforce IDs are added."},"rescheduled":{"type":"boolean","description":"Indicates whether this is from a reschedule request."},"created":{"type":"string","description":"The moment the scheduled request was created.","readOnly":true,"example":"2023-12-21T06:18:32.087Z"},"text_phone_number":{"type":"string","description":"The phone number of the invitee to receive text reminders.","example":"+1 83798773"}},"additionalProperties":false,"description":"The event information."}},"additionalProperties":false}},"additionalProperties":false},"Scheduler.scheduled_event_canceledEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"The timestamp when the event was created.","format":"int64"},"payload":{"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the scheduled event host."},"user_id":{"type":"string","description":"The user ID of the scheduled event host."},"object":{"type":"object","properties":{"invitee_email":{"type":"string","description":"The email address of the invitee who scheduled the event.","example":"example@example.com"},"invitee_first_name":{"type":"string","description":"The first name of the invitee who scheduled the event.","example":"John"},"invitee_last_name":{"type":"string","description":"The last name of the invitee who scheduled the event.","example":"Doe"},"invitee_id":{"type":"string","description":"The unique identifier of the invitee record.","example":"61mzpk6irznpqc5yfkcnafyse7"},"rescheduled_to_event_id":{"type":"string","description":"The unique identifier of the event that this invitee was rescheduled to.","example":"t36axo1tnxvyte5w35x4zht964"},"rescheduled_to_invitee_id":{"type":"string","description":"The unique identifier of the invitee record associated with the event that this invitee was rescheduled to.","example":"t36axo1tnxvyte5w35x4zht964"},"manage_url":{"type":"string","description":"The URL for the user to reschedule or cancel the scheduled event.","example":"https://scheduler.zoom.us/manage/m0o1uf25uq89wllenxxxxxxxxxxxx"},"cancellation":{"type":"object","properties":{"canceled_by":{"type":"string","description":"The name or email address of the canceler.","example":"aa@bb.c"},"canceler_type":{"type":"string","description":"The user type of the person who canceled.","example":"host","enum":["host","invitee"]},"cancel_at":{"type":"string","description":"The date and time when this scheduled event was canceled.","example":"2023-12-21T16:30:00+08:00"},"reason":{"type":"string","description":"The reason for canceling this scheduled event.","example":"Time conflict"}},"description":"The scheduled event cancellation information."},"time_zone":{"type":"string","description":"The user's time zone.","example":"Asia/Shanghai"},"questions_and_answers":{"type":"array","description":"All questions and answers.","items":{"required":["answer","position","question"],"type":"object","properties":{"question":{"type":"string","description":"The question on the booking page.","example":"Please share anything that will help prepare for our meeting."},"position":{"type":"integer","description":"The index of the question."},"answer":{"type":"array","description":"The answers to the question.","items":{"type":"string","description":"The answer to the question."}}}}},"scheduled_event":{"type":"object","properties":{"event_id":{"type":"string","description":"The unique identifier of the event.","example":"woft7torlatbw8ek24bmit5k60"},"attendees":{"type":"array","description":"The hosts of the scheduled event.","items":{"type":"object","properties":{"display_name":{"type":"string","description":"The attendee's name.","example":"bob"},"email":{"type":"string","description":"The attendee's email address.","example":"abc@zoom.us"}}}},"invitee_counters":{"type":"object","properties":{"total":{"type":"integer","description":"The total count of invitees in the event.","format":"int64"},"active":{"type":"integer","description":"The count of active invitees in the event.","format":"int64"},"limit":{"type":"integer","description":"The maximum limit of invitees in the event.","format":"int64"}},"description":"The event's guest counters."},"end_date_time":{"type":"string","description":"The scheduled event's end date and time.","example":"2023-12-21T16:30:00Z"},"guests":{"type":"array","description":"The collection of guests.","items":{"type":"string","description":"The guest's email address.","example":"tom@zoom.us"}},"location_kind":{"type":"string","description":"Unified location type for both location and external_location objects. If location type is online meeting, location info is in external_location object. If not, location info is in location object.","example":"zoom","enum":["custom","in-person_meeting","outbound_call","inbound_call","invitee_specified","zoom","google_meet","microsoft_teams"]},"location":{"oneOf":[{"title":"zoom","type":"object","properties":{"zoom_join_url":{"maxLength":1024,"type":"string","description":"The URL to join a meeting.","example":"https://success.zoom.us/j/xxxxxxxx?pwd=xxxxxxxx"},"location_type":{"type":"string","description":"Whether it's a Zoom meeting.","enum":["zoom"]},"zoom_meeting_data":{"type":"object","properties":{"zoom_meeting_id":{"maxLength":1024,"type":"string","description":"The unique identifier of the meeting in string format. This field is also known as the meeting number.","example":"1234567890"},"zoom_meeting_passcode":{"maxLength":1024,"type":"string","description":"The passcode for the meeting.","example":"dnjchd"},"zoom_personal_meeting_id":{"maxLength":1024,"type":"string","description":"The personal meeting ID in string format.","example":"98656786887"}},"description":"The additional information for the meeting."},"zoom_meeting_status":{"type":"string","description":"The status of the meeting.","enum":["scheduled","failed"]}},"description":"All the information about the Zoom meeting.","deprecated":true},{"title":"Non-online meeting location","type":"object","properties":{"custom_location":{"maxLength":1024,"type":"string","description":"The information for a location. May be a phone number or a physical location.","example":"AAA office"},"location_type":{"type":"string","description":"The location type.","enum":["custom","in-person_meeting","outbound_call","inbound_call","invitee_specified"]},"additional_info":{"type":"string","description":"Additional information for the location.","example":"extra info"}},"description":"All the information about the non-online meeting location."}]},"external_location":{"description":"The meeting details in the scheduled event.","readOnly":true,"oneOf":[{"type":"object","properties":{"kind":{"type":"string","description":"The type of meeting specified in the schedule.","example":"zoom","enum":["zoom","google_meet","microsoft_teams"]},"meeting_id":{"type":"string","description":"The unique identifier of the meeting in string format.","example":"94777886776"},"personal_meeting_id":{"type":"string","description":"The personal meeting ID in string format.","example":"98656786887"},"meeting_passcode":{"type":"string","description":"The passcode for the meeting.","example":"958000"},"meeting_description":{"type":"string","description":"The description of the Zoom meeting.","example":"Invite you to meeting"},"meeting_join_url":{"type":"string","description":"The URL to join the meeting.","example":"https://zoom.us/j/7427752805"}}}]},"start_date_time":{"type":"string","description":"The scheduled event's start date and time.","example":"2023-12-21T16:00:00Z"},"status":{"type":"string","description":"The status of the event: confirmed or cancelled.","example":"confirmed","enum":["confirmed","cancelled"]},"summary":{"maxLength":256,"type":"string","description":"The name of the schedule.","example":"daily meeting"},"updated":{"type":"string","description":"The moment the scheduled event was updated.","readOnly":true,"example":"2023-12-21T06:18:32.087Z"},"created":{"type":"string","description":"The moment the scheduled event was created.","readOnly":true,"example":"2023-12-21T06:18:32.087Z"},"meeting_notes":{"maxLength":1024,"type":"string","description":"The meeting notes for the scheduled event.","example":"meeting notes"}},"additionalProperties":false,"description":"The information about the scheduled event."},"tracking":{"type":"object","properties":{"utm_source":{"type":"string","description":"This field identifies which site sent the traffic, and is a required parameter.","example":"zoom"},"utm_medium":{"type":"string","description":"This field identifies what type of link was used, such as pay-per-click or email.","example":"pay-per-clik"},"utm_campaign":{"type":"string","description":"This field identifies a specific product promotion or strategic campaign.","example":"spring_sale"},"utm_content":{"type":"string","description":"This field identifies what specifically was clicked to bring the user to the site, such as a banner ad or a text link. It is often used for A/B testing and content-targeted ads.","example":"schedule link"},"utm_term":{"type":"string","description":"This field identifies search terms.","example":"learning"},"salesforce_ids":{"type":"array","description":"The tracking of Salesforce IDs.","items":{"type":"object"}}},"description":"The information to track the source of the invitee."},"rescheduled":{"type":"boolean","description":"Whether it's from a reschedule request."},"created":{"type":"string","description":"The moment the scheduled request was created.","readOnly":true,"example":"2023-12-21T06:18:32.087Z"},"text_phone_number":{"type":"string","description":"The phone number of the invitee to receive text reminders.","example":"+1 83798773"}},"additionalProperties":false,"description":"The information about the event."}},"additionalProperties":false}},"additionalProperties":false}}},"tags":[{"name":"webhooks"}],"servers":[{"url":"https://{your-endpoint-url}"}]}