{"openapi":"3.0.0","info":{"title":"Meetings Webhooks","description":"The Zoom Meeting webhooks allow developers to receive events for Zoom Meetings and Webinars.","version":"1.0.0"},"paths":{"meeting.participant_jbh_waiting":{"post":{"tags":["Meetings"],"summary":"meeting.participant_jbh_waiting","description":"\nThe **Participant waiting for host to join** event is triggered every time an attendee has been waiting for the host to join the meeting for at least 30 seconds.\n\n**NOTE** For **native clients and SDKs**, the **Participant waiting for host to join** event is triggered every time an attendee using the native client has been waiting for the host to join the meeting for at least 30 seconds. For **web clients and SDKs**, this webhook fires immediately.\n\nWhen scheduling a meeting, the organizer or host of the meeting can enable the **Enable join before host** option. This allows attendees to join the meeting before the host of the meeting arrives. This meeting also starts as soon as the first meeting participant joins.\n\nIf this option is **disabled**, participants are prompted to wait for the host to arrive before joining the meeting.\n\n## Prerequisites\n\n* A Pro or a higher plan.\n* **Disable** the **Enable join before host** option for the scheduled meeting.\n* The attendee has been waiting for at least 30 seconds before the event is triggered.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Participant waiting for host to join** subscription enabled under the **Meeting** event.","operationId":"Meeting.participant_jbh_waitingWebhook","requestBody":{"description":"Webhook payload for the `meeting.participant_jbh_waiting` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.participant_jbh_waitingEvent"},"examples":{"default":{"summary":"Example meeting.participant_jbh_waiting event","value":{"event":"meeting.participant_jbh_waiting","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":8,"start_time":"2021-07-13T21:44:51Z","duration":60,"timezone":"America/Los_Angeles","participant":{"id":"iFxeBPYun6SAiWUzBcEkX","user_name":"JillChill","customer_key":"349589LkJyeW","registrant_id":"abcdefghij0-klmnopq23456"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.summary_recovered":{"post":{"tags":["Meetings"],"summary":"meeting.summary_recovered","description":"\nThe **Meeting summary has been recovered from trash** event is triggered every time one of your app users or account users recovers a summary from the trash.\n\n## Prerequisites\n\n* Host user must be Pro or higher plan.\n* Enable the **Meeting Summary with AI Companion** feature in the host's account.\n* E2ee meetings do not have summary feature enabled.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Meeting summary has been recovered from trash** subscription enabled under the **Meeting** event.","operationId":"Meeting.summary_recoveredWebhook","requestBody":{"description":"Webhook payload for the `meeting.summary_recovered` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.summary_recoveredEvent"},"examples":{"default":{"summary":"Example meeting.summary_recovered event","value":{"event":"meeting.summary_recovered","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"meeting_host_id":"30R7kT7bTIKSNUFEuH_Qlg","meeting_host_email":"jchill@example.com","meeting_uuid":"aDYlohsHRtCd4ii1uC2+hA==","meeting_id":97763643886,"meeting_topic":"My Meeting","meeting_start_time":"2019-07-15T23:24:52Z","meeting_end_time":"2020-07-15T23:30:19Z","summary_start_time":"2019-07-15T23:24:52Z","summary_end_time":"2020-07-15T23:30:19Z","summary_created_time":"2019-07-15T23:24:52Z","summary_last_modified_time":"2020-07-15T23:30:19Z","summary_title":"Meeting Summary for my meeting"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.participant_left_breakout_room":{"post":{"tags":["Meetings"],"summary":"meeting.participant_left_breakout_room","description":"\nThe **Meeting participant has left a breakout room** event is triggered when a meeting participant leaves a meeting [breakout room](https://support.zoom.us/hc/en-us/articles/115005769646-Participating-in-breakout-rooms).\n\nBreakout rooms are sessions that are split off from the main Zoom meeting. They let participants meet in smaller groups and are completely isolated in terms of audio and video from the main session.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Meeting participant has left a breakout room** subscription enabled under the **Meeting** event.\n\n","operationId":"Meeting.participant_left_breakout_roomWebhook","requestBody":{"description":"Webhook payload for the `meeting.participant_left_breakout_room` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.participant_left_breakout_roomEvent"},"examples":{"default":{"summary":"Example meeting.participant_left_breakout_room event","value":{"event":"meeting.participant_left_breakout_room","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","breakout_room_uuid":"FkQbpP2UR028mDrwzEahqw==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":8,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"participant":{"user_id":"31228928","parent_user_id":"1234567890","user_name":"Jill Chill","id":"iFxeBPYun6SAiWUzBcEkX","participant_uuid":"55555AAAiAAAAAiAiAiiAii","leave_time":"2021-07-13T22:50:51Z","leave_reason":"Jill Chill left the meeting.<br>Reason: Host ended the meeting.","date_time":"2021-07-13T21:44:51Z","email":"jchill@example.com","registrant_id":"abcdefghij0-klmnopq23456","participant_user_id":"rstuvwxyza789-cde","phone_number":"8615250064084","customer_key":"349589LkJyeW"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.device_tested":{"post":{"tags":["Meetings"],"summary":"meeting.device_tested","description":"\nThe **Meeting Device Tested** event is triggered every time a user completes a [connected device test](https://support.zoom.us/hc/en-us/articles/201362283-Testing-computer-or-device-audio).\n\nWhen a user joins a meeting, they choose to test their connected camera, microphone, and speaker devices. The Zoom client performs a test for the selected device and prompts a user to confirm whether the device works.\n\n## Prerequisites\n\n* Create the meeting via the [Create a Meeting](https://developers.zoom.us/docs/api/meetings/#tag/meetings/POST/users/{userId}/meetings) API with the `device_testing` set to true.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Meeting Device Tested** subscription enabled under the **Meeting** event.","operationId":"Meeting.device_testedWebhook","requestBody":{"description":"Webhook payload for the `meeting.device_tested` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.device_testedEvent"},"examples":{"default":{"summary":"Example meeting.device_tested event","value":{"event":"meeting.device_tested","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":1234567890,"uuid":"4444AAAiAAAAAiAiAiiAii==","test_result":{"user_id":"1234567890","user_name":"JillChill","camera_status":1,"speaker_status":1,"microphone_status":1,"os":"ios"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.summary_shared":{"post":{"tags":["Meetings"],"summary":"meeting.summary_shared","description":"\nThe **Meeting summary has been shared** event is triggered every time one of your app users or account users shares a meeting summary.\n\n## Prerequisites\n\n* Host user must have a Pro or higher plan.\n* Enable the **Meeting Summary with AI Companion** feature in the host's account.\n* E2ee meetings do not have summary feature enabled.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Meeting summary has been shared** subscription enabled under the **Meeting** event.","operationId":"Meeting.summary_sharedWebhook","requestBody":{"description":"Webhook payload for the `meeting.summary_shared` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.summary_sharedEvent"},"examples":{"default":{"summary":"Example meeting.summary_shared event","value":{"event":"meeting.summary_shared","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"meeting_host_id":"30R7kT7bTIKSNUFEuH_Qlg","meeting_host_email":"jchill@example.com","meeting_uuid":"aDYlohsHRtCd4ii1uC2+hA==","meeting_id":97763643886,"meeting_topic":"My Meeting","meeting_start_time":"2019-07-15T23:24:52Z","meeting_end_time":"2020-07-15T23:30:19Z","summary_start_time":"2019-07-15T23:24:52Z","summary_end_time":"2020-07-15T23:30:19Z","summary_created_time":"2019-07-15T23:24:52Z","summary_last_modified_time":"2020-07-15T23:30:19Z","summary_title":"Meeting Summary for my meeting","share_with_users":[{"user_email":"jchill@example.com"}]}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.chat_message_file_downloaded":{"post":{"tags":["Webinars"],"summary":"webinar.chat_message_file_downloaded","description":"The **In-webinar chat message file has been downloaded** event is triggered when a message file from a webinar is downloaded.\nThe webhook is needed to enable the DLP option in the web portal. \n\n## Prerequisites\n\n* Have Zoom enable the DLP for in-meeting chat for your account.  This feature is **only** enabled upon request. Contact the [Zoom support team](https://support.zoom.us/hc/en-us/articles/201362003) for more information. \n* Enable the **In-webinar chat message file has been downloaded** subscription for your app. In your [Marketplace app](https://marketplace.zoom.us/user/build) go to **Event Subscriptions** > **Webinar**.\n","operationId":"Webinar.chat_message_file_downloadedWebhook","requestBody":{"description":"Webhook payload for the `webinar.chat_message_file_downloaded` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.chat_message_file_downloadedEvent"},"examples":{"default":{"summary":"Example webinar.chat_message_file_downloaded event","value":{"event":"webinar.chat_message_file_downloaded","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"user@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"id":1234567890,"uuid":"4444AAAiAAAAAiAiAiiAii==","host_account_id":"lmnop12345abcdefghijk","chat_message_file":{"file_id":"MS17RDk0QTY3QUQtQkFGQy04QTJFLTI2RUEtNkYxQjRBRTU1MTk5fQ==","file_name":"example.jpg","file_owner_id":"rw3dIsBRTpOyMOJmeKgdaQ","file_size":3966,"file_type":"jpg"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.deleted":{"post":{"tags":["Webinars"],"summary":"webinar.deleted","description":"\nThe **Webinar has been deleted** event is triggered every time a webinar scheduled by one of your app users or account users, is deleted.\n\nA webinar host or a user with admin privileges can delete a scheduled webinar. Users can delete a webinar using the **Delete** feature for a webinar, from the [Zoom Web Portal](https://zoom.us/webinar/list) or the Zoom Client App. Alternatively, users can use the [**Delete a webinar**](/docs/api-reference/zoom-api/methods#operation/webinarDelete) API to delete webinars programmatically.\n\n## **Prerequisites**:\n* Pro or a higher plan with Webinar license.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Webinar has been deleted** subscription enabled under the **Webinar** event.\n\n","operationId":"Webinar.deletedWebhook","requestBody":{"description":"Webhook payload for the `webinar.deleted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.deletedEvent"},"examples":{"default":{"summary":"Example webinar.deleted event","value":{"event":"webinar.deleted","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","operation":"single","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","id":1234567890,"host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Webinar","type":9,"start_time":"2021-07-13T21:44:51Z","duration":60,"timezone":"America/Los_Angeles","occurrences":[{"occurrence_id":"ABCDE12345","start_time":"2021-07-13T21:44:51Z"}]}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"recording.registration_approved":{"post":{"tags":["Cloud Recording"],"summary":"recording.registration_approved","description":"\nThe **View registrant has approved for this recording** event is triggered every time a registrant is approved to view a cloud recording.\n\n[Cloud recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording) of Zoom meetings and webinars can be made [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings). With on-demand recordings, users can view the recordings of past meetings and webinars at any time as long as they have not been removed. To view these recordings, users can register manually by filling out the registration form that pops up when users click on the **Recording URL**. After the registration, registrants that are approved will be able to view the recording.\n\nAn account owner, a host of the meeting/webinar or a user with admin privileges can customize the cloud recording [registration approval settings](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings). If the **Automatically Approve** setting is enabled, registrants can view the recording automatically after a successful registration. If the **Manually Approve** setting is enabled, the registrants must be manually approved before they can view the recording.\n\nRegistrants can also be approved programmatically using the [**Update registrant status**](/api-reference/zoom-api/ma#operation/meetingRecordingRegistrantStatus) API.\n\n## Prerequisites\n\n* A Pro or higher plan.\n* Cloud recording must be enabled on the users' account.\n* The [approval setting](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) for the cloud recording registration must be set to **Manually Approve**.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **View registrant has approved for this recording** subscription enabled under the **Recording** event.\n\n","operationId":"Recording.registration_approvedWebhook","requestBody":{"description":"Webhook payload for the `recording.registration_approved` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recording.registration_approvedEvent"},"examples":{"default":{"summary":"Example recording.registration_approved event","value":{"event":"recording.registration_approved","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"I7zp-pYbTl22Z29H796Ixg","object":{"id":1234567890,"uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Personal Recording","type":4,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"occurrences":{"occurrence_id":"ABCDE12345","start_time":"2021-07-13T21:44:51Z"},"registrant":{"id":"iFxeBPYun6SAiWUzBcEkX","email":"jchill@example.com","first_name":"Jill","last_name":"Chill"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.risk_alert":{"post":{"tags":["Meetings"],"summary":"meeting.risk_alert","description":"\nThe **At-Risk Meeting Notifier** event is triggered every time someone posts a Zoom meeting link to a social media account, such as Reddit or Twitter. The webhook sends the event to an authorized [OAuth app](https://marketplace.zoom.us/docs/api-reference/webhook-reference#oauth-app).\n\nThe [**At-Risk Meeting Notifier (ARMN)**](https://support.zoom.us/hc/en-us/articles/360052087972-At-Risk-Meeting-Notifier) scans public posts on social media sites and other public online resources for Zoom meeting links. When it finds publicly-posted meeting information indicating that a given meeting may be at high risk of being disrupted, Zoom notifies account owners and admins via email.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **At-Risk Meeting Notifier** subscription enabled under the **Meeting** event.","operationId":"Meeting.risk_alertWebhook","requestBody":{"description":"Webhook payload for the `meeting.risk_alert` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.risk_alertEvent"},"examples":{"default":{"summary":"Example meeting.risk_alert event","value":{"event":"meeting.risk_alert","event_ts":1620872887470,"payload":{"account_id":"XTYf8rirS_W0emt2TlxsYQ","object":{"id":1234567890,"uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","host_email":"jchill@example.com","topic":"My Meeting","type":2,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","armn_details":{"post_platform":"twitter","social_link":"https://example.com/user/status/1372556404872069120","post_time":"2021-05-15T02:28:00Z","post_user":"user","meeting_url":"https://example.com/j/82390661051","recommended_enable_settings":["enablePassword","enableWaitingRoom"],"recommended_disable_settings":["enableScreenShareHostOnly","enableMeetingChat"]}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.aic_transcript_completed":{"post":{"tags":["Meetings"],"summary":"meeting.aic_transcript_completed","description":"\nThe **AIC transcript completed** triggers when the meeting transcript file is completed after a meeting or webinar ends.\n\n## Prerequisites\n\n* Enable the **Meeting Summary with AI Companion** feature and **Allow meeting hosts to retain and access meeting transcripts** in the host's account.\n* Do not enable transcripts for E2ee meetings.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **AIC transcript completed** subscription enabled under the **Meeting** event.","operationId":"Meeting.aic_transcript_completedWebhook","requestBody":{"description":"Webhook payload for the `meeting.aic_transcript_completed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.aic_transcript_completedEvent"},"examples":{"default":{"summary":"Example meeting.aic_transcript_completed event","value":{"event":"meeting.aic_transcript_completed","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","object":{"host_id":"30R7kT7bTIKSNUFEuH_Qlg","meeting_uuid":"aDYlohsHRtCd4ii1uC2+hA==","meeting_id":97763643886,"meeting_topic":"My Meeting","meeting_start_time":"2019-07-15T23:24:52Z","file_id":"30R7kT7bTIKSNUFEuH_Qlg","attach_type":"durable_transcript"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.participant_feedback":{"post":{"tags":["Webinars"],"summary":"webinar.participant_feedback","description":"\nThe **Get participant survey feedback for webinars** event is triggered every time an attendee completes an end-of-webinar [feedback survey](https://support.zoom.us/hc/en-us/articles/115005855266-End-of-meeting-experience-feedback-survey) for a webinar. A webinar attendee is a webinar participant or the host.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n* A valid **Event Notification Endpoint URL**.\n* The **Get participant survey feedback for webinars** subscription must be enabled under the **Webinar** event.\n\n","operationId":"Webinar.participant_feedbackWebhook","requestBody":{"description":"Webhook payload for the `webinar.participant_feedback` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.participant_feedbackEvent"},"examples":{"default":{"summary":"Example webinar.participant_feedback event","value":{"event":"webinar.participant_feedback","event_ts":1626230691572,"payload":{"account_id":"q6gBJVO5TzexKYTb_I2rpg","object":{"id":"7357282288","uuid":"0AErJTQBTI2bSXKyAxIq5A==","participant":{"participant_uuid":"I2rpg_q6gBJVO5TzexKYTb","participant_user_id":"zJKyaiAyTNC-MWjiWC18KQ","user_name":"jchill","feedback":{"satisfied":true,"feedback_details":[{"id":"2","name":"Poor audio quality"}],"comments":"good enough"}}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.participant_joined_waiting_room":{"post":{"tags":["Meetings"],"summary":"meeting.participant_joined_waiting_room","description":"\nThe **Participant joined a waiting room** event is triggered every time an attendee joins a waiting room prior to being admitted to the meeting. The meeting host must be a user in your account or a user in any other accounts that have installed your [webhook-enabled](https://developers.zoom.us/docs/api/rest/webhook-reference/#enable-webhooks) app.\n\nThe [**waiting room**](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) feature allows the host to control when participants join a meeting. When a participant attempts to join a meeting with this feature enabled, the participant is first admitted to the waiting room.\nThe meeting host can then admit attendees one by one or hold all attendees in the waiting room and admit them all at once. \n\n## Prerequisites\n\n* Enable the [**waiting room**](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) feature for the meeting.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Participant joined a waiting room** subscription must be enabled under the **Meeting** event.\n\n\n\n","operationId":"Meeting.participant_joined_waiting_roomWebhook","requestBody":{"description":"Webhook payload for the `meeting.participant_joined_waiting_room` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.participant_joined_waiting_roomEvent"},"examples":{"default":{"summary":"Example meeting.participant_joined_waiting_room event","value":{"event":"meeting.participant_joined_waiting_room","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":8,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"participant":{"user_id":"1234567890","user_name":"Jill Chill","id":"iFxeBPYun6SAiWUzBcEkX","participant_uuid":"55555AAAiAAAAAiAiAiiAii","date_time":"2021-07-13T21:44:51Z","email":"jchill@example.com","phone_number":"8615250064084","participant_user_id":"iFxeBPYun6SAiWUzBcEkX","customer_key":"349589LkJyeW","registrant_id":"abcdefghij0-klmnopq23456"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.ai_companion_assets_deleted":{"post":{"tags":["Meetings"],"summary":"meeting.ai_companion_assets_deleted","description":"The **AI Companion assets deleted** event is triggered when all AI Companion meeting assets, such as transcripts and summaries, are deleted during a live meeting.\n\n## Prerequisites\n\n* Host user must be Pro or higher plan.\n* Enable [AI Companion](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057623).\n* E2EE meetings do not support the AI Companion feature.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **AI Companion assets deleted** subscription enabled under the **Meeting** event.","operationId":"Meeting.ai_companion_assets_deletedWebhook","requestBody":{"description":"Webhook payload for the `meeting.ai_companion_assets_deleted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.ai_companion_assets_deletedEvent"},"examples":{"default":{"summary":"Example meeting.ai_companion_assets_deleted event","value":{"event":"meeting.ai_companion_assets_deleted","event_ts":1726155000123,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","object":{"meeting_number":97763643886,"meeting_uuid":"aDYlohsHRtCd4ii1uC2+hA==","host_id":"30R7kT7bTIKSNUFEuH_Qlg","ai_companion":{"deleted_assets":["transcripts"]}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.converted_to_meeting":{"post":{"tags":["Webinars"],"summary":"webinar.converted_to_meeting","description":"The **Webinar has been converted to a Meeting** event is triggered every time one of your app users or account users converts a webinar into a meeting.\n\n## Prerequisites\n\n* Pro or a higher plan with Webinar license.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Webinar has been converted to a Meeting** subscription enabled under the **Webinar** event.","operationId":"Webinar.converted_to_meetingWebhook","requestBody":{"description":"Webhook payload for the `webinar.converted_to_meeting` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.converted_to_meetingEvent"},"examples":{"default":{"summary":"Example webinar.converted_to_meeting event","value":{"event":"webinar.converted_to_meeting","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","id":9876543210,"host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Webinar Converted","type":2,"start_time":"2021-07-13T21:44:51Z","duration":45,"timezone":"America/Los_Angeles"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.participant_phone_callout_ringing":{"post":{"tags":["Meetings"],"summary":"meeting.participant_phone_callout_ringing","description":"\nThe **Invited party's phone (call out) ringing** event is triggered every time a user's phone rings when they are invited to [join a meeting through phone (call out)](https://support.zoom.us/hc/en-us/articles/4404535651085).\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with these configurations.\n* A valid **Event Notification Endpoint URL**.\n* The **Invited party's phone (call out) ringing** subscription enabled under the **Meeting** event.\n\n","operationId":"Meeting.participant_phone_callout_ringingWebhook","requestBody":{"description":"Webhook payload for the `meeting.participant_phone_callout_ringing` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.participant_phone_callout_ringingEvent"},"examples":{"default":{"summary":"Example meeting.participant_phone_callout_ringing event","value":{"event":"meeting.participant_phone_callout_ringing","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","object":{"id":713592696,"uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"ICuPoX4ERtikRcKqkVxunQ","participant":{"invitee_name":"Jill Chill","phone_number":1800000000}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.participant_jbh_joined":{"post":{"tags":["Meetings"],"summary":"meeting.participant_jbh_joined","description":"\nThe **Participant joined meeting before host** event is triggered every time an attendee joins a meeting before the host. The host of the meeting must be a user in your account or a user in any other accounts that have installed your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.\n\nWhen scheduling a meeting, the organizer or host of the meeting can enable the **Enable join before host** option. This allows attendees to join the meeting before the host of the meeting arrives. This meeting also starts as soon as the first meeting participant joins.\n\nIf this option is **disabled**, participants are prompted to wait for the host to arrive before joining the meeting.\n\n## Prerequisites\n\n* A Pro or a higher plan.\n* Enable the **Enable join before host** option for the scheduled meeting.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Participant joined meeting before host** subscription enabled under the **Meeting** event.\n\n\n\n","operationId":"Meeting.participant_jbh_joinedWebhook","requestBody":{"description":"Webhook payload for the `meeting.participant_jbh_joined` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.participant_jbh_joinedEvent"},"examples":{"default":{"summary":"Example meeting.participant_jbh_joined event","value":{"event":"meeting.participant_jbh_joined","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":8,"start_time":"2021-07-13T21:44:51Z","duration":60,"timezone":"America/Los_Angeles","participant":{"id":"iFxeBPYun6SAiWUzBcEkX","user_name":"JillChill","customer_key":"349589LkJyeW","registrant_id":"abcdefghij0-klmnopq23456"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.invitation_accepted":{"post":{"tags":["Meetings"],"summary":"meeting.invitation_accepted","description":"\nThe **Invited party answered a meeting invitation** event is triggered every time an invitation's recipient accepts an invitation to join a meeting or video call.\nThis event is only suitable for triggering with the ZOOM client.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with these configurations:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Invited party answered a meeting invitation** subscription enabled under the **Meeting** event.\n  \n\n","operationId":"Meeting.invitation_acceptedWebhook","requestBody":{"description":"Webhook payload for the `meeting.invitation_accepted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.invitation_acceptedEvent"},"examples":{"default":{"summary":"Example meeting.invitation_accepted event","value":{"event":"meeting.invitation_accepted","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","operator_id":"Hy7YgA-cR4eU8EfWV00tPQ","operator":"dhill@example.com","object":{"id":"91578204824","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"ICuPoX4ERtikRcKqkVxunQ","topic":"Jill Chill's Zoom Meeting","participant":{"participant_user_id":"rPwsQrpC6gPuw2zEJqw","email":"jchill@example.com"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"recording.archive_files_completed":{"post":{"tags":["Cloud Recording"],"summary":"recording.archive_files_completed","description":"\nThe **Recording Archive Files Completed** event is triggered every time the archived files of a meeting or webinar become available to download.\n\nZoom's [meeting and webinar archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data) allows account administrators to set up an automated mechanism to collect and archive meeting data to a 3rd party platform of their choice. This helps to satisfy FINRA or other compliance requirements. \n\nThe archiving process begins once a meeting or webinar, hosted by an account that has enabled the archiving feature, begins. The archiving of the meeting data completes after a meeting or webinar ends.\n\nThis feature is **only** enabled upon request approval. Contact the [Zoom support team](https://support.zoom.us/hc/en-us/articles/201362003) for more information.\n\n## Prerequisites\n\n* The **Archiving** feature must be enabled on the user's account.\n* Enable **Event Subscriptions** in your [Marketplace app](https://marketplace.zoom.us/user/build) with these configurations.\n  * A valid Event notification endpoint URL.\n  * The **Recording Archive Files Completed** subscription enabled under the **Recording** event.\n\n","operationId":"Recording.archive_files_completedWebhook","requestBody":{"description":"Webhook payload for the `recording.archive_files_completed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recording.archive_files_completedEvent"},"examples":{"default":{"summary":"Example recording.archive_files_completed event","value":{"event":"recording.archive_files_completed","event_ts":1626230691572,"download_token":"abJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJodHRwczovL2V2ZW50Lnpvb20udXMiLCJhY2NvdW50SWQiOiJNdDZzdjR1MFRBeVBrd2dzTDJseGlBIiwiYXVkIjoiaHR0cHM6Ly9vYXV0aC56b29tLnVzIiwibWlkIjoieFp3SEc0c3BRU2VuekdZWG16dnpiUT09IiwiZXhwIjoxNjI2MTM5NTA3LCJ1c2VySWQiOiJEWUhyZHBqclMzdWFPZjdkUGtrZzh3In0.a6KetiC6BlkDhf1dP4KBGUE1bb2brMeraoD45yhFx0eSSSTFdkHQnsKmlJQ-hdo9Zy-4vQw3rOxlyoHv583JyZ","payload":{"account_id":"AAAAAABBBB","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","id":1234567890,"host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Personal Recording","type":4,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"duration_in_second":3602,"total_size":3328371,"recording_count":2,"meeting_type":"internal","account_name":"account_01","complete_time":"2021-03-12T02:57:27Z","is_breakout_room":false,"archive_files":[{"id":"ed6c2f27-2ae7-42f4-b3d0-835b493e4fa8","file_type":"M4A","file_extension":"M4A","file_size":1547842,"download_url":"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngBBBB","status":"completed","recording_type":"audio_only","individual":true,"participant_email":"jchill@example.com","participant_join_time":"2021-03-12T02:07:27Z","participant_leave_time":"2021-03-12T02:12:27Z","encryption_fingerprint":"2123150b921fb1babda81c6156d2711659d37b5d3cbe6957e22e51fbb87e7a87","storage_location":"US"},{"id":"388ffb46-1541-460d-8447-4624451a1db7","file_type":"MP4","file_extension":"MP4","file_size":1780529,"download_url":"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngCCCC","status":"completed","recording_type":"shared_screen_with_speaker_view","individual":true,"participant_email":"thill@example.com","participant_join_time":"2021-03-12T02:07:27Z","participant_leave_time":"2021-03-12T02:12:27Z","encryption_fingerprint":"abf85f0fe6a4db3cdd8c37e505e1dd18a34d9696170a14b5bc6395677472cf43","storage_location":"US"}],"status":"completed","group_id":"pvFIYKSDTum9iCDOOtQL4w,_FsqLyI0RlO6LVPeUVWi8g"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.alert":{"post":{"tags":["Meetings"],"summary":"meeting.alert","description":"\nThe **Meeting issues alert** event is triggered every time a service issue is encountered during a meeting scheduled by a user in your account or in accounts that have installed your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.\n\nZoom monitors [meeting statistics](https://support.zoom.us/hc/en-us/articles/202920719-Meeting-Statistics) in regards to the quality of service for each meeting. The following quality metrics can trigger an alert:\n\n* Unstable audio.\n* Unstable video.\n* Poor screen share quality.\n* High CPU usage.\n* Call reconnection problems.\n\n## Prerequisites\n\n* The account **must** hold a [Business or a higher plan](https://zoom.us/pricing) to request this feature.\n* In account settings, on the dashboard, enable the **Meeting quality scores and network alerts on Dashboard** option.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Meeting issues alert** subscription enabled under the **Meeting** event.","operationId":"Meeting.alertWebhook","requestBody":{"description":"Webhook payload for the `meeting.alert` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.alertEvent"},"examples":{"default":{"summary":"Example meeting.alert event","value":{"event":"meeting.alert","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":2,"join_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"issues":["Unstable audio quality"]}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.chat_message_file_sent":{"post":{"tags":["Meetings"],"summary":"meeting.chat_message_file_sent","description":"\nThe **In-meeting chat message file received** event is triggered when a meeting's message file is available to view or download. The event is sent to the configured endpoint in your Marketplace app.\n\n## Prerequisites\n\n* Enable the **Enable in-meeting chat DLP (Data Loss Prevention) integration** and **Include in-meeting chat files** features in the host's account.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **In-meeting chat message file received** subscription enabled under the **Meeting** event.\n* This feature is **only** enabled upon request approval. Contact the [Zoom support team](https://support.zoom.com/hc/en/contact?id=contact_us) for more information.","operationId":"Meeting.chat_message_file_sentWebhook","requestBody":{"description":"Webhook payload for the `meeting.chat_message_file_sent` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.chat_message_file_sentEvent"},"examples":{"default":{"summary":"Example meeting.chat_message_file_sent event","value":{"event":"meeting.chat_message_file_sent","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"meeting_id":1234567890,"meeting_uuid":"4444AAAiAAAAAiAiAiiAii==","breakout_room_uuid":"FkQbpP2UR028mDrwzEahqw==","chat_message_file":{"date_time":"GMT20220110-072010","sender_session_id":"26219520","sender_name":"Jill Chill","sender_email":"dlp.user@example.com","sender_type":"host","sender_context":"meeting","recipient_session_id":"38681600","recipient_name":"John Smith","recipient_email":"guest.user@example","recipient_type":"guest","recipient_context":"meeting","message_id":"MS17MDQ5NjE4QjYtRjk4Ny00REEwLUFBQUItMTg3QTY0RjU2MzhFfQ==","file_id":"MS17RDk0QTY3QUQtQkFGQy04QTJFLTI2RUEtNkYxQjRBRTU1MTk5fQ==","file_name":"example.jpg","file_size":3966,"file_type":"jpg","download_url":"https://file.zoomdev.us/file/hsdAXySKRe2KgS-0YNeSXg/attach/format/plain?decryptType=1&filename=example.jpg&jwt=eyJhbGciOiJIUzI1NiJ9.eyJkaWciOiI3Yzg5YzBhYjIzYmZmMjdjNzE3NTQ4YzdjMTc0Njk3MWYzYjNmNjFjMzU5OTliNjE1ZjdjMWJmMzc5YTJiZThlIiwiYXVkIjoiZmlsZSIsImlzcyI6ImNyb3NzZmlsZSIsImV4cCI6MTY0ODI2NDY5N30.2fQxw3F1cEhvFJmnE2zPOdkHnPeZUktv_P0M--e-Tg8&mode=play"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.deleted":{"post":{"tags":["Meetings"],"summary":"meeting.deleted","description":"\nThe **Meeting has been deleted** event is triggered every time a meeting scheduled by one of your app users or account users, is deleted.\n\nA meeting host or a user with admin privileges can delete a scheduled meeting. Users can delete a meeting manually using the **Delete** feature for a meeting via the [Zoom web portal](https://zoom.us) or the Zoom client. Users can also programmatically delete meetings through the [**Delete a Meeting**](/docs/api/rest/reference/zoom-api/methods/#operation/meetingDelete) API.\n\n## Prerequisites\n\n* A Pro or higher plan.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Meeting has been deleted** subscription enabled under the **Meeting** event.","operationId":"Meeting.deletedWebhook","requestBody":{"description":"Webhook payload for the `meeting.deleted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.deletedEvent"},"examples":{"default":{"summary":"Example meeting.deleted event","value":{"event":"meeting.deleted","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","operation":"single","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","id":1234567890,"host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":8,"start_time":"2021-07-13T21:44:51Z","duration":60,"timezone":"America/Los_Angeles","occurrences":[{"occurrence_id":"ABCDE12345","start_time":"2021-07-13T21:44:51Z"}]}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.participant_joined":{"post":{"tags":["Meetings"],"summary":"meeting.participant_joined","description":"\nThe **Participant or Host joined meeting** event is triggered every time an attendee joins a meeting. A meeting attendee is a meeting participant or the host. The meeting host must be a user in your account or a user in any other accounts that have installed your [webhook-enabled](https://developers.zoom.us/docs/api/rest/webhook-reference/#enable-webhooks) app.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Participant or Host joined meeting** subscription enabled under the **Meeting** event.\n\n","operationId":"Meeting.participant_joinedWebhook","requestBody":{"description":"Webhook payload for the `meeting.participant_joined` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.participant_joinedEvent"},"examples":{"default":{"summary":"Example meeting.participant_joined event","value":{"event":"meeting.participant_joined","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":8,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"participant":{"user_id":"1234567890","user_name":"Jill Chill","id":"iFxeBPYun6SAiWUzBcEkX","participant_uuid":"55555AAAiAAAAAiAiAiiAii","date_time":"2021-07-13T21:44:51Z","email":"jchill@example.com","registrant_id":"abcdefghij0-klmnopq23456","participant_user_id":"rstuvwxyza789-cde","customer_key":"349589LkJyeW","phone_number":"8615250064084"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"user.tsp_deleted":{"post":{"tags":["TSP"],"summary":"user.tsp_deleted","description":"\nThe **A user's TSP account was deleted** event is triggered every time a TSP user account is deleted.\n\nZoom allows certain carrier partners to provision Telephony Service Provider (TSP) audio to users. For users to use TSP audio, carrier partners must create a TSP user account with Zoom for the users. Zoom account owners and admins can [delete an existing TSP user account](/api-reference/zoom-api/methods#operation/userTSPDelete).\n\n## Prerequisites\n\n* A Pro or higher plan with TSP Configurations enabled.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* The **A user's TSP account was deleted** subscription must be enabled under the **TSP** event.\n\n","operationId":"User.tsp_deletedWebhook","requestBody":{"description":"Webhook payload for the `user.tsp_deleted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User.tsp_deletedEvent"},"examples":{"default":{"summary":"Example user.tsp_deleted event","value":{"event":"user.tsp_deleted","event_ts":1234566789900,"payload":{"account_id":"Mtgfdgfgd2lxiA","operator":"admin@example.com","operator_id":"DYdgdg64567g8w","object":{"tsp_credentials":{"id":"2","conference_code":"123456789","leader_pin":"123456","dial_in_numbers":[{"code":"1","number":"123456789","type":"toll"},{"code":"93","number":"980000021","type":"tollfree"},{"code":"1","number":"2222456532","type":"media_link"}]},"email":"jchill@example.com","id":"DYbbbbf7dPkkg8w"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.ai_companion_started":{"post":{"tags":["Meetings"],"summary":"meeting.ai_companion_started","description":"The **AI Companion started** event is triggered when a user starts the AI Companion during a live meeting.\n\n## Prerequisites\n\n* Host user must be Pro or higher plan.\n* Enable [AI Companion](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057623).\n* E2EE meetings do not support the AI Companion feature.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **AI Companion started** subscription enabled under the **Meeting** event.","operationId":"Meeting.ai_companion_startedWebhook","requestBody":{"description":"Webhook payload for the `meeting.ai_companion_started` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.ai_companion_startedEvent"},"examples":{"default":{"summary":"Example meeting.ai_companion_started event","value":{"event":"meeting.ai_companion_started","event_ts":1725264900000,"payload":{"account_id":"a1B2c3D4E5f6G7h8I9J0","object":{"meeting_number":98273645123,"meeting_uuid":"cXYlohsHRtCd4ii1uC2+hA==","host_id":"12R7kT7bTIKSNUFEuH_Qlg","ai_companion":{"questions":true}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.invitation_dispatched":{"post":{"tags":["Meetings"],"summary":"meeting.invitation_dispatched","description":"\nThe **Invited party's Zoom is ringing** event is triggered every time a user sends an invitation to join a meeting or video call to one or more recipients.\n\nThis event is only suitable for triggering with the ZOOM client.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with these configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Invited party's Zoom is ringing** subscription enabled under the **Meeting** event.\n  \n\n\n","operationId":"Meeting.invitation_dispatchedWebhook","requestBody":{"description":"Webhook payload for the `meeting.invitation_dispatched` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.invitation_dispatchedEvent"},"examples":{"default":{"summary":"Example meeting.invitation_dispatched event","value":{"event":"meeting.invitation_dispatched","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","operator_id":"Hy7YgA-cR4eU8EfWV00tPQ","operator":"dhill@example.com","object":{"id":"91578204824","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"ICuPoX4ERtikRcKqkVxunQ","topic":"Jill Chill's Zoom Meeting","participant":{"participant_user_id":"rPwsQrpC6gPuw2zEJqw","email":"jchill@example.com"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.ended":{"post":{"tags":["Webinars"],"summary":"webinar.ended","description":"\nThe **End Webinar** event is triggered every time a user in your account or your app ends a webinar.\n\nZoom users with a [Webinar Plan](https://zoom.us/webinar) have permissions for creating and managing webinars. [Zoom Video Webinar](https://support.zoom.us/hc/en-us/articles/200917029-Getting-Started-With-Webinar) allows users to broadcast a Zoom meeting to up to 1000 attendees. A webinar host can start and end a webinar.\n\n## Prerequisites\n\n* Pro or a higher plan with Webinar license.\n* **Event Subscription** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **End Webinar** subscription enabled under the **Webinar** event.","operationId":"Webinar.endedWebhook","requestBody":{"description":"Webhook payload for the `webinar.ended` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.endedEvent"},"examples":{"default":{"summary":"Example webinar.ended event","value":{"event":"webinar.ended","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","host_email":"jchill@example.com","topic":"My Webinar","type":5,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","end_time":"2021-07-13T23:00:51Z","duration":60,"practice_session":true}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.converted_to_webinar":{"post":{"tags":["Meetings"],"summary":"meeting.converted_to_webinar","description":"The **Meeting has been converted to a Webinar** event is triggered every time one of your app users or account users converts a meeting into a webinar.\n\n## Prerequisites\n\n* Pro or a higher plan with Webinar license.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Meeting has been converted to a Webinar** subscription enabled under the **Meeting** event.","operationId":"Meeting.converted_to_webinarWebhook","requestBody":{"description":"Webhook payload for the `meeting.converted_to_webinar` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.converted_to_webinarEvent"},"examples":{"default":{"summary":"Example meeting.converted_to_webinar event","value":{"event":"meeting.converted_to_webinar","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","id":1234567890,"host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting Converted","type":5,"start_time":"2021-07-13T21:44:51Z","duration":60,"timezone":"America/Los_Angeles"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.recovered":{"post":{"tags":["Webinars"],"summary":"webinar.recovered","description":"\nThe **Webinar has been recovered** event is triggered every time a user recovers a previously-deleted webinar. The user must be a user on your account or on any other accounts that have installed your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.\n\nZoom users can restore previously-deleted webinars for up to one week after deletion. Any invitations, links, and webinar IDs sent prior to the webinar's deletion will still work after a user [recovers](https://support.zoom.us/hc/en-us/articles/360038297111-Recovering-a-deleted-meeting-or-webinar) it.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Webinar has been recovered** subscription enabled under the **Webinar** event.\n\n","operationId":"Webinar.recoveredWebhook","requestBody":{"description":"Webhook payload for the `webinar.recovered` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.recoveredEvent"},"examples":{"default":{"summary":"Example webinar.recovered event","value":{"event":"webinar.recovered","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","operation":"single","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","id":1234567890,"host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Webinar","type":9,"start_time":"2021-07-13T21:44:51Z","duration":60,"timezone":"America/Los_Angeles","occurrences":[{"occurrence_id":"1677637740000","start_time":"2023-03-01T02:29:00Z"}]}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.participant_role_changed":{"post":{"tags":["Webinars"],"summary":"webinar.participant_role_changed","description":"\nThe **Participant role changed** event is triggered every time a host or webinar attendee changes the role during a webinar created by one of your app users or account users. A webinar host can invite other users to attend the webinar.\n\nZoom users with a [Webinar plan](https://zoom.us/webinar) have access to creating and managing webinars. [Zoom webinars](https://support.zoom.us/hc/en-us/articles/200917029-Getting-Started-With-Webinar) let users to broadcast a Zoom meeting to up to 1,000 attendees.\n\n## Prerequisites\n\n* Pro or a higher plan with Webinar license.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Participant role changed** subscription enabled under the **Webinar** event.\n\n","operationId":"Webinar.participant_role_changedWebhook","requestBody":{"description":"Webhook payload for the `webinar.participant_role_changed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.participant_role_changedEvent"},"examples":{"default":{"summary":"Example webinar.participant_role_changed event","value":{"event":"webinar.participant_role_changed","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Webinar","type":9,"start_time":"2021-07-13T21:44:51Z","duration":60,"timezone":"America/Los_Angeles","participant":{"user_id":"1234567890","user_name":"JillChill","email":"jchill@example.com","registrant_id":"abcdefghij0-klmnopq23456","participant_user_id":"rstuvwxyza789-cde","customer_key":"349589LkJyeW","date_time":"2021-07-13T21:44:51Z","old_role":"host","new_role":"co-host"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.participant_jbh_waiting_left":{"post":{"tags":["Meetings"],"summary":"meeting.participant_jbh_waiting_left","description":"\nThe **Waiting participant left meeting before host joined** event is triggered every time an attendee waiting for the host to join the meeting leaves before the host. The host of the meeting must be a user in your account or users in any other accounts that have installed your [webhook-enabled](https://developers.zoom.us/docs/api/rest/webhook-reference/#enable-webhooks) app.\n\nWhen scheduling a meeting, the organizer or host of the meeting can enable the **Enable join before host** option. This allows attendees to join the meeting before the host of the meeting arrives. This meeting also starts as soon as the first meeting participant joins.\n\nIf this option is **disabled**, participants are prompted to wait for the host to arrive before joining the meeting.\n\n## Prerequisites\n\n* A Pro or a higher plan.\n* Disable the **Enable join before host** option for the scheduled meeting.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Waiting participant left meeting before host joined** subscription enabled under the **Meeting** event.\n\n\n\n\n","operationId":"Meeting.participant_jbh_waiting_leftWebhook","requestBody":{"description":"Webhook payload for the `meeting.participant_jbh_waiting_left` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.participant_jbh_waiting_leftEvent"},"examples":{"default":{"summary":"Example meeting.participant_jbh_waiting_left event","value":{"event":"meeting.participant_jbh_waiting_left","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","id":1234567890,"host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":8,"start_time":"2021-07-13T21:44:51Z","duration":60,"timezone":"America/Los_Angeles","participant":{"id":"iFxeBPYun6SAiWUzBcEkX","user_name":"JillChill","customer_key":"349589LkJyeW","registrant_id":"abcdefghij0-klmnopq23456"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"user.tsp_created":{"post":{"tags":["TSP"],"summary":"user.tsp_created","description":"\nThe **A user's TSP account was created** event is triggered every time a [TSP user account is created](/api-reference/zoom-api/methods#operation/userTSPCreate) in Zoom.\n\nZoom allows certain carrier partners to provision Telephony Service Provider (TSP) audio to users. For users to use TSP audio, carrier partners must create a TSP user account with Zoom for the users.\n\n## Prerequisites\n\n* A Pro or higher plan with TSP Configurations enabled.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* The **A user's TSP account was created** subscription must be enabled under the **TSP** event.\n\n","operationId":"User.tsp_createdWebhook","requestBody":{"description":"Webhook payload for the `user.tsp_created` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User.tsp_createdEvent"},"examples":{"default":{"summary":"Example user.tsp_created event","value":{"event":"user.tsp_created","event_ts":1234566789900,"payload":{"account_id":"Mtgfdgfgd2lxiA","operator":"admin@example.com","operator_id":"DYdgdg64567g8w","object":{"tsp_credentials":{"id":"2","conference_code":"123456789","leader_pin":"123456","dial_in_numbers":[{"code":"1","number":"123456789","type":"toll"},{"code":"93","number":"980000021","type":"tollfree"},{"code":"1","number":"2222456532","type":"media_link"}]},"email":"jchill@example.com","id":"DYbbbbf7dPkkg8w"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.breakout_room_sharing_ended":{"post":{"tags":["Meetings"],"summary":"meeting.breakout_room_sharing_ended","description":"\nThe **User in breakout room stopped sharing** event is triggered when a user in a [breakout room](https://support.zoom.us/hc/en-us/articles/115005769646-Participating-in-breakout-rooms) ends their [content-sharing](https://support.zoom.us/hc/en-us/articles/201362153-Sharing-your-screen-or-desktop-on-Zoom), such as their desktop or the [classic whiteboard](https://support.zoom.us/hc/en-us/articles/205677665-Sharing-a-whiteboard).\n\nBreakout rooms are sessions that are split off from the main Zoom meeting. They allow the participants to meet in smaller groups and are completely isolated in terms of audio and video from the main session.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **User in breakout room stopped sharing** subscription enabled under the **Meeting** event.\n\n","operationId":"Meeting.breakout_room_sharing_endedWebhook","requestBody":{"description":"Webhook payload for the `meeting.breakout_room_sharing_ended` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.breakout_room_sharing_endedEvent"},"examples":{"default":{"summary":"Example meeting.breakout_room_sharing_ended event","value":{"event":"meeting.breakout_room_sharing_ended","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","breakout_room_uuid":"FkQbpP2UR028mDrwzEahqw==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":8,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"participant":{"user_id":"31228928","parent_user_id":"ABCDE12345","user_name":"JillChill","id":"iFxeBPYun6SAiWUzBcEkX","sharing_details":{"content":"application","link_source":"in_meeting","file_link":"","date_time":"2021-07-13T21:56:00Z","source":"dropbox"}}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.updated":{"post":{"tags":["Meetings"],"summary":"meeting.updated","description":"\nThe **Meeting has been updated** event is triggered when a meeting scheduled by one of your app users or account users is updated.\n\nMeeting hosts or users with admin privileges can update scheduled meetings. \n\nYou can update the meeting manually through the **Edit** feature in the [Zoom web portal](https://zoom.us) or the Zoom client, or programmatically update a meeting through the [**Update a meeting**](/docs/api-reference/zoom-api/methods#operation/meetingUpdate) API.\n\n## Prerequisites\n\n* A Pro or higher plan.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\t* A valid **Event Notification Endpoint URL**\n\t* The **Meeting has been updated** subscription enabled under the **Meeting** event.","operationId":"Meeting.updatedWebhook","requestBody":{"description":"Webhook payload for the `meeting.updated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.updatedEvent"},"examples":{"default":{"summary":"Example meeting.updated event","value":{"event":"meeting.updated","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"id":1234567890,"uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":8,"start_time":"2021-07-13T21:44:51Z","duration":60,"timezone":"America/Los_Angeles","join_url":"https://example.com/meeting","password":"XYz@BC!D1087","agenda":"Overview of Meeting Topics","registration_url":"https://example.com","occurrences":[{"occurrence_id":"ABCDE12345","start_time":"2021-07-13T21:44:51Z","duration":60,"status":"available"}],"settings":{"host_video":true,"jbh_time":5,"meeting_invitees":[{"email":"jchill@example.com"}],"language_interpretation":{"enable":true,"interpreters":[{"email":"interpreter@example.com","languages":"US,FR","interpreter_languages":"English,French"}]},"sign_language_interpretation":{"enable":true,"interpreters":[{"email":"interpreter@example.com","sign_language":"American"}]},"continuous_meeting_chat":{"enable":true,"auto_add_invited_external_users":false,"auto_add_meeting_participants":false,"channel_id":"cabc1234567defghijkl01234"},"auto_start_meeting_summary":true,"who_will_receive_summary":1,"auto_start_ai_companion_questions":true,"who_can_ask_questions":1,"summary_template_id":"1e1356ad","email_in_attendee_report":true,"allow_host_control_participant_mute_state":true,"prevent_screen_capture":true}},"old_object":{"id":1234567890,"settings":{"participant_video":false,"use_pmi":false,"disable_recording_control":"all","join_before_host":true,"jbh_time":0,"meeting_invitees":[{"email":"jchill@example.com"}],"language_interpretation":{"enable":true,"interpreters":[{"email":"interpreter@example.com","languages":"US,JP","interpreter_languages":"English,Japanese"}]},"sign_language_interpretation":{"enable":true,"interpreters":[{"email":"interpreter@example.com","sign_language":"American"}]},"continuous_meeting_chat":{"enable":true,"auto_add_invited_external_users":true,"auto_add_meeting_participants":true,"channel_id":"cabc1234567defghijkl01234"},"auto_start_meeting_summary":false,"email_in_attendee_report":false,"auto_start_ai_companion_questions":false,"summary_template_id":"87pkpo08","allow_host_control_participant_mute_state":false,"prevent_screen_capture":false}},"time_stamp":1724653728243}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.ai_companion_stopped":{"post":{"tags":["Meetings"],"summary":"meeting.ai_companion_stopped","description":"The **AI Companion stopped** event is triggered when a user stops the AI Companion during a live meeting.\n\n## Prerequisites\n\n* Host user must be on a Pro or higher plan.\n* Enable [AI Companion](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057623).\n* E2EE meetings do not support the AI Companion feature.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **AI Companion stopped** subscription enabled under the **Meeting** event.","operationId":"Meeting.ai_companion_stoppedWebhook","requestBody":{"description":"Webhook payload for the `meeting.ai_companion_stopped` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.ai_companion_stoppedEvent"},"examples":{"default":{"summary":"Example meeting.ai_companion_stopped event","value":{"event":"meeting.ai_companion_stopped","event_ts":1726142087123,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","object":{"meeting_number":97763643886,"meeting_uuid":"aDYlohsHRtCd4ii1uC2+hA==","host_id":"30R7kT7bTIKSNUFEuH_Qlg","ai_companion":{"summary":true}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.registration_denied":{"post":{"tags":["Meetings"],"summary":"meeting.registration_denied","description":"\nThe **Meeting Registration has been denied** event is triggered every time a registrant is denied from participating in a meeting.\n\nA host with the Pro user type can enable the **Registration** feature when scheduling or updating a meeting. By [enabling registration for meetings](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings), participants must fill out a registration form receive information about joining the meeting.\n\nA host can [manually reject](https://support.zoom.us/hc/en-us/articles/360054446052-Managing-meeting-and-webinar-registration#h_01ETX8CE45EG3YT8S9JM32EW3Y) registrant. Hosts can also programmatically reject attendees via the [**Update registrant's status**](/docs/api-reference/zoom-api/methods#operation/meetingRegistrantStatus) API.\n\n## Prerequisites\n\n* A Pro or a higher plan.\n* The meeting host should be a user on your account or a user of your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Meeting Registration has been denied** subscription enabled under the **Meeting** event.","operationId":"Meeting.registration_deniedWebhook","requestBody":{"description":"Webhook payload for the `meeting.registration_denied` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.registration_deniedEvent"},"examples":{"default":{"summary":"Example meeting.registration_denied event","value":{"event":"meeting.registration_denied","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","id":1234567890,"host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":8,"start_time":"2021-07-13T21:44:51Z","duration":60,"timezone":"America/Los_Angeles","occurrences":[{"occurrence_id":"ABCDE12345","start_time":"2021-07-13T21:44:51Z"}],"registrant":{"id":"iFxeBPYun6SAiWUzBcEkX","first_name":"Jill","last_name":"Chill","email":"jchill@example.com"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.registration_denied":{"post":{"tags":["Webinars"],"summary":"webinar.registration_denied","description":"\nThe **Webinar Registration has been denied** event is triggered every time one of your app users or account users denies a user's registration.\n\n[Scheduling a Webinar with registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires registrants to complete a brief form before receiving the link to join the Webinar.[Webinar Registration options](https://support.zoom.us/hc/en-us/articles/202835649-Webinar-Registration-Customization#h_b74e0e26-5f3f-40d4-a3de-949dbfd85882) can be customized by a Zoom admin or a Webinar host. This customization allows them to choose whether to approve attendees automatically or manually.\n\nWhen the registration is set to be approved manually, a pending registrant can be denied from joining the Webinar. To deny a registrant manually, navigate to your Webinars page and click on the name of the Webinar. Click **Edit** to the right of **Manage Attendees** option, select the user and click **Deny**. Alternatively, the registrant can be denied using the [**Update registrant's status**](/docs/api-reference/zoom-api/methods#operation/webinarRegistrantStatus) API.\n\n## Prerequisites\n* Pro or a higher plan with Webinar license.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Webinar Registration has been denied** subscription enabled under the **Webinar** event.\n\n","operationId":"Webinar.registration_deniedWebhook","requestBody":{"description":"Webhook payload for the `webinar.registration_denied` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.registration_deniedEvent"},"examples":{"default":{"summary":"Example webinar.registration_denied event","value":{"event":"webinar.registration_created","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","id":1234567890,"host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Webinar","type":9,"start_time":"2021-07-13T21:44:51Z","duration":60,"timezone":"America/Los_Angeles","occurrences":[{"occurrence_id":"ABCDE12345","start_time":"2021-07-13T21:44:51Z"}],"registrant":{"id":"iFxeBPYun6SAiWUzBcEkX","first_name":"Jill","last_name":"Chill","email":"jchill@example.com","tracking_source":{"id":"5516482804110","source_name":"general","tracking_url":"https://example.com/webinar/register/5516482804110/WN_juM2BGyLQMyQ_ZrqiGRhLg"}}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.registration_approved":{"post":{"tags":["Meetings"],"summary":"meeting.registration_approved","description":"\nThe **Meeting Registration has been approved** event is triggered every time a registrant is approved for the meeting. The meeting host should be a user on your account or a user of your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.\n\nA meeting host or a user with admin privileges can restrict meeting registrations by manually approving registrants. With the **Manually Approve** option enabled for [meeting registrations](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings), the host of the meeting must approve registrants before they receive information about how to join the meeting.\n\nMeeting hosts can approve an attendee's meeting invitation via the [Zoom web portal](https://zoom.us). To do this, navigate to the scheduled meeting's page and click **Edit** next to the **Manage Attendees** section. Select the attendee to approve in the **Pending Approval** section, then click **Approve**.\n\nTo programmatically approve an attendee's registration, use the [**Update registrant's status**](/docs/api-reference/zoom-api/methods#operation/meetingRegistrantStatus) API.\n\n## Prerequisites\n\n* A Pro or a higher plan.\n* Enable **Manual Approval** for [meeting registrations](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings).\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Meeting Registration has been approved** subscription enabled under the **Meeting** event.","operationId":"Meeting.registration_approvedWebhook","requestBody":{"description":"Webhook payload for the `meeting.registration_approved` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.registration_approvedEvent"},"examples":{"default":{"summary":"Example meeting.registration_approved event","value":{"event":"meeting.registration_approved","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","id":1234567890,"host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":8,"start_time":"2021-07-13T21:44:51Z","duration":60,"timezone":"America/Los_Angeles","occurrences":[{"occurrence_id":"ABCDE12345","start_time":"2021-07-13T21:44:51Z"}],"registrant":{"id":"iFxeBPYun6SAiWUzBcEkX","first_name":"Jill","last_name":"Chill","email":"jchill@example.com","join_url":"https://example.com","participant_pin_code":380303}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.participant_left":{"post":{"tags":["Webinars"],"summary":"webinar.participant_left","description":"\nThe **Participant/Host left webinar** event is triggered every time a host of a webinar or an attendee leaves the webinar. The host must be a user on your account or on other accounts that have installed your webhook-enabled app.\n\nZoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. [Zoom Video Webinar](https://support.zoom.us/hc/en-us/articles/200917029-Getting-Started-With-Webinar) allows users to broadcast a Zoom meeting to up to 1000 attendees.\n\n## Prerequisites\n\n* Pro or a higher plan with Webinar license.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Participant/Host left webinar** subscription enabled under the **Webinar** event.\n\n","operationId":"Webinar.participant_leftWebhook","requestBody":{"description":"Webhook payload for the `webinar.participant_left` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.participant_leftEvent"},"examples":{"default":{"summary":"Example webinar.participant_left event","value":{"event":"webinar.participant_left","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Webinar","type":9,"start_time":"2021-07-13T21:44:51Z","duration":60,"timezone":"America/Los_Angeles","participant":{"user_id":"1234567890","user_name":"Jill Chill","id":"iFxeBPYun6SAiWUzBcEkX","leave_time":"2021-07-13T22:50:51Z","leave_reason":"Jill Chill left the webinar.<br>Reason: Host ended the webinar.","email":"jchill@example.com","registrant_id":"abcdefghij0-klmnopq23456","participant_user_id":"rstuvwxyza789-cde","participant_uuid":"55555AAAiAAAAAiAiAiiAii","customer_key":"349589LkJyeW","phone_number":"8615250064084"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"recording.batch_deleted":{"post":{"tags":["Cloud Recording"],"summary":"recording.batch_deleted","description":"\nThe **Batch recording deleted** event is triggered every time one of your app users or account users permanently deletes one or more cloud recordings.\n\nWhen a user initially deletes a recording, it is sent to the trash. At this stage, the recording can still be recovered for up to 30 days after deletion. To permanently delete a recording, users must delete it from the trash.\n\nUsers can permanently delete a recording via the [**Delete meeting recordings**](/api-reference/zoom-api/ma#operation/recordingDelete) API with the `delete` query parameter or in the [Zoom web portal](https://support.zoom.us/hc/en-us/articles/205347605-Recording-Management).\n\n## Prerequisites\n\n* A Pro or higher plan.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n* A valid **Event Notification Endpoint URL**.\n* The **Recording files have been permanently deleted in batches** subscription enabled under the **Recording** event.\n\n","operationId":"Recording.batch_deletedWebhook","requestBody":{"description":"Webhook payload for the `recording.batch_deleted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recording.batch_deletedEvent"},"examples":{"default":{"summary":"Example recording.batch_deleted event","value":{"event":"recording.batch_deleted","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"I7zp-pYbTl22Z29H796Ixg","object":{"meetings":[{"meeting_uuid":"4444AAAiAAAAAiAiAiiAii==","recording_file_ids":["ed6c2f27-2ae7-42f4-b3d0-835b493e4fa8","388ffb46-1541-460d-8447-4624451a1db7"]}]}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.alert":{"post":{"tags":["Webinars"],"summary":"webinar.alert","description":"\nThe **Webinar issues alert** event is triggered every time a Webinar hosted by one of your app users or account users, encounters a service issue.\n\nZoom monitors the Webinar statistics in regard to the quality of service for each Webinar. An account owner or a user with admin permissions on a Business or higher plan can view these statistics via Dashboard. The following quality metrics can trigger an alert:\n\n* Unstable audio\n* Unstable video\n* Poor screen share quality\n* High CPU usage\n* Call reconnection problems\n\nTo receive notifications for this event, you must meet the following prerequisites.\n\n## Prerequisites\n\n*  Business or a higher plan.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Webinar issues alert** subscription enabled under the **Webinar** event.\n\n","operationId":"Webinar.alertWebhook","requestBody":{"description":"Webhook payload for the `webinar.alert` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.alertEvent"},"examples":{"default":{"summary":"Example webinar.alert event","value":{"event":"webinar.alert","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Webinar","type":2,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"issues":["Unstable audio quality"]}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.chat_message_sent":{"post":{"tags":["Webinars"],"summary":"webinar.chat_message_sent","description":"\nThe **In-webinar chat message received** event is triggered when a user sends a public or private chat message during a webinar using the [chat feature](https://support.zoom.us/hc/en-us/articles/205761999-Chatting-in-a-Zoom-Webinar). The event is sent to the configured endpoint in your Marketplace app.\n\n## Prerequisites\n* Have Zoom enable the DLP for in-meeting chat feature to use this webhook.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * Enable the **In-webinar chat message received** subscription under the **Webinar** event category.\n* This feature is **only** enabled upon request approval. Contact the [Zoom support team](https://support.zoom.us/hc/en-us/articles/201362003) for more information.","operationId":"Webinar.chat_message_sentWebhook","requestBody":{"description":"Webhook payload for the `webinar.chat_message_sent` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.chat_message_sentEvent"},"examples":{"default":{"summary":"Example webinar.chat_message_sent event","value":{"event":"webinar.chat_message_sent","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":1234567890,"uuid":"4444AAAiAAAAAiAiAiiAii==","breakout_room_uuid":"FkQbpP2UR028mDrwzEahqw==","chat_message":{"date_time":"GMT20220110-072010","sender_session_id":"26219520","sender_name":"Jill Chill","sender_email":"dlp.user@example.com","sender_type":"host","sender_context":"webinar","recipient_session_id":"38681600","recipient_name":"John Smith","recipient_type":"everyone","recipient_context":"breakout_room","message_id":"MS17MDQ5NjE4QjYtRjk4Ny00REEwLUFBQUItMTg3QTY0RjU2MzhFfQ==","message_content":"This is a test message","file_ids":["MS17RDk0QTY3QUQtQkFGQy04QTJFLTI2RUEtNkYxQjRBRTU1MTk5fQ==","MS17NDQ0OEU5MjMtM0JFOS1CMDA1LTQ0NDAtQjdGOTU0Rjk5MTkyfQ=="]}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.chat_message_file_sent":{"post":{"tags":["Webinars"],"summary":"webinar.chat_message_file_sent","description":"The **In-webinar chat message file received** event is triggered when a message file of a webinar is available to view or download. The event is sent to the configured endpoint in your Marketplace app.\n\n## Prerequisites\n\n* Have Zoom enable the DLP for in-meeting chat feature to use this webhook.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * Enable the **In-webinar chat message file received** subscription under the **Webinar** event category.\n* This feature is **only** enabled upon request approval. Contact the [Zoom support team](https://support.zoom.us/hc/en-us/articles/201362003) for more information.","operationId":"Webinar.chat_message_file_sentWebhook","requestBody":{"description":"Webhook payload for the `webinar.chat_message_file_sent` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.chat_message_file_sentEvent"},"examples":{"default":{"summary":"Example webinar.chat_message_file_sent event","value":{"event":"webinar.chat_message_file_sent","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"webinar_id":1234567890,"webinar_uuid":"4444AAAiAAAAAiAiAiiAii==","breakout_room_uuid":"FkQbpP2UR028mDrwzEahqw==","chat_message_file":{"date_time":"GMT20220110-072010","sender_session_id":"26219520","sender_name":"Jill Chill","sender_email":"dlp.user@example.com","sender_type":"host","sender_context":"webinar","recipient_session_id":"38681600","recipient_name":"John Smith","recipient_email":"guest.user@example","recipient_type":"guest","recipient_context":"webinar","message_id":"MS17MDQ5NjE4QjYtRjk4Ny00REEwLUFBQUItMTg3QTY0RjU2MzhFfQ==","file_id":"MS17RDk0QTY3QUQtQkFGQy04QTJFLTI2RUEtNkYxQjRBRTU1MTk5fQ==","file_name":"example.jpg","file_size":3966,"file_type":"jpg","download_url":"https://file.zoomdev.us/file/hsdAXySKRe2KgS-0YNeSXg/attach/format/plain?decryptType=1&filename=example.jpg&jwt=eyJhbGciOiJIUzI1NiJ9.eyJkaWciOiI3Yzg5YzBhYjIzYmZmMjdjNzE3NTQ4YzdjMTc0Njk3MWYzYjNmNjFjMzU5OTliNjE1ZjdjMWJmMzc5YTJiZThlIiwiYXVkIjoiZmlsZSIsImlzcyI6ImNyb3NzZmlsZSIsImV4cCI6MTY0ODI2NDY5N30.2fQxw3F1cEhvFJmnE2zPOdkHnPeZUktv_P0M--e-Tg8&mode=play"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.ended":{"post":{"tags":["Meetings"],"summary":"meeting.ended","description":"\nThe **End Meeting** event is triggered every time a meeting host ends the meeting. The host must be a user in your account or a user in any other accounts that have installed your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **End Meeting** subscription enabled under the **Meeting** event.","operationId":"Meeting.endedWebhook","requestBody":{"description":"Webhook payload for the `meeting.ended` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.endedEvent"},"examples":{"default":{"summary":"Example meeting.ended event","value":{"event":"meeting.ended","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","host_email":"jchill@example.com","topic":"My Meeting","type":3,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"end_time":"2021-07-13T23:00:51Z"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.participant_joined_breakout_room":{"post":{"tags":["Meetings"],"summary":"meeting.participant_joined_breakout_room","description":"\nThe **Meeting participant has joined a breakout room** event is triggered when a meeting participant joins a meeting [breakout room](https://support.zoom.us/hc/en-us/articles/115005769646-Participating-in-breakout-rooms).\n\nBreakout rooms are sessions that are split off from the main Zoom meeting. They let participants meet in smaller groups and are completely isolated in terms of audio and video from the main session.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Meeting participant has joined a breakout room** subscription enabled under the **Meeting** event.\n\n","operationId":"Meeting.participant_joined_breakout_roomWebhook","requestBody":{"description":"Webhook payload for the `meeting.participant_joined_breakout_room` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.participant_joined_breakout_roomEvent"},"examples":{"default":{"summary":"Example meeting.participant_joined_breakout_room event","value":{"event":"meeting.participant_joined_breakout_room","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","breakout_room_uuid":"FkQbpP2UR028mDrwzEahqw==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":8,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"participant":{"user_id":"31228928","parent_user_id":"1234567890","user_name":"Jill Chill","id":"iFxeBPYun6SAiWUzBcEkX","participant_uuid":"55555AAAiAAAAAiAiAiiAii","date_time":"2021-07-13T21:44:51Z","email":"jchill@example.com","registrant_id":"abcdefghij0-klmnopq23456","participant_user_id":"rstuvwxyza789-cde","phone_number":"8615250064084","customer_key":"349589LkJyeW"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.participant_left_waiting_room":{"post":{"tags":["Meetings"],"summary":"meeting.participant_left_waiting_room","description":"\nThe **Participant left a waiting room** event is triggered every time a meeting host **does not** admit a participant to the meeting and **removes** the participant from the waiting room. This event also triggers if a participant leaves the waiting room. The meeting host must be a user in your account or a user in any other accounts that have installed your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.\n\nThe [**waiting room**](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) feature allows the host to control when participants join a meeting. When a participant attempts to join a meeting with this feature enabled, the participant is first admitted to the waiting room.\nThe meeting host can then admit attendees one by one or hold all attendees in the waiting room and admit them all at once.\n\n## Prerequisites\n\n* The [**waiting room**](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) feature enabled for the meeting.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The \"**Participant left a waiting room**\" subscription must be enabled under the **Meeting** event.\n\n\n\n","operationId":"Meeting.participant_left_waiting_roomWebhook","requestBody":{"description":"Webhook payload for the `meeting.participant_left_waiting_room` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.participant_left_waiting_roomEvent"},"examples":{"default":{"summary":"Example meeting.participant_left_waiting_room event","value":{"event":"meeting.participant_left_waiting_room","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":8,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"participant":{"user_id":"1234567890","user_name":"Jill Chill","id":"iFxeBPYun6SAiWUzBcEkX","participant_uuid":"55555AAAiAAAAAiAiAiiAii","date_time":"2021-07-13T21:44:51Z","email":"jchill@example.com","phone_number":"8615250064084","participant_user_id":"iFxeBPYun6SAiWUzBcEkX","customer_key":"349589LkJyeW","registrant_id":"abcdefghij0-klmnopq23456"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.started":{"post":{"tags":["Meetings"],"summary":"meeting.started","description":"\nThe **Start Meeting** event is triggered every time a meeting host starts a meeting. The meeting host must either be a user on your account or a user of your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.\n\nA meeting host can [start a meeting](https://support.zoom.us/hc/en-us/articles/201362423-How-do-I-Start-or-Join-a-Scheduled-Meeting-as-the-Host-) from the Zoom desktop client for Mac, PC or Linux, the Zoom app for Android or iOS, a web browser, or an H.323 or SIP device.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Start Meeting** subscription enabled under the **Meeting** event.","operationId":"Meeting.startedWebhook","requestBody":{"description":"Webhook payload for the `meeting.started` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.startedEvent"},"examples":{"default":{"summary":"Example meeting.started event","value":{"event":"meeting.started","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","host_email":"jchill@example.com","topic":"My Meeting","type":8,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.registration_cancelled":{"post":{"tags":["Meetings"],"summary":"meeting.registration_cancelled","description":"\nThe **Meeting Registration has been canceled** event is triggered every time a registration is canceled for a meeting. The meeting host should be a user on your account or a user of your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.\n\nA host with the Pro user type can enable the **Registration** feature when scheduling or updating a meeting. By [enabling registration for meetings](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings), participants must fill out a registration form receive information about joining the meeting.\n\nMeeting attendees can cancel their registration at any time. A meeting host can also cancel an attendee's meeting invitation via the [Zoom web portal](https://zoom.us). To do this, navigate to the scheduled meeting's page and click **Edit** next to the **Manage Attendees** section. The **Approved** section will display all approved attendees. Select the attendee whose meeting registration you want to revoke and click **Cancel Registration**.\n\nTo programmatically cancel a registration, use the [**Update registrant's status**](/docs/api-reference/zoom-api/methods#operation/meetingRegistrantStatus) API.\n\n## Prerequisites\n\n* A Pro or a higher plan.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Meeting Registration has been canceled** subscription enabled under the **Meeting** event.","operationId":"Meeting.registration_cancelledWebhook","requestBody":{"description":"Webhook payload for the `meeting.registration_cancelled` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.registration_cancelledEvent"},"examples":{"default":{"summary":"Example meeting.registration_cancelled event","value":{"event":"meeting.registration_cancelled","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","id":1234567890,"host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":8,"start_time":"2021-07-13T21:44:51Z","duration":60,"timezone":"America/Los_Angeles","occurrences":[{"occurrence_id":"ABCDE12345","start_time":"2021-07-13T21:44:51Z"}],"registrant":{"id":"iFxeBPYun6SAiWUzBcEkX","first_name":"Jill","last_name":"Chill","email":"jchill@example.com"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.summary_completed":{"post":{"tags":["Meetings"],"summary":"meeting.summary_completed","description":"\nThe **Meeting summary has been completed** event is triggered every time the summary of the meeting is made available for one of your app users or account users after the summarized meeting/webinar ends.\n\n## Prerequisites\n\n* Host user must be Pro or higher plan.\n* Enable the **Meeting Summary with AI Companion** feature in the host's account.\n* E2ee meetings do not have summary feature enabled.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Meeting summary have completed** subscription enabled under the **Meeting** event.","operationId":"Meeting.summary_completedWebhook","requestBody":{"description":"Webhook payload for the `meeting.summary_completed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.summary_completedEvent"},"examples":{"default":{"summary":"Example meeting.summary_completed event","value":{"event":"meeting.summary_completed","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","object":{"meeting_host_id":"30R7kT7bTIKSNUFEuH_Qlg","meeting_host_email":"jchill@example.com","meeting_uuid":"aDYlohsHRtCd4ii1uC2+hA==","meeting_id":97763643886,"meeting_topic":"My Meeting","meeting_start_time":"2019-07-15T23:24:52Z","meeting_end_time":"2020-07-15T23:30:19Z","summary_start_time":"2019-07-15T23:24:52Z","summary_end_time":"2020-07-15T23:30:19Z","summary_created_time":"2019-07-15T23:24:52Z","summary_last_modified_time":"2020-07-15T23:30:19Z","summary_title":"Meeting Summary for my meeting","summary_overview":"Meeting Overview","summary_details":[{"label":"Meeting Overview","summary":"Meeting Overview"}],"next_steps":["step1"],"summary_content":"## Key takeaways\n- Mobile app performance issues are affecting user retention.\n- New onboarding flow received positive feedback from beta testers.\n- Need to prioritize accessibility improvements.\n- Customer support response time has improved by 25%.\n\n## Discussed topics\n### Mobile App Performance\nDiscussion of recent performance metrics and user complaints\n- **Details**\n    - Sarah (Product): Reports of app crashes increased 15% this month\n    - Mike (Engineering): Memory optimization needed in latest release\n    - Tom (QA): Identified memory leak in photo upload feature\n- **Conclusion**\n    - Implement performance monitoring tools\n    - Prioritize memory optimization in next sprint\n\n### Onboarding Flow\nReview of beta testing results for new user onboarding\n- **Details**\n    - Rachel (UX): 90% completion rate in beta testing\n    - David (Product): Positive feedback on simplified registration\n- **Conclusion**\n    - Ready for full rollout next month\n    - Need to monitor analytics post-launch\n\n### Accessibility Compliance\nDiscussion of current accessibility status and needed improvements\n- **Details**\n    - Lisa (Design): Screen reader compatibility issues identified\n    - John (Engineering): WCAG compliance at 80%\n- **Conclusion**\n    - Create accessibility improvement roadmap\n    - Schedule external audit\n\n## Challenges\n* Resource constraints for performance optimization\n* Integration testing environment stability issues\n* Lack of accessibility expertise in the team\n\n## Action items\n- **Sarah**\n  - Prepare performance monitoring implementation plan\n  - Schedule follow-up meeting with engineering team\n- **Mike**\n  - Investigate memory leak fix\n  - Document performance optimization guidelines\n- **Lisa**\n  - Create accessibility improvement proposal\n  - Research accessibility testing tools\n- **Rachel**\n  - Prepare onboarding analytics dashboard\n  - Document beta testing findings","summary_doc_url":"https://docs.example.com/doc/1aBcDeFgHiJkLmNoPqRsTu"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.participant_left":{"post":{"tags":["Meetings"],"summary":"meeting.participant_left","description":"\nThe **Participant/Host left meeting** event is triggered every time an attendee leaves a meeting. A meeting attendee is a meeting participant or the host. The meeting host must be a user in your account or a user in any other accounts that have installed your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with these configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Participant/Host left meeting** subscription enabled under the **Meeting** event.\n\n","operationId":"Meeting.participant_leftWebhook","requestBody":{"description":"Webhook payload for the `meeting.participant_left` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.participant_leftEvent"},"examples":{"default":{"summary":"Example meeting.participant_left event","value":{"event":"meeting.participant_left","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":8,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"participant":{"user_id":"1234567890","user_name":"Jill Chill","id":"iFxeBPYun6SAiWUzBcEkX","participant_uuid":"55555AAAiAAAAAiAiAiiAii","leave_time":"2021-07-13T22:50:51Z","leave_reason":"Jill Chill left the meeting.<br>Reason: Host ended the meeting.","date_time":"2021-07-13T21:44:51Z","email":"jchill@example.com","registrant_id":"abcdefghij0-klmnopq23456","participant_user_id":"rstuvwxyza789-cde","customer_key":"349589LkJyeW","phone_number":"8615250064084"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.participant_phone_callout_rejected":{"post":{"tags":["Meetings"],"summary":"meeting.participant_phone_callout_rejected","description":"\nThe **Invited party rejected a meeting invitation through phone (call out)** event is triggered every time a user rejects an invitation to [join a meeting through phone (call out)](https://support.zoom.us/hc/en-us/articles/4404535651085).\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with these configurations.\n* A valid **Event Notification Endpoint URL**.\n* The **Invited party rejected a meeting invitation through phone (call out)** subscription enabled under the **Meeting** event.\n\n","operationId":"Meeting.participant_phone_callout_rejectedWebhook","requestBody":{"description":"Webhook payload for the `meeting.participant_phone_callout_rejected` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.participant_phone_callout_rejectedEvent"},"examples":{"default":{"summary":"Example meeting.participant_phone_callout_rejected event","value":{"event":"meeting.participant_phone_callout_rejected","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","object":{"id":713592696,"uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"ICuPoX4ERtikRcKqkVxunQ","participant":{"invitee_name":"Jill Chill","phone_number":1800000000}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.participant_phone_callout_accepted":{"post":{"tags":["Meetings"],"summary":"meeting.participant_phone_callout_accepted","description":"\nThe **Invited party answered a meeting invitation through phone (call out)** event is triggered every time a user accepts an invitation to [join a meeting through phone (call out)](https://support.zoom.us/hc/en-us/articles/4404535651085).\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with these configurations.\n* A valid **Event Notification Endpoint URL**.\n* The **Invited party answered a meeting invitation through phone (call out)** subscription enabled under the **Meeting** event.\n\n","operationId":"Meeting.participant_phone_callout_acceptedWebhook","requestBody":{"description":"Webhook payload for the `meeting.participant_phone_callout_accepted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.participant_phone_callout_acceptedEvent"},"examples":{"default":{"summary":"Example meeting.participant_phone_callout_accepted event","value":{"event":"meeting.participant_phone_callout_accepted","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","object":{"id":713592696,"uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"ICuPoX4ERtikRcKqkVxunQ","participant":{"invitee_name":"Jill Chill","phone_number":1800000000}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.sharing_started":{"post":{"tags":["Webinars"],"summary":"webinar.sharing_started","description":"\nThe **Webinar Sharing Started** event is triggered every time one of your app users or account users share their screen during a Webinar.\n\nZoom supports [screen sharing](https://support.zoom.us/hc/en-us/articles/201362153-Screen-Sharing-and-Annotations) by host or panelists on desktop, tablet and mobile devices running Zoom during Webinars.\n\n## Prerequisites\n\n* Pro or a higher plan with Webinar license.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Webinar Sharing Started** subscription enabled under the **Meeting** event.\n\n","operationId":"Webinar.sharing_startedWebhook","requestBody":{"description":"Webhook payload for the `webinar.sharing_started` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.sharing_startedEvent"},"examples":{"default":{"summary":"Example webinar.sharing_started event","value":{"event":"webinar.sharing_started","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Webinar","type":9,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"participant":{"user_id":"ABCDE12345","user_name":"JillChill","id":"iFxeBPYun6SAiWUzBcEkX","sharing_details":{"content":"application","link_source":"in_meeting","file_link":"","date_time":"2021-07-13T21:55:52Z","source":"dropbox"}}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.registration_created":{"post":{"tags":["Meetings"],"summary":"meeting.registration_created","description":"\nThe **Meeting Registration has been created** event is triggered every time a user [registers](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings) for a meeting.\n\nA host with the Pro user type can enable the **Registration** feature when scheduling or updating a meeting. By [enabling registration for meetings](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings), participants must fill out a registration form receive information about joining the meeting. You can also programmatically register a participant via the [**Add Meeting Registrant**](/docs/api-reference/zoom-api/methods#operation/meetingRegistrantCreate) API.\n\n## Prerequisites\n\n* A Pro or a higher plan.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Meeting Registration has been created** subscription enabled under the **Meeting** event.","operationId":"Meeting.registration_createdWebhook","requestBody":{"description":"Webhook payload for the `meeting.registration_created` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.registration_createdEvent"},"examples":{"default":{"summary":"Example meeting.registration_created event","value":{"event":"meeting.registration_created","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","id":1234567890,"host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":8,"start_time":"2021-07-13T21:44:51Z","duration":60,"timezone":"America/Los_Angeles","occurrences":[{"occurrence_id":"ABCDE12345","start_time":"2021-07-13T21:44:51Z"}],"registrant":{"id":"iFxeBPYun6SAiWUzBcEkX","first_name":"Jill","last_name":"Chill","email":"jchill@example.com","address":"1800 Amphibious Blvd.","city":"Mountain View","country":"US","zip":"94045","state":"CA","phone":"5550100","industry":"Food","org":"Cooking Org","job_title":"Chef","purchasing_time_frame":"1-3 months","role_in_purchase_process":"Influencer","no_of_employees":"1-20","comments":"Looking forward to the meeting","custom_questions":[{"title":"What do you hope to learn from this meeting?","value":"Look forward to learning how you come up with new recipes and what other services you offer."}],"status":"approved","join_url":"https://example.com/join","participant_pin_code":380303}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"recording.recovered":{"post":{"tags":["Cloud Recording"],"summary":"recording.recovered","description":"\nThis event is triggered when a user recovers a recording from the trash.\n\nZoom allows users to recover their cloud recordings from the trash within 30 days of deletion. You can recover a deleted cloud recording via the [**Recordings**](https://support.zoom.us/hc/en-us/articles/216378863-Recover-a-Deleted-Cloud-Recording) tab in the Zoom web client or via the [**Recover meeting recordings**](/api-reference/zoom-api/ma#operation/recordingStatusUpdate) API.\n\n## Prerequisites\n\n* A Pro or a higher plan.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Recording files have been recovered from trash** subscription enabled under the **Recording** event.\n\n","operationId":"Recording.recoveredWebhook","requestBody":{"description":"Webhook payload for the `recording.recovered` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recording.recoveredEvent"},"examples":{"default":{"summary":"Example recording.recovered event","value":{"event":"recording.recovered","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"I7zp-pYbTl22Z29H796Ixg","object":{"id":1234567890,"uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Personal Recording","type":4,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"share_url":"https://example.com","total_size":3328371,"recording_count":2,"recording_files":[{"id":"ed6c2f27-2ae7-42f4-b3d0-835b493e4fa8","meeting_id":"098765ABCD","recording_start":"2021-03-23T22:14:57Z","recording_end":"2021-03-23T23:15:41Z","file_type":"M4A","file_size":246560,"play_url":"https://example.com/recording/play/Qg75t7xZBtEbAkjdlgbfdngBBBB","download_url":"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngBBBB","status":"completed","recording_type":"audio_only"},{"id":"388ffb46-1541-460d-8447-4624451a1db7","meeting_id":"098765ABCD","recording_start":"2021-03-23T22:14:57Z","recording_end":"2021-03-23T23:15:41Z","file_type":"MP4","file_size":282825,"play_url":"https://example.com/recording/play/Qg75t7xZBtEbAkjdlgbfdngCCCC","download_url":"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngCCCC","status":"completed","recording_type":"shared_screen_with_speaker_view"}],"participant_audio_files":[{"id":"ed6c2f27-2ae7-42f4-b3d0-835b493e4fa8","recording_start":"2021-03-23T22:14:57Z","recording_end":"2021-03-23T23:15:41Z","recording_type":"audio_only","file_type":"M4A","file_name":"MyRecording","file_size":246560,"file_extension":"MP4","play_url":"https://example.com/recording/play/Qg75t7xZBtEbAkjdlgbfdngAAAA","download_url":"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngAAAA","status":"completed"}]}},"download_token":"abJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJodHRwczovL2V2ZW50Lnpvb20udXMiLCJhY2NvdW50SWQiOiJNdDZzdjR1MFRBeVBrd2dzTDJseGlBIiwiYXVkIjoiaHR0cHM6Ly9vYXV0aC56b29tLnVzIiwibWlkIjoieFp3SEc0c3BRU2VuekdZWG16dnpiUT09IiwiZXhwIjoxNjI2MTM5NTA3LCJ1c2VySWQiOiJEWUhyZHBqclMzdWFPZjdkUGtrZzh3In0.a6KetiC6BlkDhf1dP4KBGUE1bb2brMeraoD45yhFx0eSSSTFdkHQnsKmlJQ-hdo9Zy-4vQw3rOxlyoHv583JyZ"}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.sharing_ended":{"post":{"tags":["Meetings"],"summary":"meeting.sharing_ended","description":"\nThe **Meeting Sharing Ended** event is triggered every time an attendee or a host stops sharing their screen during a Zoom meeting. The meeting host must be a user in your account or a user in any other accounts that have installed your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.\n\nZoom allows [screen sharing](https://support.zoom.us/hc/en-us/articles/201362153-Screen-Sharing-and-Annotations) by host and attendees on desktop, tablet, and mobile devices running Zoom during meetings.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Meeting Sharing Ended** subscription enabled under the **Meeting** event.","operationId":"Meeting.sharing_endedWebhook","requestBody":{"description":"Webhook payload for the `meeting.sharing_ended` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.sharing_endedEvent"},"examples":{"default":{"summary":"Example meeting.sharing_ended event","value":{"event":"meeting.sharing_ended","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":8,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"participant":{"user_id":"ABCDE12345","user_name":"JillChill","id":"iFxeBPYun6SAiWUzBcEkX","sharing_details":{"content":"application","link_source":"in_meeting","file_link":"","date_time":"2021-07-13T21:56:00Z","source":"dropbox"}}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"recording.cloud_storage_usage_updated":{"post":{"tags":["Cloud Recording"],"summary":"recording.cloud_storage_usage_updated","description":"\nThe **Recording Cloud Storage Usage Updated** event is triggered every time storage usage changes.\n\nStates such as recording completed, trashed, or recovered trigger this event.\n\n## Prerequisites\n\n* A Pro or higher plan.\n* Enable Cloud recording on the users' account.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Recording Cloud Storage Usage Updated** subscription enabled under the **Recording** event.\n\n","operationId":"Recording.cloud_storage_usage_updatedWebhook","requestBody":{"description":"Webhook payload for the `recording.cloud_storage_usage_updated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recording.cloud_storage_usage_updatedEvent"},"examples":{"default":{"summary":"Example recording.cloud_storage_usage_updated event","value":{"event":"recording.cloud_storage_usage_updated","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"free_storage":"1.65 GB","plan_storage":"40 GB","plan_type":"cmr_monthly_commitment_40","storage_used":"1.65 GB","storage_used_percentage":80,"storage_exceed":"0","max_exceed_date":"2023-03-01"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"recording.transcript_completed":{"post":{"tags":["Cloud Recording"],"summary":"recording.transcript_completed","description":"\nThe **Recording transcript files have completed** event is triggered every time the transcript of the recording is made available for one of your app users or account users after the recorded meeting/webinar ends.\n\nZoom supports audio transcription of cloud recordings. To utilize audio transcription, users must first [enable](https://support.zoom.us/hc/en-us/articles/115004794983-Automatically-Transcribe-Cloud-Recordings) it. An account owner or a user with admin permissions can enable cloud recording for an account or a group of users.\n\n## Prerequisites\n\n* A Business, Education, or Enterprise license.\n* Cloud recording must be enabled on the users' account.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Recording transcript files have completed** subscription enabled under the **Recording** event.\n\n","operationId":"Recording.transcript_completedWebhook","requestBody":{"description":"Webhook payload for the `recording.transcript_completed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recording.transcript_completedEvent"},"examples":{"default":{"summary":"Example recording.transcript_completed event","value":{"event":"recording.transcript_completed","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":1234567890,"uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","account_id":"x1yCzABCDEfg23HiJKl4mN","host_email":"jchill@example.com","topic":"My Personal Recording","type":4,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","password":"123456","duration":60,"share_url":"https://example.com","total_size":529758,"recording_count":1,"recording_files":[{"id":"ed6c2f27-2ae7-42f4-b3d0-835b493e4fa8","meeting_id":"098765ABCD","recording_start":"2021-03-23T22:14:57Z","recording_end":"2021-03-23T23:15:41Z","file_type":"TRANSCRIPT","file_size":142,"play_url":"https://example.com/recording/play/Qg75t7xZBtEbAkjdlgbfdngBBBB","download_url":"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngBBBB","status":"completed","recording_type":"audio_transcript"}]}},"download_token":"abJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJodHRwczovL2V2ZW50Lnpvb20udXMiLCJhY2NvdW50SWQiOiJNdDZzdjR1MFRBeVBrd2dzTDJseGlBIiwiYXVkIjoiaHR0cHM6Ly9vYXV0aC56b29tLnVzIiwibWlkIjoieFp3SEc0c3BRU2VuekdZWG16dnpiUT09IiwiZXhwIjoxNjI2MTM5NTA3LCJ1c2VySWQiOiJEWUhyZHBqclMzdWFPZjdkUGtrZzh3In0.a6KetiC6BlkDhf1dP4KBGUE1bb2brMeraoD45yhFx0eSSSTFdkHQnsKmlJQ-hdo9Zy-4vQw3rOxlyoHv583JyZ"}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"recording.stopped":{"post":{"tags":["Cloud Recording"],"summary":"recording.stopped","description":"\nThe **Recording Stopped** event is triggered every time a recording is stopped by one of your app's users or account users.\n\nAll users with a Pro or a higher plan have access to [cloud recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording). An account owner or account admin can [enable cloud recording](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording#h_29fc1846-190d-4f05-ab23-1070c8106ec8) for all account members as well as for members that belong to a certain group. Users can also enable cloud recordings [for their own use](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording#h_4cca2458-cbd5-4439-933c-57c0d62a2753).\n\nOnly a host or a co-host of the meeting/webinar can start, pause, resume, or stop a [cloud recording](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording).\n\n## Prerequisites\n\n* A Pro or higher plan.\n* Cloud recording must be enabled on the users' account.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Recording Stopped** subscription must be enabled under the **Recording** event.\n\n","operationId":"Recording.stoppedWebhook","requestBody":{"description":"Webhook payload for the `recording.stopped` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recording.stoppedEvent"},"examples":{"default":{"summary":"Example recording.stopped event","value":{"event":"recording.stopped","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":1234567890,"uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Personal Recording","type":4,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"recording_file":{"recording_start":"2021-03-23T22:14:57Z","recording_end":"2021-03-23T23:15:41Z"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"recording.batch_trashed":{"post":{"tags":["Cloud Recording"],"summary":"recording.batch_trashed","description":"\nThe **All recording files have been deleted to the Trash** event is triggered every time one of your app users or account users temporarily delete all of their cloud recordings.\n\nWhen a user initially deletes recordings, the recordings are sent to the trash. Users can delete a recording temporarily via the [**Delete meeting recordings**](/api-reference/zoom-api/ma#operation/recordingDelete) API or via the [**Zoom web client**](https://support.zoom.us/hc/en-us/articles/205347605-Recording-Management). At this point, recordings can be recovered up to 30 days after deletion.\n\n## Prerequisites\n\n* Pro or a higher plan.\n* Cloud recording must be enabled on the users' account.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n  * A valid **Event Notification Endpoint URL**.\n  * The **All recording files have been deleted to the Trash** subscription must be enabled under the **Recording** event.\n\n","operationId":"Recording.batch_trashedWebhook","requestBody":{"description":"Webhook payload for the `recording.batch_trashed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recording.batch_trashedEvent"},"examples":{"default":{"summary":"Example recording.batch_trashed event","value":{"event":"recording.batch_trashed","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"I7zp-pYbTl22Z29H796Ixg","operation":"trash_user_recordings","object":{"meeting_uuids":["atsXxhSEQWit9t+U02HXNQ==","3KvSP3SHRvyalrGRqZ5+2w=="]}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.started":{"post":{"tags":["Webinars"],"summary":"webinar.started","description":"\nThe **Start Webinar** event is triggered every time a user in your account or your app starts a webinar.\n\nZoom users with a [Webinar Plan](https://zoom.us/webinar) have permissions for creating and managing webinars. [Zoom Video Webinar](https://support.zoom.us/hc/en-us/articles/200917029-Getting-Started-With-Webinar) allows users to broadcast a Zoom meeting to up to 1000 attendees. A webinar host can [start a webinar](https://support.zoom.us/hc/en-us/articles/200917029-Getting-Started-With-Webinar#h_816c5048-c9d3-4930-894d-af63cd41de3d) from the Zoom Client or from the [Zoom Web Portal](https://zoom.us).\n\n## Prerequisites\n\n* Pro or a higher plan with Webinar license.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Start Webinar** subscription enabled under the **Webinar** event.","operationId":"Webinar.startedWebhook","requestBody":{"description":"Webhook payload for the `webinar.started` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.startedEvent"},"examples":{"default":{"summary":"Example webinar.started event","value":{"event":"webinar.started","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","host_email":"jchill@example.com","topic":"My Webinar","type":9,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.chat_message_file_downloaded":{"post":{"tags":["Meetings"],"summary":"meeting.chat_message_file_downloaded","description":"The **In-meeting chat message file has been downloaded** event is triggered when a meeting's message file is downloaded. The event is sent to the configured endpoint in your Marketplace app.\n\n## Prerequisites\n\n* Have Zoom enable the DLP for in-meeting chat feature to use this webhook.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * Enable the **In-meeting chat message file has been downloaded** subscription under the **Meeting** event category.\n\nThis feature is **only** enabled upon request approval. Contact the [Zoom support team](https://support.zoom.us/hc/en-us/articles/201362003) for more information.","operationId":"Meeting.chat_message_file_downloadedWebhook","requestBody":{"description":"Webhook payload for the `meeting.chat_message_file_downloaded` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.chat_message_file_downloadedEvent"},"examples":{"default":{"summary":"Example meeting.chat_message_file_downloaded event","value":{"event":"meeting.chat_message_file_downloaded","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"user@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"id":1234567890,"uuid":"4444AAAiAAAAAiAiAiiAii==","host_account_id":"lmnop12345abcdefghijk","chat_message_file":{"file_id":"MS17RDk0QTY3QUQtQkFGQy04QTJFLTI2RUEtNkYxQjRBRTU1MTk5fQ==","file_name":"example.jpg","file_owner_id":"rw3dIsBRTpOyMOJmeKgdaQ","file_size":3966,"file_type":"jpg"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.sharing_ended":{"post":{"tags":["Webinars"],"summary":"webinar.sharing_ended","description":"\nThe **Webinar Sharing Ended** event is triggered every time one of your app users or account users stop sharing their screen during a Webinar.\n\nZoom supports [screen sharing](https://support.zoom.us/hc/en-us/articles/201362153-Screen-Sharing-and-Annotations) by host or panelists on desktop, tablet and mobile devices running Zoom during webinars.\n\n## Prerequisites\n\n* Pro or a higher plan with Webinar license.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Webinar Sharing Ended** subscription enabled under the **Webinar** event.\n\n","operationId":"Webinar.sharing_endedWebhook","requestBody":{"description":"Webhook payload for the `webinar.sharing_ended` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.sharing_endedEvent"},"examples":{"default":{"summary":"Example webinar.sharing_ended event","value":{"event":"webinar.sharing_ended","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Webinar","type":9,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"participant":{"user_id":"ABCDE12345","user_name":"JillChill","sharing_details":{"content":"application","link_source":"in_meeting","file_link":"","date_time":"2021-07-13T21:56:00Z","source":"dropbox"}}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.summary_trashed":{"post":{"tags":["Meetings"],"summary":"meeting.summary_trashed","description":"\nThe **Meeting summary has been deleted to trash** event is triggered every time one of your app users or account users temporarily deletes a meeting summary.\n\n## Prerequisites\n\n* Host user must be Pro or higher plan.\n* Enable the **Meeting Summary with AI Companion** feature in the host's account.\n* E2ee meetings do not have summary feature enabled.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Meeting summary has been deleted to trash** subscription enabled under the **Meeting** event.","operationId":"Meeting.summary_trashedWebhook","requestBody":{"description":"Webhook payload for the `meeting.summary_trashed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.summary_trashedEvent"},"examples":{"default":{"summary":"Example meeting.summary_trashed event","value":{"event":"meeting.summary_trashed","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"meeting_host_id":"30R7kT7bTIKSNUFEuH_Qlg","meeting_host_email":"jchill@example.com","meeting_uuid":"aDYlohsHRtCd4ii1uC2+hA==","meeting_id":97763643886,"meeting_topic":"My Meeting","meeting_start_time":"2019-07-15T23:24:52Z","meeting_end_time":"2020-07-15T23:30:19Z","summary_start_time":"2019-07-15T23:24:52Z","summary_end_time":"2020-07-15T23:30:19Z","summary_created_time":"2019-07-15T23:24:52Z","summary_last_modified_time":"2020-07-15T23:30:19Z","summary_title":"Meeting Summary for my meeting"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.sharing_started":{"post":{"tags":["Meetings"],"summary":"meeting.sharing_started","description":"\nThe **Meeting Sharing Started** event is triggered every time an attendee or a host begins sharing their screen during a Zoom meeting. The meeting host must be a user in your account or a user in any other accounts that have installed your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.\n\nZoom allows [screen sharing](https://support.zoom.us/hc/en-us/articles/201362153-Screen-Sharing-and-Annotations) by host and attendees on desktop, tablet, and mobile devices running Zoom during meetings.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Meeting Sharing Started** subscription enabled under the **Meeting** event.","operationId":"Meeting.sharing_startedWebhook","requestBody":{"description":"Webhook payload for the `meeting.sharing_started` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.sharing_startedEvent"},"examples":{"default":{"summary":"Example meeting.sharing_started event","value":{"event":"meeting.sharing_started","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":8,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"participant":{"user_id":"ABCDE12345","user_name":"JillChill","id":"iFxeBPYun6SAiWUzBcEkX","sharing_details":{"content":"application","link_source":"in_meeting","file_link":"","date_time":"2021-07-13T21:55:52Z","source":"dropbox"}}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.registration_created":{"post":{"tags":["Webinars"],"summary":"webinar.registration_created","description":"\nThe **Webinar Registration has been created** event is triggered every time someone registers for a Webinar created by one of your app users or account users.\n\nZoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. [Zoom Video Webinar](https://support.zoom.us/hc/en-us/articles/200917029-Getting-Started-With-Webinar) allows users to broadcast a Zoom meeting to up to 1000 attendees. [Scheduling a Webinar with registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form before receiving the link to join the Webinar.\n\n## Prerequisites\n\n* Pro or a higher plan with Webinar license.\n* **Event Subscriptions** must be enabled for your [Marketplace App](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event notification endpoint URL**\n\t* The **Webinar Registration has been created** subscription enabled under the **Meeting** event.\n\n","operationId":"Webinar.registration_createdWebhook","requestBody":{"description":"Webhook payload for the `webinar.registration_created` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.registration_createdEvent"},"examples":{"default":{"summary":"Example webinar.registration_created event","value":{"event":"webinar.registration_created","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","id":1234567890,"host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Webinar","type":9,"start_time":"2021-07-13T21:44:51Z","duration":60,"timezone":"America/Los_Angeles","occurrences":[{"occurrence_id":"ABCDE12345","start_time":"2021-07-13T21:44:51Z"}],"registrant":{"id":"iFxeBPYun6SAiWUzBcEkX","first_name":"Jill","last_name":"Chill","email":"jchill@example.com","address":"1800 Amphibious Blvd.","city":"Mountain View","country":"US","zip":"94045","state":"CA","phone":"5550100","industry":"Food","org":"Cooking Org","job_title":"Chef","purchasing_time_frame":"1-3 months","role_in_purchase_process":"Influencer","no_of_employees":"1-20","comments":"Looking forward to the Webinar","custom_questions":[{"title":"What do you hope to learn from this Webinar?","value":"Look forward to learning how you come up with new recipes and what other services you offer."}],"status":"approved","join_url":"https://example.com","tracking_source":{"id":"5516482804110","source_name":"general","tracking_url":"https://example.com/webinar/register/5516482804110/WN_juM2BGyLQMyQ_ZrqiGRhLg"}}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.chat_message_sent":{"post":{"tags":["Meetings"],"summary":"meeting.chat_message_sent","description":"\nThe **In-meeting chat message received** event is triggered when a user sends a public or private chat message during a meeting using the [in-meeting Zoom chat feature](https://support.zoom.us/hc/en-us/articles/203650445-Chatting-in-a-Zoom-meeting). The event is sent to the configured endpoint in your Marketplace app.\n\n## Prerequisites\n\n* Enable the **Enable in-meeting chat DLP (Data Loss Prevention) integration** feature in the host's account.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **In-meeting chat message received** subscription enabled under the **Meeting** event.\n* This feature is **only** enabled upon request approval. Contact the [Zoom support team](https://support.zoom.com/hc/en/contact?id=contact_us) for more information.","operationId":"Meeting.chat_message_sentWebhook","requestBody":{"description":"Webhook payload for the `meeting.chat_message_sent` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.chat_message_sentEvent"},"examples":{"default":{"summary":"Example meeting.chat_message_sent event","value":{"event":"meeting.chat_message_sent","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":1234567890,"uuid":"4444AAAiAAAAAiAiAiiAii==","breakout_room_uuid":"FkQbpP2UR028mDrwzEahqw==","chat_message":{"date_time":"GMT20220110-072010","sender_session_id":"26219520","sender_name":"Jill Chill","sender_email":"dlp.user@example.com","sender_type":"host","sender_context":"meeting","recipient_session_id":"38681600","recipient_name":"John Smith","recipient_email":"guest.user@example","recipient_type":"guest","recipient_context":"waiting_room","message_id":"MS17MDQ5NjE4QjYtRjk4Ny00REEwLUFBQUItMTg3QTY0RjU2MzhFfQ==","message_content":"This is a test message","file_ids":["MS17RDk0QTY3QUQtQkFGQy04QTJFLTI2RUEtNkYxQjRBRTU1MTk5fQ==","MS17NDQ0OEU5MjMtM0JFOS1CMDA1LTQ0NDAtQjdGOTU0Rjk5MTkyfQ=="]}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.invitation_rejected":{"post":{"tags":["Meetings"],"summary":"meeting.invitation_rejected","description":"\nThe **Invited party rejected a meeting invite** event is triggered every time a user sends an invitation to join a meeting or video call to one or more recipients.\n\nThis event is only suitable for triggering with the ZOOM client.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with these configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Invited party rejected a meeting invite** subscription enabled under the **Meeting** event.\n\n","operationId":"Meeting.invitation_rejectedWebhook","requestBody":{"description":"Webhook payload for the `meeting.invitation_rejected` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.invitation_rejectedEvent"},"examples":{"default":{"summary":"Example meeting.invitation_rejected event","value":{"event":"meeting.invitation_rejected","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","operator_id":"Hy7YgA-cR4eU8EfWV00tPQ","operator":"dhill@example.com","object":{"id":"91578204824","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"ICuPoX4ERtikRcKqkVxunQ","topic":"Jill Chill's Zoom Meeting","participant":{"participant_user_id":"rPwsQrpC6gPuw2zEJqw","email":"jchill@example.com"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.participant_role_changed":{"post":{"tags":["Meetings"],"summary":"meeting.participant_role_changed","description":"\nThe **Participant role changed** event is triggered every time a host or meeting attendee changes their [role](https://support.zoom.us/hc/en-us/articles/360040324512-Roles-in-a-meeting) during the meeting. A meeting host must be a user in your account or a user in any other accounts that have installed your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Participant role changed** subscription enabled under the **Meeting** event.\n\n","operationId":"Meeting.participant_role_changedWebhook","requestBody":{"description":"Webhook payload for the `meeting.participant_role_changed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.participant_role_changedEvent"},"examples":{"default":{"summary":"Example meeting.participant_role_changed event","value":{"event":"meeting.participant_role_changed","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":8,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"participant":{"user_id":"1234567890","participant_uuid":"55555AAAiAAAAAiAiAiiAii","user_name":"JillChill","email":"jchill@example.com","registrant_id":"abcdefghij0-klmnopq23456","participant_user_id":"rstuvwxyza789-cde","date_time":"2021-07-13T21:44:51Z","old_role":"host","new_role":"co-host"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.permanently_deleted":{"post":{"tags":["Meetings"],"summary":"meeting.permanently_deleted","description":"\nThe **Meeting has been permanently deleted** event is triggered every time a meeting scheduled by one of your app users or account users, is permanently deleted.\n\nA meeting host or a user with admin privileges [permanently delete a meeting](https://support.zoom.us/hc/en-us/articles/360048488451-Deleting-local-or-cloud-recordings#h_b35c92a6-ec9e-4025-ab77-f0b52168aed2) via the [Zoom web portal](https://zoom.us). You can also programmatically delete a meet via the [**Delete a meeting**](/docs/api-reference/zoom-api/methods#operation/meetingDelete) API.\n\n## Prerequisites\n\n* A Pro or higher plan.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Meeting has been permanently deleted** subscription enabled under the **Meeting** event.","operationId":"Meeting.permanently_deletedWebhook","requestBody":{"description":"Webhook payload for the `meeting.permanently_deleted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.permanently_deletedEvent"},"examples":{"default":{"summary":"Example meeting.permanently_deleted event","value":{"event":"meeting.permanently_deleted","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","operation":"single","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","id":1234567890,"host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":8,"start_time":"2021-07-13T21:44:51Z","duration":60,"timezone":"America/Los_Angeles","occurrences":[{"occurrence_id":"ABCDE12345","start_time":"2021-07-13T21:44:51Z"}]}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"recording.registration_created":{"post":{"tags":["Cloud Recording"],"summary":"recording.registration_created","description":"\nThe **View registrant has registered for this recording** event is triggered every time a user registers for an on-demand cloud recording.\n\n[Cloud recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording) of Zoom meetings and webinars can be made [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings). With on-demand recordings, users can view the recordings of past meetings and webinars at any time as long as they have not been removed. To view cloud recordings, users can register manually by filling out the registration form that pops up when users click on the **Recording URL**.\n\nUsers can also be programmatically registered via the [**Create a recording registrant**](/api-reference/zoom-api/ma#operation/meetingRecordingRegistrantCreate) API.\nOnce they complete the registration they can view the recording.\n\n## Prerequisites\n\n* A Pro or higher plan.\n* Cloud recording must be enabled on the users' account.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **View registrant has registered for this recording** subscription enabled under the **Recording** event.\n\n","operationId":"Recording.registration_createdWebhook","requestBody":{"description":"Webhook payload for the `recording.registration_created` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recording.registration_createdEvent"},"examples":{"default":{"summary":"Example recording.registration_created event","value":{"event":"recording.registration_created","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":1234567890,"uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Personal Recording","type":4,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"occurrences":{"occurrence_id":"ABCDE12345","start_time":"2021-07-13T21:44:51Z"},"registrant":{"id":"iFxeBPYun6SAiWUzBcEkX","email":"jchill@example.com","first_name":"Jill","last_name":"Chill","address":"1800 Amphibious Blvd.","city":"Mountain View","country":"US","zip":"94045","state":"CA","phone":"5550100","industry":"Food","org":"Cooking Org","job_title":"Chef","purchasing_time_frame":"1-3 months","role_in_purchase_process":"Influencer","no_of_employees":"1-20","comments":"Looking forward to the Webinar","custom_questions":[{"title":"What do you hope to learn from this Webinar?","value":"Look forward to learning how you come up with new recipes and what other services you offer."}],"status":"approved"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.created":{"post":{"tags":["Meetings"],"summary":"meeting.created","description":"\nThe **Meeting has been created** event is triggered every time a meeting is created by one of your app users or account users.\n\nZoom offers multiple methods for users to schedule new meetings. Users can manually create meetings through the Zoom client or the [Zoom web portal](https://zoom.us/). Users can also programmatically create meetings through the [**Create a meeting**](/docs/api/rest/reference/zoom-api/methods/#operation/meetingCreate) API.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n* A valid **Event Notification Endpoint URL**.\n* The **Meeting has been created** subscription enabled under the **Meeting** event.","operationId":"Meeting.createdWebhook","requestBody":{"description":"Webhook payload for the `meeting.created` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.createdEvent"},"examples":{"default":{"summary":"Example meeting.created event","value":{"event":"meeting.created","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","operation":"single","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","id":1234567890,"host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":8,"start_time":"2021-07-13T21:44:51Z","duration":60,"timezone":"America/Los_Angeles","join_url":"https://example.com","password":"XYz@BC!D1087","pmi":"ABc$DE@F234","creation_source":"open_api","occurrences":[{"occurrence_id":"ABCDE12345","start_time":"2021-07-13T21:44:51Z","duration":60,"status":"available"}],"settings":{"use_pmi":true,"alternative_hosts":"althost1@example.com;althost2@example.com","meeting_invitees":[{"email":"jchill@example.com"}],"join_before_host":true,"jbh_time":10},"recurrence":{"type":1,"repeat_interval":2,"end_times":5}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.live_streaming_started":{"post":{"tags":["Meetings"],"summary":"meeting.live_streaming_started","description":"\nThe **Meeting Live Streaming Started** event is triggered every time a meeting's live stream begins on a streaming platform. The host that begins the live stream must be a user in your account or a user in any other accounts that have installed your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.\n\nZoom lets users live stream their Zoom meetings on [YouTube Live](https://support.zoom.us/hc/en-us/articles/360028478292-Streaming-a-Meeting-or-Webinar-on-YouTube-Live), [Facebook](https://support.zoom.us/hc/en-us/articles/115000350406-Streaming-a-meeting-or-webinar-on-Facebook-Live), [Workplace by Facebook](https://support.zoom.us/hc/en-us/articles/115005460286-Live-Stream-Meetings-or-Webinars-on-Workplace-by-Facebook), and via a [custom live streaming services](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service).\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Meeting Live Streaming Started** subscription enabled under the **Meeting** event.","operationId":"Meeting.live_streaming_startedWebhook","requestBody":{"description":"Webhook payload for the `meeting.live_streaming_started` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.live_streaming_startedEvent"},"examples":{"default":{"summary":"Example meeting.live_streaming_started event","value":{"event":"meeting.live_streaming_started","event_ts":1627906965803,"payload":{"account_id":"D8cJuqWVQ623CI4Q8yQK0Q","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"id":1234567890,"uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":2,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"live_streaming":{"service":"Custom_Live_Streaming_Service","custom_live_streaming_settings":{"stream_url":"https://example.com/livestream","stream_key":"ABCDEFG12345HIJ6789","page_url":"https://example.com/livestream/123","resolution":"1080p"},"date_time":"2021-08-02T12:22:45Z"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.participant_room_system_callout_accepted":{"post":{"tags":["Meetings"],"summary":"meeting.participant_room_system_callout_accepted","description":"\nThe **Invited party answered a meeting invitation through phone (call out) via Zoom room** event is triggered every time a user [joins a meeting through phone (call out) from a Zoom room](https://support.zoom.us/hc/en-us/articles/205369035).\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n* A valid **Event Notification Endpoint URL**.\n* The **Invited party answered a meeting invitation through phone (call out) via Zoom room** subscription enabled under the **Meeting** event.\n\n","operationId":"Meeting.participant_room_system_callout_acceptedWebhook","requestBody":{"description":"Webhook payload for the `meeting.participant_room_system_callout_accepted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.participant_room_system_callout_acceptedEvent"},"examples":{"default":{"summary":"Example meeting.participant_room_system_callout_accepted event","value":{"event":"meeting.participant_room_system_callout_accepted","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","object":{"id":713592696,"uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"ICuPoX4ERtikRcKqkVxunQ","message_id":"atsXxhSEQWit9t+U02HXNQ==","inviter_name":"Jill Chill","participant":{"call_type":"h323","device_ip":"10.100.111.237"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.registration_approved":{"post":{"tags":["Webinars"],"summary":"webinar.registration_approved","description":"\nThe **Webinar Registration has been approved** event is triggered every time one of your app users or account users approve a user's registration.\n\n[Scheduling a Webinar with registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires registrants to complete a brief form before receiving the link to join a Webinar. [Webinar Registration options](https://support.zoom.us/hc/en-us/articles/202835649-Webinar-Registration-Customization#h_b74e0e26-5f3f-40d4-a3de-949dbfd85882) can be customized by a Zoom admin or a Webinar host. This customization allows them to choose whether to approve attendees automatically or manually.\n\nWhen the registration is set to be approved manually, a pending registrant can either be approved or denied from joining the Webinar.\n\nTo approve a registrant manually, navigate to the [Webinars](https://zoom.us/webinar/list) page and click on the name of the webinar. Click **Edit** to the right of **Manage Attendees** option, select the registrant and click **Approve**. Alternatively, use the [**Update registrant's status**](/docs/api-reference/zoom-api/methods#operation/webinarRegistrantStatus) API to approve the registrant programmatically.\n\n## Prerequisites\n\n* Pro or a higher plan with Webinar license.\n* **Manual Approval** enabled for [Webinar Registrations](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings).\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**\n\t* The **Webinar Registration has been approved** subscription enabled under the **Webinar** event.\n\n","operationId":"Webinar.registration_approvedWebhook","requestBody":{"description":"Webhook payload for the `webinar.registration_approved` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.registration_approvedEvent"},"examples":{"default":{"summary":"Example webinar.registration_approved event","value":{"event":"webinar.registration_approved","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","id":1234567890,"host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Webinar","type":9,"start_time":"2021-07-13T21:44:51Z","duration":60,"timezone":"America/Los_Angeles","occurrences":[{"occurrence_id":"ABCDE12345","start_time":"2021-07-13T21:44:51Z"}],"registrant":{"id":"iFxeBPYun6SAiWUzBcEkX","first_name":"Jill","last_name":"Chill","email":"jchill@example.com","join_url":"https://example.com","tracking_source":{"id":"5516482804110","source_name":"general","tracking_url":"https://example.com/webinar/register/5516482804110/WN_juM2BGyLQMyQ_ZrqiGRhLg"}}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.breakout_room_sharing_started":{"post":{"tags":["Meetings"],"summary":"meeting.breakout_room_sharing_started","description":"\nThe **User in breakout room started sharing** event is triggered when a user in a [breakout room](https://support.zoom.us/hc/en-us/articles/115005769646-Participating-in-breakout-rooms) begins [sharing content](https://support.zoom.us/hc/en-us/articles/201362153-Sharing-your-screen-or-desktop-on-Zoom), such as their desktop or the [classic whiteboard](https://support.zoom.us/hc/en-us/articles/205677665-Sharing-a-whiteboard).\n\nBreakout rooms are sessions that are split off from the main Zoom meeting. They allow the participants to meet in smaller groups and are completely isolated in terms of audio and video from the main session.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **User in breakout room started sharing** subscription enabled under the **Meeting** event.\n\n","operationId":"Meeting.breakout_room_sharing_startedWebhook","requestBody":{"description":"Webhook payload for the `meeting.breakout_room_sharing_started` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.breakout_room_sharing_startedEvent"},"examples":{"default":{"summary":"Example meeting.breakout_room_sharing_started event","value":{"event":"meeting.breakout_room_sharing_started","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","breakout_room_uuid":"FkQbpP2UR028mDrwzEahqw==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":8,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"participant":{"user_id":"31228928","parent_user_id":"ABCDE12345","user_name":"JillChill","id":"iFxeBPYun6SAiWUzBcEkX","sharing_details":{"content":"application","link_source":"in_meeting","file_link":"","date_time":"2021-07-13T21:55:52Z","source":"dropbox"}}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.participant_bind":{"post":{"tags":["Meetings"],"summary":"meeting.participant_bind","description":"The **Phone User Bind To Participant** event is triggered every time a phone user joins a meeting and binds to an attendee in the meeting. \n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n\t* The **Phone User Bind To Partcipant** subscription enabled under the **Meeting** event.\n","operationId":"Meeting.participant_bindWebhook","requestBody":{"description":"Webhook payload for the `meeting.participant_bind` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.participant_bindEvent"},"examples":{"default":{"summary":"Example meeting.participant_bind event","value":{"event":"meeting.participant_bind","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":8,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"participant":{"user_id":"1234567890","bind_user_id":"16778240","user_name":"Jill Chill","id":"iFxeBPYun6SAiWUzBcEkX","participant_uuid":"55555AAAiAAAAAiAiAiiAii","bind_participant_uuid":"B8E2844F-F162-4808-A997-F267BCE8B0BB","date_time":"2021-07-13T21:44:51Z","registrant_id":"abcdefghij0-klmnopq23456","phone_number":"8615250064084","join_time":"2021-07-13T21:44:51Z"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.participant_feedback":{"post":{"tags":["Meetings"],"summary":"meeting.participant_feedback","description":"\nThe **Get participant survey feedback for meetings** event is triggered every time an attendee completes an [end-of-meeting experience feedback survey](https://support.zoom.us/hc/en-us/articles/115005855266-End-of-meeting-experience-feedback-survey) for a meeting. A meeting attendee is a meeting participant or the host.\n\n## Prerequisites\n\n* Enable the **Display end-of-meeting experience feedback survey** feature in the attendee's Settings page.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Get participant survey feedback for meetings** subscription enabled under the **Meeting** event.","operationId":"Meeting.participant_feedbackWebhook","requestBody":{"description":"Webhook payload for the `meeting.participant_feedback` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.participant_feedbackEvent"},"examples":{"default":{"summary":"Example meeting.participant_feedback event","value":{"event":"meeting.participant_feedback","event_ts":1626230691572,"payload":{"account_id":"q6gBJVO5TzexKYTb_I2rpg","object":{"id":"7357282288","uuid":"0AErJTQBTI2bSXKyAxIq5A==","participant":{"participant_uuid":"I2rpg_q6gBJVO5TzexKYTb","participant_user_id":"zJKyaiAyTNC-MWjiWC18KQ","user_name":"jchill","feedback":{"satisfied":true,"rating_quality":{"type":"2-point","quality":"GOOD"},"feedback_details":[{"id":"2","name":"Poor audio quality"}],"comments":"good enough"},"zoom_room_id":"4pdH6BrsQ1uQUU3xVpBRCA","zoom_room_platform":"Android","zoom_room_sender_email":"user@example.com"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"recording.deleted":{"post":{"tags":["Cloud Recording"],"summary":"recording.deleted","description":"\nThis event is triggered when a user permanently deletes a cloud recording.\n\nWhen a user initially deletes a recording, it is sent to the trash. At this stage, the recording can still be recovered for up to 30 days after deletion. To permanently delete a recording, users must delete it from the trash.\n\nUsers can permanently delete a recording via the [**Delete meeting recordings**](/api-reference/zoom-api/ma#operation/recordingDelete) API with the `delete` query parameter or in the [Zoom web portal](https://support.zoom.us/hc/en-us/articles/205347605-Recording-Management).\n\n## Prerequisites\n\n* A Pro or higher plan.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Recording files have been permanently deleted** subscription enabled under the **Recording** event.\n\n","operationId":"Recording.deletedWebhook","requestBody":{"description":"Webhook payload for the `recording.deleted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recording.deletedEvent"},"examples":{"default":{"summary":"Example recording.deleted event","value":{"event":"recording.deleted","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"I7zp-pYbTl22Z29H796Ixg","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","id":1234567890,"host_id":"x1yCzABCDEfg23HiJKl4mN","account_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Personal Recording","type":4,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"share_url":"https://example.com","total_size":3328371,"recording_count":2,"recording_files":[{"id":"ed6c2f27-2ae7-42f4-b3d0-835b493e4fa8","meeting_id":"098765ABCD","recording_start":"2021-03-23T22:14:57Z","recording_end":"2021-03-23T23:15:41Z","file_type":"M4A","file_size":246560,"play_url":"https://example.com/recording/play/Qg75t7xZBtEbAkjdlgbfdngBBBB","download_url":"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngBBBB","status":"completed","recording_type":"audio_only"},{"id":"388ffb46-1541-460d-8447-4624451a1db7","meeting_id":"098765ABCD","recording_start":"2021-03-23T22:14:57Z","recording_end":"2021-03-23T23:15:41Z","file_type":"MP4","file_size":282825,"play_url":"https://example.com/recording/play/Qg75t7xZBtEbAkjdlgbfdngCCCC","download_url":"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngCCCC","status":"completed","recording_type":"shared_screen_with_speaker_view"}],"participant_audio_files":[{"id":"GF6c2f27-2ae7-42f4-b3d0-835b493e4fa8","recording_start":"2021-03-23T22:14:57Z","recording_end":"2021-03-23T23:15:41Z","file_type":"M4A","file_size":246560,"play_url":"https://example.com/recording/play/Qg75t7xZBtEbAkjdlgbfdngBBBB","download_url":"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngBBBB","status":"completed","recording_type":"audio_only"}]}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"recording.paused":{"post":{"tags":["Cloud Recording"],"summary":"recording.paused","description":"\nThe **Recording Paused** event is triggered every time a recording is paused by one of your app's users or account users.\n\nAll users with a Pro or a higher plan have access to [cloud recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording). An account owner or account admin can [enable cloud recording](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording#h_29fc1846-190d-4f05-ab23-1070c8106ec8) for all account members as well as for members that belong to a certain group. Users can also enable cloud recordings [for their own use](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording#h_4cca2458-cbd5-4439-933c-57c0d62a2753).\n\nOnly a host or a co-host of the meeting/webinar can start, pause, resume or stop a [cloud recording](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording).\n\n## Prerequisites\n\n* A Pro or a higher plan.\n* Cloud recording must be enabled on the users' account.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Recording Paused** subscription must be enabled under the **Recording** event.\n\n","operationId":"Recording.pausedWebhook","requestBody":{"description":"Webhook payload for the `recording.paused` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recording.pausedEvent"},"examples":{"default":{"summary":"Example recording.paused event","value":{"event":"recording.paused","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":1234567890,"uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Personal Recording","type":4,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"recording_file":{"recording_start":"2021-03-23T22:14:57Z","recording_end":"2021-03-23T23:15:41Z"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.participant_room_system_callout_ringing":{"post":{"tags":["Meetings"],"summary":"meeting.participant_room_system_callout_ringing","description":"\nThe **Invited party's phone (call out) ringing in Zoom room** event is triggered every time a user's phone is ringing when they were invited to [join a meeting through phone (call out) from a Zoom room](https://support.zoom.us/hc/en-us/articles/205369035).\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n* A valid **Event Notification Endpoint URL**.\n* The **Invited party's phone (call out) ringing in Zoom room** subscription enabled under the **Meeting** event.\n\n","operationId":"Meeting.participant_room_system_callout_ringingWebhook","requestBody":{"description":"Webhook payload for the `meeting.participant_room_system_callout_ringing` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.participant_room_system_callout_ringingEvent"},"examples":{"default":{"summary":"Example meeting.participant_room_system_callout_ringing event","value":{"event":"meeting.participant_room_system_callout_ringing","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","object":{"id":713592696,"uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"ICuPoX4ERtikRcKqkVxunQ","message_id":"atsXxhSEQWit9t+U02HXNQ==","inviter_name":"Jill Chill","participant":{"call_type":"h323","device_ip":"10.100.111.237"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"recording.started":{"post":{"tags":["Cloud Recording"],"summary":"recording.started","description":"\nThe **Recording Started** event is triggered every time a recording is started by one of your app users or account users.\n\nAll users with a Pro or a higher plan have access to [cloud recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording). An account owner or account admin can [enable cloud recording](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording#h_29fc1846-190d-4f05-ab23-1070c8106ec8) for all account members as well as for members that belong to a certain group. Users can also enable cloud recordings [for their own use](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording#h_4cca2458-cbd5-4439-933c-57c0d62a2753).\n\nOnly a host or a co-host of the meeting/webinar can [start cloud recording](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording#h_7420acb5-1897-4061-87b4-5b76e99c03b4) of the meeting/webinar.\n\n## Prerequisites\n\n* A Pro or higher plan.\n* Cloud recording must be enabled on the users' account.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Recording Started** subscription must be enabled under the **Recording** event.\n\n","operationId":"Recording.startedWebhook","requestBody":{"description":"Webhook payload for the `recording.started` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recording.startedEvent"},"examples":{"default":{"summary":"Example recording.started event","value":{"event":"recording.started","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":1234567890,"uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Personal Recording","type":4,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"recording_file":{"recording_start":"2021-03-23T22:14:57Z","recording_end":""}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"user.tsp_updated":{"post":{"tags":["TSP"],"summary":"user.tsp_updated","description":"\nThe **A user's TSP account was updated** event is triggered every time a [user's TSP account information is updated](/api-reference/zoom-api/methods#operation/userTSPUpdate).\n\nZoom allows certain carrier partners to provision Telephony Service Provider (TSP) audio to users. For users to use TSP audio, carrier partners must create a TSP user account with Zoom for the users.\n\n## Prerequisites\n\n* A Pro or higher plan with TSP Configurations enabled.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* The **A user's TSP account was updated** subscription must be enabled under the **TSP** event.\n\n","operationId":"User.tsp_updatedWebhook","requestBody":{"description":"Webhook payload for the `user.tsp_updated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User.tsp_updatedEvent"},"examples":{"default":{"summary":"Example user.tsp_updated event","value":{"event":"user.tsp_updated","event_ts":1234566789900,"payload":{"account_id":"Mtgfdgfgd2lxiA","operator":"admin@example.com","operator_id":"DYdgdg64567g8w","object":{"id":"DYbbbbf7dPkkg8w","email":"jchill@example.com","tsp_credentials":{"conference_code":"0125","leader_pin":"11189898","dial_in_numbers":[{"code":"1","number":"+1 1000200200","type":"tollfree"}],"tsp_bridge":"US_TSP_TB"}},"old_object":{"conference_code":"0130","leader_pin":"11188124","dial_in_numbers":[{"code":"2","number":"+355 18899996875","type":"toll"}],"tsp_bridge":""}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.invitation_timeout":{"post":{"tags":["Meetings"],"summary":"meeting.invitation_timeout","description":"\nThe **Invited party missed a meeting invitation** event is triggered every time an invitation to join a meeting or video call to one or more recipients times out.\n\nThis event is only suitable for triggering with the ZOOM client.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Invited party missed a meeting invitation** subscription enabled under the **Meeting** event.\n\n\n\n","operationId":"Meeting.invitation_timeoutWebhook","requestBody":{"description":"Webhook payload for the `meeting.invitation_timeout` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.invitation_timeoutEvent"},"examples":{"default":{"summary":"Example meeting.invitation_timeout event","value":{"event":"meeting.invitation_timeout","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","operator_id":"Hy7YgA-cR4eU8EfWV00tPQ","operator":"dhill@example.com","object":{"id":"91578204824","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"ICuPoX4ERtikRcKqkVxunQ","topic":"Jill Chill's Zoom Meeting","participant":{"participant_user_id":"rPwsQrpC6gPuw2zEJqw","email":"jchill@example.com"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.participant_admitted":{"post":{"tags":["Meetings"],"summary":"meeting.participant_admitted","description":"\nThe **Participant was admitted into a meeting** event is triggered every time [a meeting host admits the participant from a waiting room to the meeting](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room#h_f493a86f-7d08-4e3b-9d6d-9b236fe9cdcd). The meeting host must be a user in your account or a user in any other accounts that have installed your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.\n\nWhen a participant joins a [waiting room](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room), the meeting host is notified in the Zoom client. The host has the option to admit the participant to the meeting or remove the participant from the waiting room and the meeting.\n\n## Prerequisites\n\n* Enable the [**waiting room**](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) feature for the meeting.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Participant was admitted into a meeting** subscription must be enabled under the **Meeting** event.\n\n\n\n","operationId":"Meeting.participant_admittedWebhook","requestBody":{"description":"Webhook payload for the `meeting.participant_admitted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.participant_admittedEvent"},"examples":{"default":{"summary":"Example meeting.participant_admitted event","value":{"event":"meeting.participant_admitted","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","operation":"single","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":2,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"participant":{"user_id":"1234567890","user_name":"Jill Chill","id":"iFxeBPYun6SAiWUzBcEkX","participant_uuid":"55555AAAiAAAAAiAiAiiAii","date_time":"2021-07-13T21:44:51Z","email":"jchill@example.com","customer_key":"349589LkJyeW","registrant_id":"abcdefghij0-klmnopq23456"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.participant_room_system_callout_failed":{"post":{"tags":["Meetings"],"summary":"meeting.participant_room_system_callout_failed","description":"\nThe **Meeting invitation through phone (call out) via Zoom room failed** event is triggered every time an invitation to [join a meeting through phone (call out) from a Zoom room](https://support.zoom.us/hc/en-us/articles/205369035) fails.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n* A valid **Event Notification Endpoint URL**.\n* The **Meeting invitation through phone (call out) via Zoom room failed** subscription enabled under the **Meeting** event.\n\n","operationId":"Meeting.participant_room_system_callout_failedWebhook","requestBody":{"description":"Webhook payload for the `meeting.participant_room_system_callout_failed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.participant_room_system_callout_failedEvent"},"examples":{"default":{"summary":"Example meeting.participant_room_system_callout_failed event","value":{"event":"meeting.participant_room_system_callout_failed","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","object":{"id":713592696,"uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"ICuPoX4ERtikRcKqkVxunQ","message_id":"atsXxhSEQWit9t+U02HXNQ==","inviter_name":"Jill Chill","reason_type":1,"participant":{"call_type":"h323","device_ip":"10.100.111.237"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.participant_data_connection_established":{"post":{"tags":["Meetings"],"summary":"meeting.participant_data_connection_established","description":"\nThe **Participant or Host connection established** event is triggered every time an attendee establishes a data connection when joining a meeting.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Participant or Host connection established** subscription enabled under the **Meeting** event.","operationId":"Meeting.participant_data_connection_establishedWebhook","requestBody":{"description":"Webhook payload for the `meeting.participant_data_connection_established` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.participant_data_connection_establishedEvent"},"examples":{"default":{"summary":"Example meeting.participant_data_connection_established event","value":{"event":"meeting.participant_data_connection_established","event_ts":1779673098888,"payload":{"account_id":"WTpQ2Q_rSKm0-eGZtyakog","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":8,"start_time":"2026-07-05T21:42:51Z","participant":{"user_id":"1234567890","user_name":"Jill Chill","customer_key":"349589LkJyeW","participant_uuid":"55555AAAiAAAAAiAiAiiAii","join_time":"2026-07-05T21:44:51Z","email":"jchill@example.com","registrant_id":"abcdefghij0-klmnopq23456","participant_user_id":"rstuvwxyza789-cde","phone_number":"8611111111111"},"data_connections":[{"connection_type":"audio","total_time_cost_ms":820,"command_connection_time_cost_ms":140,"data_socket_time_cost_ms":310,"first_package_time_cost_ms":370},{"connection_type":"video","total_time_cost_ms":1540,"command_connection_time_cost_ms":260,"data_socket_time_cost_ms":720,"first_package_time_cost_ms":560},{"connection_type":"screen_share","total_time_cost_ms":2015,"command_connection_time_cost_ms":305,"data_socket_time_cost_ms":980,"first_package_time_cost_ms":730}]}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"recording.resumed":{"post":{"tags":["Cloud Recording"],"summary":"recording.resumed","description":"\nThe **Recording Resumed** event is triggered every time a previously paused recording of a meeting or webinar is resumed.\n\nAll users with a Pro or a higher plan have access to [cloud recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording). An account owner or account admin can [enable cloud recording](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording#h_29fc1846-190d-4f05-ab23-1070c8106ec8) for all account members as well as for members that belong to a certain group. Users can also enable cloud recordings [for their own use](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording#h_4cca2458-cbd5-4439-933c-57c0d62a2753). \n\nOnly a host or a co-host of the meeting/webinar can start, pause, resume, and stop a [cloud recording](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording). A host/co-host can resume a paused recording of a meeting or a webinar.\n\n## Prerequisites\n\n* A Pro or higher plan.\n* Cloud recording must be enabled on the users' account.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Recording Resumed** subscription must be enabled under the **Recording** event.\n\n","operationId":"Recording.resumedWebhook","requestBody":{"description":"Webhook payload for the `recording.resumed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recording.resumedEvent"},"examples":{"default":{"summary":"Example recording.resumed event","value":{"event":"recording.resumed","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":1234567890,"uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Personal Recording","type":4,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"recording_file":{"recording_start":"2021-03-23T22:14:57Z","recording_end":""}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.participant_phone_callout_missed":{"post":{"tags":["Meetings"],"summary":"meeting.participant_phone_callout_missed","description":"\nThe **Invited party missed a meeting invitation through phone (call out)** event is triggered every time an invitation to [join a meeting through phone (call out)](https://support.zoom.us/hc/en-us/articles/4404535651085) times out.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with these configurations.\n* A valid **Event Notification Endpoint URL**.\n* The **Invited party missed a meeting invitation through phone (call out)** subscription enabled under the **Meeting** event.\n\n","operationId":"Meeting.participant_phone_callout_missedWebhook","requestBody":{"description":"Webhook payload for the `meeting.participant_phone_callout_missed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.participant_phone_callout_missedEvent"},"examples":{"default":{"summary":"Example meeting.participant_phone_callout_missed event","value":{"event":"meeting.participant_phone_callout_missed","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","object":{"id":713592696,"uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"ICuPoX4ERtikRcKqkVxunQ","participant":{"invitee_name":"Jill Chill","phone_number":1800000000}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.summary_updated":{"post":{"tags":["Meetings"],"summary":"meeting.summary_updated","description":"The **Meeting summary has been updated** event is triggered every time one of your app users or account users updates a meeting summary.\n\n## Prerequisites\n\n* Host user must have a Pro or higher plan.\n* Enable the **Meeting Summary with AI Companion** feature in the host's account.\n* E2ee meetings do not have summary feature enabled.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Meeting summary has been updated** subscription enabled under the **Meeting** event.","operationId":"Meeting.summary_updatedWebhook","requestBody":{"description":"Webhook payload for the `meeting.summary_updated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.summary_updatedEvent"},"examples":{"default":{"summary":"Example meeting.summary_updated event","value":{"event":"meeting.summary_updated","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"meeting_host_id":"30R7kT7bTIKSNUFEuH_Qlg","meeting_host_email":"jchill@example.com","meeting_uuid":"aDYlohsHRtCd4ii1uC2+hA==","meeting_id":97763643886,"meeting_topic":"My Meeting","meeting_start_time":"2019-07-15T23:24:52Z","meeting_end_time":"2020-07-15T23:30:19Z","summary_start_time":"2019-07-15T23:24:52Z","summary_end_time":"2020-07-15T23:30:19Z","summary_created_time":"2019-07-15T23:24:52Z","summary_last_modified_time":"2020-07-15T23:30:19Z","summary_last_modified_user_id":"Lfi0BlBQTM-bbktE9BRUvA","summary_last_modified_user_email":"user@example.com","summary_title":"Meeting Summary for my meeting","summary_overview":"Meeting Overview","summary_details":[{"label":"Meeting Overview","summary":"Meeting Overview"}],"next_steps":["step1"],"edited_summary":{"summary_overview":"Meeting overview","summary_details":"Meeting overview","next_steps":["step1"]},"summary_content":"## Key takeaways\n- Mobile app performance issues are affecting user retention.\n- New onboarding flow received positive feedback from beta testers.\n- Need to prioritize accessibility improvements.\n- Customer support response time has improved by 25%.\n\n## Discussed topics\n### Mobile App Performance\nDiscussion of recent performance metrics and user complaints\n- **Details**\n    - Sarah (Product): Reports of app crashes increased 15% this month\n    - Mike (Engineering): Memory optimization needed in latest release\n    - Tom (QA): Identified memory leak in photo upload feature\n- **Conclusion**\n    - Implement performance monitoring tools\n    - Prioritize memory optimization in next sprint\n\n### Onboarding Flow\nReview of beta testing results for new user onboarding\n- **Details**\n    - Rachel (UX): 90% completion rate in beta testing\n    - David (Product): Positive feedback on simplified registration\n- **Conclusion**\n    - Ready for full rollout next month\n    - Need to monitor analytics post-launch\n\n### Accessibility Compliance\nDiscussion of current accessibility status and needed improvements\n- **Details**\n    - Lisa (Design): Screen reader compatibility issues identified\n    - John (Engineering): WCAG compliance at 80%\n- **Conclusion**\n    - Create accessibility improvement roadmap\n    - Schedule external audit\n\n## Challenges\n* Resource constraints for performance optimization\n* Integration testing environment stability issues\n* Lack of accessibility expertise in the team\n\n## Action items\n- **Sarah**\n  - Prepare performance monitoring implementation plan\n  - Schedule follow-up meeting with engineering team\n- **Mike**\n  - Investigate memory leak fix\n  - Document performance optimization guidelines\n- **Lisa**\n  - Create accessibility improvement proposal\n  - Research accessibility testing tools\n- **Rachel**\n  - Prepare onboarding analytics dashboard\n  - Document beta testing findings","summary_doc_url":"https://docs.example.com/doc/1aBcDeFgHiJkLmNoPqRsTu"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.participant_joined":{"post":{"tags":["Webinars"],"summary":"webinar.participant_joined","description":"\nThe **Participant/Host joined webinar** event is triggered every time a host or an attendee joins a webinar that was created by one of your app users or account users.\n\nZoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing webinars. A webinar host can invite other users to attend the webinar. <br>[Zoom Video Webinar](https://support.zoom.us/hc/en-us/articles/200917029-Getting-Started-With-Webinar) allows users to broadcast a Zoom meeting to up to 1000 attendees.\n\n## Prerequisites\n\n* Pro or a higher plan with Webinar license.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Participant/Host joined webinar** subscription enabled under the **Webinar** event.\n\n","operationId":"Webinar.participant_joinedWebhook","requestBody":{"description":"Webhook payload for the `webinar.participant_joined` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.participant_joinedEvent"},"examples":{"default":{"summary":"Example webinar.participant_joined event","value":{"event":"webinar.participant_joined","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Webinar","type":9,"start_time":"2021-07-13T21:44:51Z","duration":60,"timezone":"America/Los_Angeles","participant":{"user_id":"1234567890","user_name":"Jill Chill","id":"iFxeBPYun6SAiWUzBcEkX","join_time":"2021-07-13T21:44:51Z","email":"jchill@example.com","registrant_id":"abcdefghij0-klmnopq23456","participant_user_id":"rstuvwxyza789-cde","participant_uuid":"55555AAAiAAAAAiAiAiiAii","customer_key":"349589LkJyeW","phone_number":"8615250064084"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"recording.renamed":{"post":{"tags":["Cloud Recording"],"summary":"recording.renamed","description":"\nThe **Recording Renamed** event is triggered every time the title of a cloud recording is changed.\n\nAll users with a Pro or a higher plan have access to [cloud recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording). After a meeting or a webinar which was being recorded to the cloud ends, the recording is made available on the host's [Zoom account](https://zoom.us/recording).\n\nBy default, the title of the recording is the same as the topic of the meeting or the webinar that was recorded. However, a meeting host, an account admin or an account owner can rename the title of the recording using the Zoom Web Portal. To do so, the user must navigate to the [**Cloud Recordings**](https://zoom.us/recording) in the Zoom Web Portal, click on the recording that needs to be renamed and click on the pencil icon to rename the title of the recording.\n\n## Prerequisites\n\n* A Pro or higher plan.\n* Cloud recording must be enabled on the users' account.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n\t* The **Recording Renamed** subscription must be enabled under the **Recording** event.\n\n","operationId":"Recording.renamedWebhook","requestBody":{"description":"Webhook payload for the `recording.renamed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recording.renamedEvent"},"examples":{"default":{"summary":"Example recording.renamed event","value":{"event":"recording.renamed","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","time_stamp":"1628705277325","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","id":1234567890,"topic":"My Old Personal Recording","type":4,"host_id":"I6zp-pPbTl22Z29H786Ixg"},"recording_file":{"uuid":"4444AAAiAAAAAiAiAiiAii==","id":1234567890,"topic":"My New Personal Recording","type":4,"host_id":"I6zp-pPbTl22Z29H786Ixg"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.participant_room_system_callout_missed":{"post":{"tags":["Meetings"],"summary":"meeting.participant_room_system_callout_missed","description":"\nThe **Invited party missed a meeting invitation through phone (call out) via Zoom room** event is triggered every time an invitation to [join a meeting through phone (call out) from a Zoom room](https://support.zoom.us/hc/en-us/articles/205369035) times out.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n* A valid **Event Notification Endpoint URL**.\n* The **Invited party missed a meeting invitation through phone (call out) via Zoom room** subscription enabled under the **Meeting** event.\n\n","operationId":"Meeting.participant_room_system_callout_missedWebhook","requestBody":{"description":"Webhook payload for the `meeting.participant_room_system_callout_missed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.participant_room_system_callout_missedEvent"},"examples":{"default":{"summary":"Example meeting.participant_room_system_callout_missed event","value":{"event":"meeting.participant_room_system_callout_missed","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","object":{"id":713592696,"uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"ICuPoX4ERtikRcKqkVxunQ","message_id":"atsXxhSEQWit9t+U02HXNQ==","inviter_name":"Jill Chill","participant":{"call_type":"h323","device_ip":"10.100.111.237"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.created":{"post":{"tags":["Webinars"],"summary":"webinar.created","description":"\nZoom triggers this event every time one of your app users or account users creates a Webinar.\n\nZoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing webinars. [Zoom Video Webinar](https://support.zoom.us/hc/en-us/articles/200917029-Getting-Started-With-Webinar) allows users to broadcast a Zoom meeting to up to 1000 attendees.\n\nA user can create a Webinar manually by logging into the [Zoom Web Portal](https://zoom.us/) and clicking on **Schedule a Webinar** button in the [Webinars](https://zoom.us/webinar/list) page. Alternatively, users can also use the [**Create a Webinar**](/docs/api-reference/zoom-api/methods#operation/webinarCreate) API to schedule a Webinar programmatically.\n\n## Prerequisites\n\n* Pro or a higher plan with Webinar license.\n* **Event Subscription** must be enabled for your [Marketplace App](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event notification endpoint URL**\n\t* The **Webinar has been created** subscription enabled under the **Meeting** event.\n\n\n\n","operationId":"Webinar.createdWebhook","requestBody":{"description":"Webhook payload for the `webinar.created` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.createdEvent"},"examples":{"default":{"summary":"Example webinar.created event","value":{"event":"webinar.created","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","operation":"single","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","id":1234567890,"host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Webinar","type":9,"start_time":"2021-07-13T21:44:51Z","duration":60,"timezone":"America/Los_Angeles","join_url":"https://example.com","password":"XYz@BC!D1087","creation_source":"open_api","occurrences":[{"occurrence_id":"ABCDE12345","start_time":"2021-07-13T21:44:51Z","duration":60,"status":"available"}],"settings":{"use_pmi":true,"alternative_hosts":"jchill@example.com"},"recurrence":{"type":1,"repeat_interval":2,"end_times":5}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"recording.registration_denied":{"post":{"tags":["Cloud Recording"],"summary":"recording.registration_denied","description":"\nThe **View registrant has denied for this recording** event is triggered every time a registrant is denied from viewing a cloud recording.\n\n[Cloud recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording) of Zoom meetings and webinars can be made [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings). With on-demand recordings, users can view the recordings of past meetings and webinars at any time as long as they have not been removed. To view these recordings, users can register manually by filling out the registration form that pops up when users click on the **Recording URL** provided by the Webinar organizer. After the registration, only registrants that are approved will be able to view the recording.\n\nAn account owner, a host of the meeting/webinar or a user with admin privileges can customize the [registration approval settings](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) for cloud recordings. The [registrants' information](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) can be viewed from the [Zoom Web Portal](https://zoom.us/recording). A pending or a previously approved registrant can be denied from viewing the recording by clicking **Deny**. The registrants can also be denied by using the [**Update registrant's status**](/api-reference/zoom-api/ma#operation/meetingRecordingRegistrantStatus) API.\n\n## Prerequisites\n\n* A Pro or higher plan.\n* Cloud recording must be enabled on the users' account.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n\t* The **View registrant has denied for this recording** subscription enabled under the **Recording** event.\n\n","operationId":"Recording.registration_deniedWebhook","requestBody":{"description":"Webhook payload for the `recording.registration_denied` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recording.registration_deniedEvent"},"examples":{"default":{"summary":"Example recording.registration_denied event","value":{"event":"recording.registration_denied","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":1234567890,"uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Personal Recording","type":4,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"occurrences":{"occurrence_id":"ABCDE12345","start_time":"2021-07-13T21:44:51Z"},"registrant":{"id":"iFxeBPYun6SAiWUzBcEkX","email":"jchill@example.com","first_name":"Jill","last_name":"Chill"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.participant_phone_callout_failed":{"post":{"tags":["Meetings"],"summary":"meeting.participant_phone_callout_failed","description":"\nThe **meeting invitation through phone (call out) failed** event is triggered every time an invitation to join a meeting through phone (call out) failed.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with these configurations.\n* A valid **Event Notification Endpoint URL**.\n* The **meeting invitation through phone (call out) failed** subscription enabled under the **Meeting** event.","operationId":"Meeting.participant_phone_callout_failedWebhook","requestBody":{"description":"Webhook payload for the `meeting.participant_phone_callout_failed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.participant_phone_callout_failedEvent"},"examples":{"default":{"summary":"Example meeting.participant_phone_callout_failed event","value":{"event":"meeting.participant_phone_callout_failed","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","object":{"id":713592696,"uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"ICuPoX4ERtikRcKqkVxunQ","participant":{"invitee_name":"Jill Chill","phone_number":1800000000},"reason_type":0}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.live_streaming_stopped":{"post":{"tags":["Meetings"],"summary":"meeting.live_streaming_stopped","description":"\nThe **Meeting Live Streaming Stopped** event is triggered every time a meeting's live stream ends. The host of the live stream must be a user in your account or a user in any other accounts that have installed your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.\n\nZoom lets users live stream their Zoom meetings on [YouTube Live](https://support.zoom.us/hc/en-us/articles/360028478292-Streaming-a-Meeting-or-Webinar-on-YouTube-Live), [Facebook](https://support.zoom.us/hc/en-us/articles/115000350406-Streaming-a-meeting-or-webinar-on-Facebook-Live), [Workplace by Facebook](https://support.zoom.us/hc/en-us/articles/115005460286-Live-Stream-Meetings-or-Webinars-on-Workplace-by-Facebook), and via a [custom live streaming services](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service).\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n* A valid **Event Notification Endpoint URL**.\n* The **Meeting Live Streaming Stopped** subscription enabled under the **Meeting** event.","operationId":"Meeting.live_streaming_stoppedWebhook","requestBody":{"description":"Webhook payload for the `meeting.live_streaming_stopped` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.live_streaming_stoppedEvent"},"examples":{"default":{"summary":"Example meeting.live_streaming_stopped event","value":{"event":"meeting.live_streaming_stopped","event_ts":1627906965803,"payload":{"account_id":"D8cJuqWVQ623CI4Q8yQK0Q","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"id":1234567890,"uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":2,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"live_streaming":{"service":"Custom_Live_Streaming_Service","custom_live_streaming_settings":{"stream_url":"https://example.com/livestream","stream_key":"ABCDEFG12345HIJ6789","page_url":"https://example.com/livestream/123","resolution":"1080p"},"date_time":"2021-08-02T12:22:45Z"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.participant_data_connection_established":{"post":{"tags":["Webinars"],"summary":"webinar.participant_data_connection_established","description":"The **Participant or Host connection established** event is triggered when an attendee establishes a data connection when joining a webinar.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Participant or Host connection established** subscription enabled under the **Webinar** event.","operationId":"Webinar.participant_data_connection_establishedWebhook","requestBody":{"description":"Webhook payload for the `webinar.participant_data_connection_established` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.participant_data_connection_establishedEvent"},"examples":{"default":{"summary":"Example webinar.participant_data_connection_established event","value":{"event":"webinar.participant_data_connection_established","event_ts":1779673098888,"payload":{"account_id":"WTpQ2Q_rSKm0-eGZtyakog","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Webinar","type":5,"start_time":"2026-07-05T21:42:51Z","participant":{"user_id":"1234567890","user_name":"Jill Chill","customer_key":"349589LkJyeW","participant_uuid":"55555AAAiAAAAAiAiAiiAii","join_time":"2026-07-05T21:44:51Z","email":"jchill@example.com","registrant_id":"abcdefghij0-klmnopq23456","participant_user_id":"rstuvwxyza789-cde","phone_number":"8611111111111"},"data_connections":[{"connection_type":"audio","total_time_cost_ms":820,"command_connection_time_cost_ms":140,"data_socket_time_cost_ms":310,"first_package_time_cost_ms":370},{"connection_type":"video","total_time_cost_ms":1540,"command_connection_time_cost_ms":260,"data_socket_time_cost_ms":720,"first_package_time_cost_ms":560},{"connection_type":"screen_share","total_time_cost_ms":2015,"command_connection_time_cost_ms":305,"data_socket_time_cost_ms":980,"first_package_time_cost_ms":730}]}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.registration_cancelled":{"post":{"tags":["Webinars"],"summary":"webinar.registration_cancelled","description":"\nThe **Webinar Registration has been canceled** event is triggered whenever one of these two conditions are met:\n\n* A registrant cancels their registration for a Webinar created by one of your app users or account users.\n* A host who is also a user of your app or your Zoom account cancels the registration of a registrant who was previously approved.\n\n[Scheduling a Webinar with registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires registrants to complete a brief form before receiving the link to join the Webinar. [Webinar Registration options](https://support.zoom.us/hc/en-us/articles/202835649-Webinar-Registration-Customization#h_b74e0e26-5f3f-40d4-a3de-949dbfd85882) can be customized by a Zoom admin or a Webinar host. This customization allows them to choose whether to approve attendees automatically or manually.\n\n## Prerequisites\n\n* Pro or a higher plan with Webinar license.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**\n\t* The **Webinar Registration has been canceled** subscription enabled under the **Webinar** event.\n\n","operationId":"Webinar.registration_cancelledWebhook","requestBody":{"description":"Webhook payload for the `webinar.registration_cancelled` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.registration_cancelledEvent"},"examples":{"default":{"summary":"Example webinar.registration_cancelled event","value":{"event":"webinar.registration_cancelled","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","id":1234567890,"host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Webinar","type":9,"start_time":"2021-07-13T21:44:51Z","duration":60,"timezone":"America/Los_Angeles","occurrences":[{"occurrence_id":"ABCDE12345","start_time":"2021-07-13T21:44:51Z"}],"registrant":{"id":"iFxeBPYun6SAiWUzBcEkX","first_name":"Jill","last_name":"Chill","email":"jchill@example.com","tracking_source":{"id":"5516482804110","source_name":"general","tracking_url":"https://example.com/webinar/register/5516482804110/WN_juM2BGyLQMyQ_ZrqiGRhLg"}}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.recovered":{"post":{"tags":["Meetings"],"summary":"meeting.recovered","description":"\nThe **Meeting has been recovered** event is triggered every time a user recovers a previously-deleted meeting. The user must be a user in your account or a user in any other accounts that have installed your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.\n\nZoom users can restore previously-deleted meetings for up to one week after deletion. Any invitations, links, and meeting IDs sent prior to the meeting's deletion will still work after a user [recovers](https://support.zoom.us/hc/en-us/articles/360038297111-Recovering-a-deleted-meeting) it.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Meeting has been recovered** subscription enabled under the **Meeting** event.","operationId":"Meeting.recoveredWebhook","requestBody":{"description":"Webhook payload for the `meeting.recovered` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.recoveredEvent"},"examples":{"default":{"summary":"Example meeting.recovered event","value":{"event":"meeting.recovered","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","operation":"single","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","id":1234567890,"host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":8,"start_time":"2021-07-13T21:44:51Z","duration":60,"timezone":"America/Los_Angeles","occurrences":[{"occurrence_id":"ABCDE12345","start_time":"2021-07-13T21:44:51Z"}]}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.permanently_deleted":{"post":{"tags":["Webinars"],"summary":"webinar.permanently_deleted","description":"\nThe **Webinar has been permanently deleted** event is triggered every time a scheduled webinar is permanently deleted.\n\nA webinar host or a user with admin privileges can permanently delete a webinar via the [Zoom web portal](https://zoom.us).\n\n## Prerequisites\n\n* A Pro or higher plan.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Webinar has been permanently deleted** subscription enabled under the **Webinar** event.\n\n","operationId":"Webinar.permanently_deletedWebhook","requestBody":{"description":"Webhook payload for the `webinar.permanently_deleted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.permanently_deletedEvent"},"examples":{"default":{"summary":"Example webinar.permanently_deleted event","value":{"event":"webinar.permanently_deleted","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","operation":"single","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","id":1234567890,"host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Webinar","type":9,"start_time":"2021-07-13T21:44:51Z","duration":60,"timezone":"America/Los_Angeles","occurrences":[{"occurrence_id":"1677637740000","start_time":"2023-03-01T02:29:00Z"}]}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"recording.completed":{"post":{"tags":["Cloud Recording"],"summary":"recording.completed","description":"\nThis event is triggered when a recording of a meeting or webinar becomes available to view or download.\n\nUsers with a Pro or a higher plan have access to [cloud recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording). Account owners and account admins can [enable cloud recording](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording#h_29fc1846-190d-4f05-ab23-1070c8106ec8) for account members.  \nUsers can also enable cloud recordings [for their own use](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording#h_4cca2458-cbd5-4439-933c-57c0d62a2753).\n\nOnly meeting or webinar hosts and co-hosts can start and complete a [cloud recording](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording). A recording is considered complete **after** the host or co-host ends the meeting or webinar.\n\n## Prerequisites\n\n* A Pro or higher plan.\n* Enable Cloud recording on the users' account.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\t* A valid **Event notification endpoint URL**.\n\t* The **All Recordings have completed** subscription must be enabled under the **Recording** event.\n\n\n\n","operationId":"Recording.completedWebhook","requestBody":{"description":"Webhook payload for the `recording.completed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recording.completedEvent"},"examples":{"default":{"summary":"Example recording.completed event","value":{"event":"recording.completed","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":1234567890,"uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","account_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Personal Recording","type":4,"start_time":"2021-07-13T21:44:51Z","password":"132456","timezone":"America/Los_Angeles","host_email":"jchill@example.com","duration":60,"share_url":"https://example.com","total_size":3328371,"recording_count":2,"on_prem":false,"recording_play_passcode":"yNYIS408EJygs7rE5vVsJwXIz4-VW7MH","auto_delete":true,"auto_delete_date":"2028-07-12","recording_files":[{"id":"ed6c2f27-2ae7-42f4-b3d0-835b493e4fa8","meeting_id":"098765ABCD","recording_start":"2021-03-23T22:14:57Z","recording_end":"2021-03-23T23:15:41Z","recording_type":"audio_only","file_type":"M4A","file_size":246560,"file_extension":"M4A","play_url":"https://example.com/recording/play/Qg75t7xZBtEbAkjdlgbfdngBBBB","download_url":"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngBBBB","status":"completed"},{"id":"388ffb46-1541-460d-8447-4624451a1db7","meeting_id":"098765ABCD","recording_start":"2021-03-23T22:14:57Z","recording_end":"2021-03-23T23:15:41Z","recording_type":"shared_screen_with_speaker_view","file_type":"MP4","file_size":282825,"file_extension":"MP4","play_url":"https://example.com/recording/play/Qg75t7xZBtEbAkjdlgbfdngCCCC","download_url":"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngCCCC","status":"completed"}],"participant_audio_files":[{"id":"ed6c2f27-2ae7-42f4-b3d0-835b493e4fa8","recording_start":"2021-03-23T22:14:57Z","recording_end":"2021-03-23T23:15:41Z","file_type":"M4A","file_name":"MyRecording","file_size":246560,"file_extension":"MP4","play_url":"https://example.com/recording/play/Qg75t7xZBtEbAkjdlgbfdngAAAA","download_url":"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngAAAA","status":"completed"}]}},"download_token":"abJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJodHRwczovL2V2ZW50Lnpvb20udXMiLCJhY2NvdW50SWQiOiJNdDZzdjR1MFRBeVBrd2dzTDJseGlBIiwiYXVkIjoiaHR0cHM6Ly9vYXV0aC56b29tLnVzIiwibWlkIjoieFp3SEc0c3BRU2VuekdZWG16dnpiUT09IiwiZXhwIjoxNjI2MTM5NTA3LCJ1c2VySWQiOiJEWUhyZHBqclMzdWFPZjdkUGtrZzh3In0.a6KetiC6BlkDhf1dP4KBGUE1bb2brMeraoD45yhFx0eSSSTFdkHQnsKmlJQ-hdo9Zy-4vQw3rOxlyoHv583JyZ"}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.participant_put_in_waiting_room":{"post":{"tags":["Meetings"],"summary":"meeting.participant_put_in_waiting_room","description":"\nThe **Participant was put in a waiting room** event is triggered every time a participant who has already joined the meeting is returned to the waiting room during the meeting. The meeting host must be a user in your account or a user in any other accounts that have installed your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.\n\nDuring a meeting, a meeting host can send a participant to the waiting room by selecting the **Put in waiting room** option in the Zoom client.\n\n## Prerequisites\n\n* Enable the [**waiting room**](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) for the meeting.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Participant was put in a waiting room** subscription must be enabled under the **Meeting** event.\n\n\n\n","operationId":"Meeting.participant_put_in_waiting_roomWebhook","requestBody":{"description":"Webhook payload for the `meeting.participant_put_in_waiting_room` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.participant_put_in_waiting_roomEvent"},"examples":{"default":{"summary":"Example meeting.participant_put_in_waiting_room event","value":{"event":"meeting.participant_put_in_waiting_room","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":8,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"participant":{"user_id":"1234567890","user_name":"Jill Chill","id":"iFxeBPYun6SAiWUzBcEkX","participant_uuid":"55555AAAiAAAAAiAiAiiAii","date_time":"2021-07-13T21:44:51Z","email":"jchill@example.com","participant_user_id":"iFxeBPYun6SAiWUzBcEkX","customer_key":"349589LkJyeW","registrant_id":"abcdefghij0-klmnopq23456"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"recording.trashed":{"post":{"tags":["Cloud Recording"],"summary":"recording.trashed","description":"\nThis event is triggered when a user initially deletes a cloud recording.\n\nWhen a user initially deletes a recording, it is sent to the trash. To move a recording to the trash, users can use the [**Delete meeting recordings**](/api-reference/zoom-api/ma#operation/recordingDelete) API or the [Zoom web client](https://support.zoom.us/hc/en-us/articles/205347605-Recording-Management). Users can recover recordings from the trash  up to 30 days after deletion.\n\n## Prerequisites\n\n* A Pro or higher plan.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Recording files have been deleted to Trash** subscription enabled under the **Recording** event.\n\n","operationId":"Recording.trashedWebhook","requestBody":{"description":"Webhook payload for the `recording.trashed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recording.trashedEvent"},"examples":{"default":{"summary":"Example recording.trashed event","value":{"event":"recording.trashed","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":1234567890,"uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","account_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Personal Recording","type":4,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","host_email":"jchill@example.com","duration":60,"password":"132456","share_url":"https://example.com","total_size":3328371,"recording_count":2,"recording_files":[{"id":"ed6c2f27-2ae7-42f4-b3d0-835b493e4fa8","meeting_id":"098765ABCD","recording_start":"2021-03-23T22:14:57Z","recording_end":"2021-03-23T23:15:41Z","file_type":"M4A","file_size":246560,"file_extension":"M4A","play_url":"https://example.com/recording/play/Qg75t7xZBtEbAkjdlgbfdngBBBB","download_url":"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngBBBB","status":"completed","recording_type":"audio_only"},{"id":"388ffb46-1541-460d-8447-4624451a1db7","meeting_id":"098765ABCD","recording_start":"2021-03-23T22:14:57Z","recording_end":"2021-03-23T23:15:41Z","file_type":"MP4","file_size":282825,"file_extension":"MP4","play_url":"https://example.com/recording/play/Qg75t7xZBtEbAkjdlgbfdngCCCC","download_url":"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngCCCC","status":"completed","recording_type":"shared_screen_with_speaker_view"}],"participant_audio_files":[{"id":"ed6c2f27-2ae7-42f4-b3d0-835b493e4fa8","recording_start":"2021-03-23T22:14:57Z","recording_end":"2021-03-23T23:15:41Z","recording_type":"audio_only","file_type":"M4A","file_name":"MyRecording","file_size":246560,"file_extension":"MP4","play_url":"https://example.com/recording/play/Qg75t7xZBtEbAkjdlgbfdngAAAA","download_url":"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngAAAA","status":"completed"}]}},"download_token":"abJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJodHRwczovL2V2ZW50Lnpvb20udXMiLCJhY2NvdW50SWQiOiJNdDZzdjR1MFRBeVBrd2dzTDJseGlBIiwiYXVkIjoiaHR0cHM6Ly9vYXV0aC56b29tLnVzIiwibWlkIjoieFp3SEc0c3BRU2VuekdZWG16dnpiUT09IiwiZXhwIjoxNjI2MTM5NTA3LCJ1c2VySWQiOiJEWUhyZHBqclMzdWFPZjdkUGtrZzh3In0.a6KetiC6BlkDhf1dP4KBGUE1bb2brMeraoD45yhFx0eSSSTFdkHQnsKmlJQ-hdo9Zy-4vQw3rOxlyoHv583JyZ"}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.summary_deleted":{"post":{"tags":["Meetings"],"summary":"meeting.summary_deleted","description":"\nThe **Meeting summary has been permanently deleted** event is triggered every time one of your app users or account users permanently deletes a meeting summary.\n\n## Prerequisites\n\n* Host user must be Pro or higher plan.\n* Enable the **Meeting Summary with AI Companion** feature in the host's account.\n* E2ee meetings do not have summary feature enabled.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Meeting summary has been permanently deleted** subscription enabled under the **Meeting** event.","operationId":"Meeting.summary_deletedWebhook","requestBody":{"description":"Webhook payload for the `meeting.summary_deleted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.summary_deletedEvent"},"examples":{"default":{"summary":"Example meeting.summary_deleted event","value":{"event":"meeting.summary_deleted","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"meeting_host_id":"30R7kT7bTIKSNUFEuH_Qlg","meeting_host_email":"jchill@example.com","meeting_uuid":"aDYlohsHRtCd4ii1uC2+hA==","meeting_id":97763643886,"meeting_topic":"My Meeting","meeting_start_time":"2019-07-15T23:24:52Z","meeting_end_time":"2020-07-15T23:30:19Z","summary_start_time":"2019-07-15T23:24:52Z","summary_end_time":"2020-07-15T23:30:19Z","summary_created_time":"2019-07-15T23:24:52Z","summary_last_modified_time":"2020-07-15T23:30:19Z","summary_title":"Meeting Summary for my meeting"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.participant_bind":{"post":{"tags":["Webinars"],"summary":"webinar.participant_bind","description":"descriptionThe **Phone User Bind To Participant** event is triggered every time a phone user joins a webinar and binds to an attendee in the webinar. \n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Phone User Bind To Partcipant** subscription enabled under the **Webinar** event.\n","operationId":"Webinar.participant_bindWebhook","requestBody":{"description":"Webhook payload for the `webinar.participant_bind` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.participant_bindEvent"},"examples":{"default":{"summary":"Example webinar.participant_bind event","value":{"event":"webinar.participant_bind","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"1234567890","uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Meeting","type":8,"start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","duration":60,"participant":{"user_id":"1234567890","bind_user_id":"16778240","user_name":"Jill Chill","id":"iFxeBPYun6SAiWUzBcEkX","participant_uuid":"55555AAAiAAAAAiAiAiiAii","bind_participant_uuid":"B8E2844F-F162-4808-A997-F267BCE8B0BB","date_time":"2021-07-13T21:44:51Z","registrant_id":"abcdefghij0-klmnopq23456","phone_number":"8615250064084","join_time":"2021-07-13T21:44:51Z"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.updated":{"post":{"tags":["Webinars"],"summary":"webinar.updated","description":"\nThe **Webinar has been updated** event is triggered every time one of your app users or account users updates a webinar.\n\nZoom users with a [webinar plan](https://zoom.us/webinar) have access to creating and managing webinars. [Zoom Video Webinar](https://support.zoom.us/hc/en-us/articles/200917029-Getting-Started-With-Webinar) allows users to broadcast a Zoom meeting to up to 1000 attendees. A scheduled webinar can be updated either by the user who created it or by a user with admin privileges.\n\nUsers can update a webinar manually by logging into the [Zoom Web Portal](https://zoom.us/), navigating to the webinar that needs to be updated from the [Webinars](https://zoom.us/webinar/list) page and clicking on the **Edit this Webinar** button.  Alternatively, users can also use the [**Update a webinar**](/docs/api-reference/zoom-api/methods#operation/webinarUpdate) API to schedule a webinar programmatically.\n\n## Prerequisites\n\n* Have a Pro or a higher plan with webinar license.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Webinar has been updated** subscription enabled under the **Webinar** event.","operationId":"Webinar.updatedWebhook","requestBody":{"description":"Webhook payload for the `webinar.updated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.updatedEvent"},"examples":{"default":{"summary":"Example webinar.updated event","value":{"event":"webinar.updated","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","scope":"single","object":{"id":1234567890,"uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"x1yCzABCDEfg23HiJKl4mN","topic":"My Webinar","type":9,"start_time":"2021-07-13T21:44:51Z","duration":60,"timezone":"America/Los_Angeles","password":"XYz@BC!D1087","agenda":"Overview of Webinar Topics","registration_url":"https://example.com","occurrences":[{"occurrence_id":"ABCDE12345","start_time":"2021-07-13T21:44:51Z","duration":60,"status":"available"}],"settings":{"host_video":true,"language_interpretation":{"enable":true,"interpreters":[{"email":"interpreter@example.com","interpreter_languages":"English,French"}]},"sign_language_interpretation":{"enable":true,"interpreters":[{"email":"interpreter@example.com","sign_language":"American"}]},"email_in_attendee_report":true,"allow_host_control_participant_mute_state":true},"old_object":{"id":1234567890,"settings":{"participant_video":false,"join_before_host":true,"language_interpretation":{"enable":true,"interpreters":[{"email":"interpreter@example.com","interpreter_languages":"English,Japanese"}]},"sign_language_interpretation":{"enable":true,"interpreters":[{"email":"interpreter@example.com","sign_language":"French"}]},"email_in_attendee_report":false,"allow_host_control_participant_mute_state":false}}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"recording.batch_recovered":{"post":{"tags":["Cloud Recording"],"summary":"recording.batch_recovered","description":"\nThe **Batch recording recovered** event is triggered every time one of your app users or account users recover one or more recordings from the trash.\n\nZoom allows users to recover their cloud recordings from trash within 30 days of deletion. You can recover a deleted cloud recording via the [**Recordings** tab in the Zoom web client](https://support.zoom.us/hc/en-us/articles/216378863-Recover-a-Deleted-Cloud-Recording) or via the [**Recover meeting recordings**](/api-reference/zoom-api/ma#operation/recordingStatusUpdate) API.\n\n## Prerequisites\n\n* A Pro or a higher plan.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n* A valid **Event Notification Endpoint URL**.\n* The **Recording files have been recovered in batches from trash** subscription enabled under the **Recording** event.\n\n","operationId":"Recording.batch_recoveredWebhook","requestBody":{"description":"Webhook payload for the `recording.batch_recovered` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Recording.batch_recoveredEvent"},"examples":{"default":{"summary":"Example recording.batch_recovered event","value":{"event":"recording.batch_recovered","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"I7zp-pYbTl22Z29H796Ixg","object":{"meetings":[{"meeting_uuid":"4444AAAiAAAAAiAiAiiAii==","recording_file_ids":["ed6c2f27-2ae7-42f4-b3d0-835b493e4fa8","388ffb46-1541-460d-8447-4624451a1db7"]}]}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.participant_room_system_callout_rejected":{"post":{"tags":["Meetings"],"summary":"meeting.participant_room_system_callout_rejected","description":"\nThe **Invited party rejected a meeting invitation through phone (call out) via Zoom room** event is triggered every time a user rejects an invitation to [join a meeting through phone (call out) from a Zoom room](https://support.zoom.us/hc/en-us/articles/205369035).\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n* A valid **Event Notification Endpoint URL**.\n* The **Invited party rejected a meeting invitation through phone (call out) via Zoom room** subscription enabled under the **Meeting** event.\n\n","operationId":"Meeting.participant_room_system_callout_rejectedWebhook","requestBody":{"description":"Webhook payload for the `meeting.participant_room_system_callout_rejected` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.participant_room_system_callout_rejectedEvent"},"examples":{"default":{"summary":"Example meeting.participant_room_system_callout_rejected event","value":{"event":"meeting.participant_room_system_callout_rejected","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","object":{"id":713592696,"uuid":"4444AAAiAAAAAiAiAiiAii==","host_id":"ICuPoX4ERtikRcKqkVxunQ","message_id":"atsXxhSEQWit9t+U02HXNQ==","inviter_name":"Jill Chill","participant":{"call_type":"h323","device_ip":"10.100.111.237"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}}},"components":{"schemas":{"Meeting.participant_jbh_waitingEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the meeting."},"object":{"required":["duration","host_id","id","participant","topic","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The meeting ID."},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type. \n* `0` - A prescheduled meeting. \n* `1` - An instant meeting. \n* `2` - A scheduled meeting. \n* `3` - A recurring meeting with no fixed time. \n* `4` - A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` - A [PAC (personal audio conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` - A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"type":"string","description":"The meeting's start time.","format":"date-time"},"timezone":{"type":"string","description":"The meeting's [timezone](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones)."},"duration":{"type":"integer","description":"The scheduled meeting duration."},"participant":{"required":["user_name"],"type":"object","properties":{"id":{"type":"string","description":"The participant's universally unique ID (UUID). \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value."},"user_name":{"type":"string","description":"The participant's display name."},"customer_key":{"type":"string","description":"The participant's SDK identifier. This value can be alphanumeric."},"registrant_id":{"type":"string","description":"The participant's registrant ID. A host or a user with administrative permissions can require [registration for Zoom meetings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065026)."}},"additionalProperties":false,"description":"Information about the meeting participant."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.summary_recoveredEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who hosted the meeting."},"operator":{"type":"string","description":"The email address of the user who recovered the meeting summary."},"operator_id":{"type":"string","description":"The user ID of the user who recovered the meeting summary."},"object":{"required":["meeting_end_time","meeting_host_email","meeting_host_id","meeting_id","meeting_start_time","meeting_topic","meeting_uuid","summary_created_time","summary_end_time","summary_last_modified_time","summary_start_time","summary_title"],"type":"object","properties":{"meeting_host_id":{"type":"string","description":"The ID of the user who is set as the meeting host."},"meeting_host_email":{"type":"string","description":"The meeting host's email address.","format":"email"},"meeting_uuid":{"type":"string","description":"Unique meeting ID. Each meeting instance generates its own meeting UUID - after a meeting ends, a new UUID is generated for the next instance of the meeting. Retrieve a list of UUIDs from past meeting instances using the [**List past meeting instances**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/pastMeetings) API. [Double encode](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#meeting-id-and-uuid) your UUID when using it for API calls if the UUID begins with a `/` or contains `//` in it.\n"},"meeting_id":{"type":"integer","description":"[Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-) - the meeting's unique identifier in **long** format, represented as int64 data type in JSON. Also known as the meeting number.","format":"int64"},"meeting_topic":{"type":"string","description":"Meeting topic."},"meeting_start_time":{"type":"string","description":"The meeting's start date and time.","format":"date-time"},"meeting_end_time":{"type":"string","description":"The meeting's end date and time.","format":"date-time","example":"2020-07-15T23:30:19Z"},"summary_start_time":{"type":"string","description":"The summary's start date and time.","format":"date-time"},"summary_end_time":{"type":"string","description":"The summary's end date and time.","format":"date-time"},"summary_created_time":{"type":"string","description":"The date and time when the meeting summary was created.","format":"date-time"},"summary_last_modified_time":{"type":"string","description":"The date and time when the meeting summary was last modified.","format":"date-time"},"summary_title":{"type":"string","description":"The summary title."}},"additionalProperties":true,"description":"Information about the meeting summary."}},"additionalProperties":true}},"additionalProperties":true},"Meeting.participant_left_breakout_roomEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the meeting."},"object":{"required":["breakout_room_uuid","duration","host_id","id","participant","start_time","topic","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The main meeting ID."},"uuid":{"type":"string","description":"The main meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"breakout_room_uuid":{"type":"string","description":"The breakout room's universally unique identifier (UUID). Each breakout room instance generates a breakout room UUID."},"host_id":{"type":"string","description":"The main meeting host's user ID."},"topic":{"type":"string","description":"The main meeting's topic."},"type":{"type":"integer","description":"The main meeting type. \n* `0` - A prescheduled meeting. \n* `1` - An instant meeting. \n* `2` - A scheduled meeting. \n* `3` - A recurring meeting with no fixed time. \n* `4` - A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` - A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` - A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"pattern":"(^\\s*$|^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$)","type":"string","description":"The main meeting's start time."},"timezone":{"type":"string","description":"The main meeting's [timezone](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones)."},"duration":{"type":"integer","description":"The main scheduled meeting duration."},"participant":{"required":["email","leave_time","user_id","user_name"],"type":"object","properties":{"user_id":{"type":"string","description":"The participant's meeting user ID. This value is assigned to a participant when they join a meeting, and is only valid for the duration of the meeting."},"parent_user_id":{"type":"string","description":"The participant's main meeting user ID (`user_id`)."},"user_name":{"type":"string","description":"The participant's display name."},"id":{"type":"string","description":"The participant's unique ID. \n* If meeting registration was **not** required and the participant joined by logging into Zoom, this value is the same as the `userId` field used in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API. \n* If registration was required for the meeting and the participant joined the meeting by logging into Zoom, this value is the same as the `id` value in the [**List meeting registrants**](/api-reference/zoom-api/methods#operation/meetingRegistrants) API response. \n* If participant joins without logging into Zoom, this returns an empty string value. \n\n This value returns blank for external users.\n\n**Note:** Use the `participant_user_id` value instead of this value. We will remove this response in a future release."},"participant_uuid":{"type":"string","description":"The participant's UUID for this specific meeting and any breakout rooms created in this meeting. This value is assigned to a participant when they join a meeting, and is only valid for the duration of that meeting."},"leave_time":{"type":"string","description":"The time when the participant left the meeting.","format":"date-time"},"leave_reason":{"type":"string","description":"The reason why the participant left the meeting."},"email":{"type":"string","description":"The participant's email address. This response only returns if the participant joined the meeting by logging into Zoom.","format":"email"},"registrant_id":{"type":"string","description":"The participant's registrant ID. A host or a user with administrative permissions can require [registration for Zoom meetings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065026)."},"participant_user_id":{"type":"string","description":"The participant's unique ID. \n* If meeting registration was **not** required and the participant joined by logging into Zoom, this value is the same as the `userId` field used in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API. \n* If registration was required for the meeting and the participant joined the meeting by logging into Zoom, this value is the same as the `id` value in the [**List meeting registrants**](/api-reference/zoom-api/methods#operation/meetingRegistrants) API response. \n* If participant joins without logging into Zoom, this returns an empty string value.\n\nThis value returns blank for external users."},"phone_number":{"type":"string","description":"Phone number of participant joined via PSTN.","example":"8615250064084"},"customer_key":{"type":"string","description":"The participant's SDK identifier. This value can be alphanumeric."}},"additionalProperties":false,"description":"Information about the meeting participant."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.device_testedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the meeting."},"object":{"required":["id","test_result","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The meeting ID.","format":"int64"},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"test_result":{"required":["camera_status","microphone_status","speaker_status","user_id","user_name"],"type":"object","properties":{"user_id":{"type":"string","description":"The user's ID."},"user_name":{"type":"string","description":"The user's username."},"camera_status":{"type":"integer","description":"The camera's status: \n* `2` — Device working. \n* `1` — Device not working. \n* `0` — Device not tested.","enum":[0,1,2]},"speaker_status":{"type":"integer","description":"The speaker's status: \n* `2` — Device working. \n* `1` — Device not working. \n* `0` — Device not tested.","enum":[0,1,2]},"microphone_status":{"type":"integer","description":"The microphone's status: \n* `2` — Device working. \n* `1` — Device not working. \n* `0` — Device not tested.","enum":[0,1,2]},"os":{"type":"string","description":"The user's operating system."}},"additionalProperties":true,"description":"Information about the meeting's device test results."}},"additionalProperties":true}},"additionalProperties":true}},"additionalProperties":true},"Meeting.summary_sharedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who hosted the meeting."},"operator":{"type":"string","description":"The email address of the user who shared the meeting summary."},"operator_id":{"type":"string","description":"The user ID of the user who shared the meeting summary."},"object":{"required":["meeting_end_time","meeting_host_email","meeting_host_id","meeting_id","meeting_start_time","meeting_topic","meeting_uuid","share_with_users","summary_created_time","summary_end_time","summary_last_modified_time","summary_start_time","summary_title"],"type":"object","properties":{"meeting_host_id":{"type":"string","description":"The ID of the user who is set as the meeting host."},"meeting_host_email":{"type":"string","description":"The meeting host's email address.","format":"email"},"meeting_uuid":{"type":"string","description":"Unique meeting ID. Each meeting instance generates its own meeting UUID. After a meeting ends, a new UUID is generated for the next instance of the meeting. Retrieve a list of UUIDs from past meeting instances using the [**List past meeting instances**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/pastMeetings) API. [Double encode](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#meeting-id-and-uuid) your UUID when using it for API calls if the UUID begins with a `/` or contains `//` in it.\n"},"meeting_id":{"type":"integer","description":"[Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-) - the meeting's unique identifier in **long** format, represented as int64 data type in JSON. Also known as the meeting number.","format":"int64"},"meeting_topic":{"type":"string","description":"Meeting topic."},"meeting_start_time":{"type":"string","description":"The meeting's start date and time.","format":"date-time"},"meeting_end_time":{"type":"string","description":"The meeting's end date and time.","format":"date-time","example":"2020-07-15T23:30:19Z"},"summary_start_time":{"type":"string","description":"The summary's start date and time.","format":"date-time"},"summary_end_time":{"type":"string","description":"The summary's end date and time.","format":"date-time"},"summary_created_time":{"type":"string","description":"The date and time when the meeting summary was created.","format":"date-time"},"summary_last_modified_time":{"type":"string","description":"The date and time when the meeting summary was last modified.","format":"date-time"},"summary_title":{"type":"string","description":"The summary title."},"share_with_users":{"type":"array","description":"Information about the shared users.","items":{"required":["user_email"],"type":"object","properties":{"user_email":{"type":"string","description":"The shared user email.","format":"email"}},"additionalProperties":true}}},"additionalProperties":true,"description":"Information about the meeting summary."}},"additionalProperties":true}},"additionalProperties":true},"Webinar.chat_message_file_downloadedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["object","operator"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who downloaded the file. This value returns blank for external users."},"operator":{"type":"string","description":"The email address of the user who downloaded the file. This value returns the operator name for external users.","format":"email or name"},"operator_id":{"type":"string","description":"The user ID of the user who downloaded the file. This value returns blank for external users."},"object":{"required":["chat_message_file","host_account_id","id","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The webinar ID.","format":"int64"},"uuid":{"type":"string","description":"The webinar's universally unique identifier (UUID). Each webinar instance generates a meeting UUID."},"host_account_id":{"type":"string","description":"The webinar host's account ID. The value will be an empty string if this info is from an external user."},"chat_message_file":{"required":["file_id","file_name","file_size","file_type"],"type":"object","properties":{"file_id":{"type":"string","description":"The live webinar chat file's UUID."},"file_name":{"type":"string","description":"The live webinar chat file's name."},"file_size":{"type":"integer","description":"The live webinar chat file's size, in bytes."},"file_type":{"type":"string","description":"The live webinar chat file's type."},"file_owner_id":{"type":"string","description":"The user ID of the user who uploaded the team chat file. This value returns blank for external users."}},"additionalProperties":false,"description":"Information about the chat message file."}},"additionalProperties":false,"description":"Information about the chat message file."}},"additionalProperties":false}},"additionalProperties":false},"Webinar.deletedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who deleted the webinar."},"operator":{"type":"string","description":"The email address of the user who deleted the webinar."},"operator_id":{"type":"string","description":"The user ID of the user who deleted the webinar."},"operation":{"type":"string","description":"The type of operation performed: \n* `all` — The change was applied to all webinars. \n* `single` — The change was applied only to a single webinar.","enum":["all","single"]},"object":{"required":["host_id","id","type","uuid"],"type":"object","properties":{"uuid":{"type":"string","description":"The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."},"id":{"type":"integer","description":"The webinar ID.","format":"int64"},"host_id":{"type":"string","description":"The webinar host's user ID."},"topic":{"type":"string","description":"The webinar's topic."},"type":{"type":"integer","description":"The webinar type: \n* `5` — A webinar. \n* `6` — A recurring webinar without a fixed time. \n* `9` — A recurring webinar with a fixed time.","enum":[5,6,9]},"start_time":{"type":"string","description":"The webinar's start time.","format":"date-time"},"duration":{"type":"integer","description":"The scheduled webinar duration."},"timezone":{"type":"string","description":"The webinar's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"occurrences":{"type":"array","description":"Information about recurring webinars with fixed times and their occurrences. This only returns when the webinar's `type` value is `9`.","items":{"anyOf":[{"required":["occurrence_id","start_time"],"type":"object","properties":{"occurrence_id":{"type":"string","description":"The webinar occurrence's ID."},"start_time":{"type":"string","description":"The webinar's start time.","format":"date-time"}},"additionalProperties":true}]}}},"additionalProperties":true,"description":"Information about the webinar."}},"additionalProperties":true}},"additionalProperties":true},"Recording.registration_approvedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the host that recorded the meeting or webinar."},"operator":{"type":"string","description":"The email address of the user that approved registration for the meeting or webinar recording.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that approved registration for the meeting or webinar recording."},"object":{"required":["duration","host_id","id","registrant","start_time","topic","type","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The ID of the recorded meeting (`meetingId`) or webinar (`webinarId`).","format":"int64"},"uuid":{"type":"string","description":"The universally unique identifier (UUID) of the recorded meeting or webinar instance."},"host_id":{"type":"string","description":"The ID of the user set as the host of the meeting or webinar."},"topic":{"type":"string","description":"The meeting or webinar topic."},"type":{"type":"integer","description":"The type of recorded meeting or webinar: \n\n If the recording is of a meeting: \n* `1` — Instant meeting. \n* `2` — Scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A meeting created via PMI (Personal Meeting ID). \n* `7` — A [Personal Audio Conference](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) (PAC). \n* `8` - Recurring meeting with a fixed time. \n\n If the recording is of a webinar: \n* `5` — A webinar. \n* `6` — A recurring webinar without a fixed time. \n* `9` — A recurring webinar with a fixed time. \n\n If the recording is **not** from a meeting or webinar: \n\n* `99` — A recording uploaded via the [**Recordings**](https://zoom.us/recording) interface on the Zoom Web Portal.","enum":[1,2,3,4,5,6,7,8,9,99]},"start_time":{"type":"string","description":"The meeting or webinar's start time.","format":"date-time"},"timezone":{"type":"string","description":"The meeting or webinar's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"duration":{"type":"integer","description":"The meeting or webinar's scheduled duration."},"registrant":{"required":["email","first_name","last_name"],"type":"object","properties":{"id":{"type":"string","description":"The registrant's ID."},"email":{"type":"string","description":"The registrant's email address.","format":"email"},"first_name":{"type":"string","description":"The registrant's first name."},"last_name":{"type":"string","description":"The registrant's last name."}},"additionalProperties":false,"description":"Information about the recording registrant."}},"additionalProperties":false,"description":"Information about the recording registration."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.risk_alertEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the meeting."},"object":{"required":["armn_details","host_email","host_id","id","type","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The meeting ID.","format":"int64"},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"host_email":{"type":"string","description":"The meeting host's email address.","format":"email"},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type: \n* `0` — A prescheduled meeting. \n* `1` — An instant meeting. \n* `2` — A scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` — A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` — A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"type":"string","description":"The meeting's start time.","format":"date-time"},"timezone":{"type":"string","description":"The meeting's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"armn_details":{"type":"object","properties":{"post_platform":{"type":"string","description":"The post's social media platform. For example, Twitter, Reddit, or Facebook."},"social_link":{"type":"string","description":"The link to the social media post."},"post_time":{"type":"string","description":"The post's timestamp.","format":"date-time"},"post_user":{"type":"string","description":"The user who created the social media post."},"meeting_url":{"type":"string","description":"The meeting's URL."},"recommended_enable_settings":{"type":"array","description":"A comma-separated list of the recommended settings to enable: \n* `enablePassword` \n* `enableWaitingRoom` \n* `enableOnlyAuthenticated` \n* `enableRegistration` \n* `enableScreenShareLock` \n* `enableScreenShareHostOnly` \n* `enableSpecifiedDomain`","items":{"type":"string","enum":["enablePassword","enableWaitingRoom","enableOnlyAuthenticated","enableRegistration","enableScreenShareLock","enableScreenShareHostOnly","enableSpecifiedDomain"]}},"recommended_disable_settings":{"type":"array","description":"A comma-separated list of the recommended settings to disable: \n* `enableAnnotation` \n* `enableMeetingChat` \n* `enableScreenShare` \n* `enableMultipleShare`","items":{"type":"string","enum":["enableAnnotation","enableMeetingChat","enableScreenShare","enableMultipleShare"]}}},"additionalProperties":true,"description":"Information about the at-risk meeting notifier (ARMN)."}},"additionalProperties":true,"description":"Information about the meeting."}},"additionalProperties":true}},"additionalProperties":true},"Meeting.aic_transcript_completedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who hosted the meeting."},"object":{"required":["attach_type","file_id","host_id","meeting_id","meeting_start_time","meeting_topic","meeting_uuid"],"type":"object","properties":{"host_id":{"type":"string","description":"The ID of the user who is set as the meeting host."},"meeting_uuid":{"type":"string","description":"Unique meeting ID. Each meeting instance generates its own meeting UUID - after a meeting ends, a new UUID is generated for the next instance of the meeting. Retrieve a list of UUIDs from past meeting instances using the [**List past meeting instances**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/pastMeetings) API. [Double encode](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#meeting-id-and-uuid) your UUID when using it for API calls if the UUID begins with a `/` or contains `//` in it.\n"},"meeting_id":{"type":"integer","description":"[Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-) - the meeting's unique identifier in **long** format, represented as int64 data type in JSON. Also known as the meeting number.","format":"int64"},"meeting_topic":{"type":"string","description":"Meeting topic."},"meeting_start_time":{"type":"string","description":"The meeting's start date and time.","format":"date-time"},"file_id":{"type":"string","description":"Transcript file ID.","format":"string","example":"aDYlohsHRtCd4ii1uC290OP"},"attach_type":{"type":"string","description":"Each file ID has many attachments. Use this `attach_type` to download different attachments. In this webhook, the `attach_type` always equals `durable_transcript`.","format":"string","example":"durable_transcript"}},"additionalProperties":true,"description":"Information about the transcript."}},"additionalProperties":true}},"additionalProperties":true},"Webinar.participant_feedbackEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who commits the feedback."},"object":{"required":["id","participant","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The webinar ID. "},"uuid":{"type":"string","description":"The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."},"participant":{"required":["feedback","participant_user_id","participant_uuid","user_name"],"type":"object","properties":{"participant_uuid":{"type":"string","description":"The participant's meeting universally unique ID (UUID). This value is assigned to a participant when they join a meeting, and is only valid for the duration of the meeting. This value will not be changed when the participant joins/leaves a breakout room."},"participant_user_id":{"type":"string","description":"The participant's universally unique ID (UUID). This value returns blank for external users."},"user_name":{"type":"string","description":"The participant's display name."},"feedback":{"required":["satisfied"],"type":"object","properties":{"satisfied":{"type":"boolean","description":"Whether the participant is satisfied."},"feedback_details":{"type":"array","description":"The feedback details. This returns null if the `satisfied` field is `true`.","items":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"The feedback ID. \n* `1` — Poor video quality. \n* `2` — Poor audio quality. \n* `5` — Unable to present using share.zoom.us. \n* `7` — Unable to make phone call. \n* `8` — They could not hear us. \n* `9` — We could not hear them. \n* `10` — They could not see us. \n* `11` — We could not see them. \n* `12` — Could not present computer screen. \n* `999` — Others."},"name":{"type":"string","description":"The feedback name."}},"additionalProperties":false}},"comments":{"type":"string","description":"The participant's comments. This returns null if the `satisfied` field is `true`."}},"additionalProperties":false,"description":"Information about the feedback."}},"additionalProperties":false,"description":"Information about the webinar participant."}},"additionalProperties":false,"description":"Information about the webinar."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.participant_joined_waiting_roomEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the main meeting."},"object":{"required":["duration","host_id","id","participant","start_time","topic","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The meeting ID."},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type. \n* `0` - A prescheduled meeting. \n* `1` - An instant meeting. \n* `2` - A scheduled meeting. \n* `3` - A recurring meeting with no fixed time. \n* `4` - A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` - A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` - A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"pattern":"(^\\s*$|^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$)","type":"string","description":"The meeting's start time."},"timezone":{"type":"string","description":"The meeting's [timezone](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones)."},"duration":{"type":"integer","description":"The scheduled meeting duration."},"participant":{"required":["date_time","email","user_id"],"type":"object","properties":{"user_id":{"type":"string","description":"The participant's meeting user ID. This value is assigned to a participant when they join a meeting, and is only valid for the duration of the meeting."},"user_name":{"type":"string","description":"The participant's display name."},"id":{"type":"string","description":"The participant's universally unique ID (UUID). \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value. \n\n This value returns blank for external users.\n\n**Note:** Use the `participant_user_id` value instead of this value. We will remove this response in a future release."},"participant_uuid":{"type":"string","description":"The participant's UUID for this specific meeting and any breakout rooms created in this meeting. This value is assigned to a participant when they join a meeting, and is only valid for the duration of that meeting."},"date_time":{"type":"string","description":"The time when the participant joined the meeting.","format":"date-time"},"email":{"type":"string","description":"The participant's email address. This response only returns if the participant joined the meeting by logging into Zoom. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details.","format":"email"},"phone_number":{"type":"string","description":"Phone number of participant joined via PSTN.","example":"8615250064084"},"participant_user_id":{"type":"string","description":"The participant's universally unique ID (UUID). \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value.\n\nThis value returns blank for external users."},"customer_key":{"type":"string","description":"The participant's SDK identifier. This value can be alphanumeric."},"registrant_id":{"type":"string","description":"The participant's registrant ID. A host or a user with administrative permissions can require [registration for Zoom meetings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065026)."}},"additionalProperties":false,"description":"Information about the meeting participant. If the participant is **not** part of the host's account, `email` returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.ai_companion_assets_deletedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"The timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user that hosted the meeting."},"object":{"required":["ai_companion","host_id","meeting_number","meeting_uuid"],"type":"object","properties":{"meeting_number":{"type":"integer","description":"The meeting number.","format":"int64"},"meeting_uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID)."},"host_id":{"type":"string","description":"The ID of the user set as the host of the meeting."},"ai_companion":{"required":["deleted_assets"],"type":"object","properties":{"deleted_assets":{"type":"array","description":"List of AI Companion assets that were deleted.","items":{"type":"string","enum":["transcripts","summaries"]}}},"additionalProperties":false,"description":"The AI Companion assets that were deleted."}},"additionalProperties":false,"description":"The meeting where the AI Companion assets were deleted."}},"additionalProperties":false}},"additionalProperties":false},"Webinar.converted_to_meetingEvent":{"required":["event","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who converted the webinar into a meeting."},"operator":{"type":"string","description":"The email address of the user who converted the webinar into a meeting."},"operator_id":{"type":"string","description":"The user ID of the user who converted the webinar into a meeting."},"object":{"required":["host_id","id","type","uuid"],"type":"object","properties":{"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID)."},"id":{"type":"integer","description":"The meeting ID.","format":"int64"},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type.\n\n* `2` - A scheduled meeting.\n* `3` - A recurring meeting with no fixed time.\n* `8` - A recurring meeting with fixed time.","enum":[2,3,8]},"start_time":{"type":"string","description":"The scheduled meeting's start time. Returned only when the meeting type is `2`.","format":"date-time"},"duration":{"type":"integer","description":"The scheduled meeting's duration, in minutes. Returned only when the meeting type is `2`."},"timezone":{"type":"string","description":"The meeting's [timezone](/docs/api/references/abbreviations/#timezones)."}},"additionalProperties":true,"description":"Information about the meeting converted from a webinar."}},"additionalProperties":true}},"additionalProperties":true},"Meeting.participant_phone_callout_ringingEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The meeting host's account ID."},"object":{"required":["host_id","id","participant","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The meeting ID.","format":"int64"},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"participant":{"required":["invitee_name","phone_number"],"type":"object","properties":{"invitee_name":{"type":"string","description":"The user's name to display in the meeting."},"phone_number":{"type":"integer","description":"The user's phone number.","format":"int64"}},"additionalProperties":false,"description":"Information about the invited participant."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.participant_jbh_joinedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the meeting."},"object":{"required":["duration","host_id","id","participant","topic","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The meeting ID."},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type. \n* `0` - A prescheduled meeting. \n* `1` - An instant meeting. \n* `2` - A scheduled meeting. \n* `3` - A recurring meeting with no fixed time. \n* `4` - A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` - A [PAC (personal audio conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` - A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"type":"string","description":"The meeting's start time.","format":"date-time"},"timezone":{"type":"string","description":"The meeting's [timezone](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones)."},"duration":{"type":"integer","description":"The scheduled meeting duration."},"participant":{"type":"object","properties":{"id":{"type":"string","description":"The participant's universally unique ID (UUID). \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value."},"user_name":{"type":"string","description":"The participant's display name."},"customer_key":{"type":"string","description":"The participant's SDK identifier. This value can be alphanumeric."},"registrant_id":{"type":"string","description":"The participant's registrant ID. A host or a user with administrative permissions can require [registration for Zoom meetings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065026)."}},"additionalProperties":false,"description":"Information about the meeting participant."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.invitation_acceptedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The meeting host's account ID."},"operator":{"type":"string","description":"The email address of the user who accepted the meeting."},"operator_id":{"type":"string","description":"The user ID of the user who accepted the meeting."},"object":{"required":["host_id","id","participant","topic","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The meeting ID."},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"participant":{"required":["email","participant_user_id"],"type":"object","properties":{"participant_user_id":{"type":"string","description":"The user ID of the user who received the meeting invitation."},"email":{"type":"string","description":"The email address of the user who received the meeting invitation. If the participant is **not** part of the host's account, the `email` field returns an empty string value, with some exceptions. For more information, read our [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) documentation.","format":"email"}},"additionalProperties":false,"description":"Information about the invited participant."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Recording.archive_files_completedEvent":{"required":["download_token","event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"download_token":{"type":"string","description":"Use the generated token value with the `download_url` value to download the cloud recording via an [OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app). The download token only lasts for 24 hours after its creation, and you can only download the file within 24 hours of receiving the event notification. You can either include the `download_token` as a query parameter or pass it as a Bearer token in the Authorization header of your HTTP request. \n\n **Using an Authorization header (Recommended)** \n\n ```\ncurl --request GET \\\n  --url {download_url} \\\n  --header 'authorization: Bearer {download_token} \\\n  --header 'content-type: application/json'\n``` \n\n**Using a query parameter** \n\n ```\n{download_url}/?access_token={download_token}\n``` \n\n For example: `https://zoom.us/recording/download/123456?access_token=abcdefgh`"},"payload":{"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who hosted the meeting or the webinar."},"object":{"type":"object","properties":{"uuid":{"type":"string","description":"The universally unique identifier (UUID) of the recorded meeting or webinar instance. Each meeting or webinar instance generates its own meeting UUID."},"id":{"type":"integer","description":"The ID of the meeting (`meetingId`) or the webinar (`webinarId`)."},"host_id":{"type":"string","description":"The ID of the user set as the host of the archived meeting or webinar."},"topic":{"type":"string","description":"The meeting or webinar topic."},"type":{"type":"integer","description":"The type of archived meeting or webinar. \n\n If the recording is of a meeting: \n* `1` - Instant meeting. \n* `2` - Scheduled meeting. \n* `3` - A recurring meeting with no fixed time. \n* `4` - A meeting created via PMI (Personal Meeting ID). \n* `7` - A [Personal Audio Conference](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) (PAC). \n* `8` - Recurring meeting with a fixed time. \n\n If the recording is of a webinar: \n* `5` - A webinar. \n* `6` - A recurring webinar without a fixed time. \n* `9` - A recurring webinar with a fixed time. \n\n If the recording is **not** from a meeting or webinar: \n\n* `100` - A [breakout room](https://support.zoom.us/hc/en-us/articles/115005769646-Participating-in-breakout-rooms).","enum":[1,2,3,4,5,6,7,8,9,100]},"start_time":{"type":"string","description":"The meeting or webinar's start time."},"timezone":{"type":"string","description":"The meeting or webinar's [timezone](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones)."},"duration":{"type":"integer","description":"The meeting or webinar's scheduled duration."},"duration_in_second":{"type":"integer","description":"The meeting or webinar's duration, in seconds.","example":1800},"total_size":{"type":"integer","description":"The total size of the archive file, in bytes."},"recording_count":{"type":"integer","description":"The number of archived files returned in the API call response."},"meeting_type":{"type":"string","description":"Whether the meeting or webinar is internal or external. \n* `internal` - An internal meeting or webinar. \n* `external` - An external meeting or webinar. \n\n The `id`, `host_id`, and `topic` PII (Personal Identifiable Information) values in this response are removed when this value is `external`.","enum":["internal","external"]},"account_name":{"type":"string","description":"The user's account name."},"complete_time":{"type":"string","description":"The meeting or webinar's archive completion time.","format":"date-time","anyOf":[{"minLength":1,"format":"date-time"},{"enum":[""]}]},"is_breakout_room":{"type":"boolean","description":"Whether the room is a [breakout room](https://support.zoom.us/hc/en-us/articles/115005769646-Participating-in-breakout-rooms)."},"parent_meeting_id":{"type":"string","description":"The parent meeting's universally unique ID (UUID). Each meeting or webinar instance generates its own meeting UUID. If the `is_breakout_room` value is `true`, the API returns this value."},"archive_files":{"type":"array","description":"Information about the archive files.","items":{"type":"object","properties":{"id":{"type":"string","description":"The archived file's ID."},"file_type":{"type":"string","description":"The archived file's type. \n* `MP4` - Video file. \n* `M4A` - Audio-only file. \n* `TRANSCRIPT` - A transcription file, in VTT format. \n* `CHAT` - A TXT file containing in-meeting chat messages. \n* `CC` - A file containing the closed captions of the recording, in VTT file format. \n* `CHAT_MESSAGE` - A JSON file encoded in base64 format containing chat messages. The file also includes waiting room chats, deleted messages, meeting emojis and non-verbal feedback.","enum":["MP4","M4A","TRANSCRIPT","CHAT","CC","CHAT_MESSAGE"]},"file_extension":{"type":"string","description":"The archived file's extension."},"file_name":{"type":"string","description":"The archived file's name."},"file_size":{"type":"integer","description":"The archived file's size, in bytes."},"download_url":{"type":"string","description":"The URL to download the archived file. To download the archived file of a meeting or a webinar, use the `download_token` value included in the webhook as the `access_token` query parameter value and include this query parameter at the end of the URL. For example: \n\n `https://{{base-domain}}/rec/archive/download/xxx?access_token={{your-download_token-value}}`"},"status":{"type":"string","description":"The archived file's processing status. \n* `completed` - The processing of the file is complete. \n* `processing` - The file is processing. \n* `failed` - The file processing failed.","enum":["completed","processing","failed"]},"recording_type":{"type":"string","description":"The archive file's recording type. \n* `shared_screen_with_speaker_view` \n* `audio_only` \n* `chat_file` \n* `closed_caption` \n* `chat_message` \n\n For more information, read our [Managing and sharing cloud recordings](https://support.zoom.us/hc/en-us/articles/205347605-Managing-and-sharing-cloud-recordings#h_9898497b-e736-4980-a749-d55608f10773) documentation.","enum":["shared_screen_with_speaker_view","audio_only","chat_file","closed_caption","chat_message"]},"individual":{"type":"boolean","description":"Whether the recording file is an individual recording file: \n* `true` - An individual recording file. \n * `false` - An entire meeting file."},"participant_email":{"type":"string","description":"The individual recording file's participant email address. This value is returned when the `individual` value is `true`. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details.","format":"email"},"participant_join_time":{"type":"string","description":"The join time for the generated recording file. If this value is returned when the individual value is true, then it is the recording file's participant join time. When the individual value is false, it returns the join time for the archiving gateway.","format":"date-time","anyOf":[{"minLength":1,"format":"date-time"},{"enum":[""]}]},"participant_leave_time":{"type":"string","description":"The leave time for the generated recording file. If this value is returned when the individual value is true, then it is the recording file's participant leave time. When the individual value is false, it returns the leave time for the archiving gateway.","anyOf":[{"minLength":1,"format":"date-time"},{"enum":[""]}]},"encryption_fingerprint":{"type":"string","description":"The archived file's encryption fingerprint, using the SHA256 hash algorithm.","example":"abf85f0fe6a4db3cdd8c37e505e1dd18a34d9696170a14b5bc6395677472cf43"},"number_of_messages":{"type":"integer","description":"The number of `TXT` or `JSON` file messages. This field will return only when the `file_extension` is `JSON` or `TXT`","example":150},"storage_location":{"type":"string","description":"The region where the file is stored. This field returns only `Enable Distributed Compliance Archiving` op feature is enabled.","example":"US","enum":["US","AU","BR","CA","EU","IN","JP","SG","CH"]}},"additionalProperties":false}},"status":{"type":"string","description":"The archive's processing status: \n* `completed` - The archive's processing is complete. \n* `processing` - The archive is processing.","example":"completed","enum":["completed","processing"]},"group_id":{"type":"string","description":"Primary group IDs of participants who belong to your account. Each group ID is separated by a comma.","example":"pvFIYKSDTum9iCDOOtQL4w,_FsqLyI0RlO6LVPeUVWi8g"}},"additionalProperties":false,"description":"Information about the webinar or meeting recording."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.alertEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the meeting."},"object":{"required":["duration","host_id","id","issues","start_time","topic","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The meeting ID."},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type: \n* `0` — A prescheduled meeting. \n* `1` — An instant meeting. \n* `2` — A scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` — A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` — A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"pattern":"(^\\s*$|^\\d{4}-\\d{1,2}-\\d{1,2}T\\d{1,2}:\\d{1,2}:\\d{1,2}Z$)","type":"string","description":"The meeting's start time."},"timezone":{"type":"string","description":"The meeting's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"duration":{"type":"integer","description":"The scheduled meeting duration."},"issues":{"type":"array","description":"A list of issues that occurred during the meeting: \n* `Unstable audio quality` \n* `Unstable video quality` \n* `Unstable screen share quality` \n* `High CPU occupation` \n* `Call Reconnection`","items":{"type":"string","enum":["Unstable audio quality","Unstable video quality","Unstable screen share quality","High CPU occupation","Call Reconnection"]}}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.chat_message_file_sentEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"The timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who hosted the meeting."},"object":{"required":["chat_message_file","meeting_id","meeting_uuid"],"type":"object","properties":{"meeting_id":{"type":"integer","description":"The meeting ID.","format":"int64"},"meeting_uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates its own meeting UUID."},"breakout_room_uuid":{"type":"string","description":"The breakout room's universally unique identifier (UUID). Each breakout room instance generates a breakout room UUID."},"chat_message_file":{"required":["date_time","download_url","file_id","file_name","file_size","file_type","message_id","recipient_context","recipient_type","sender_context","sender_name","sender_session_id","sender_type"],"type":"object","properties":{"date_time":{"type":"string","description":"The date and time when the chat message was sent.","format":"date-time"},"sender_session_id":{"type":"string","description":"The message sender's session ID."},"sender_name":{"type":"string","description":"The message sender's name."},"sender_email":{"type":"string","description":"The message sender's email address.","format":"email"},"sender_type":{"type":"string","description":"The type of user that sent the message. \n* `host` - The meeting host. \n* `guest` - A meeting guest.","enum":["host","guest"]},"sender_context":{"type":"string","description":"The context where the sender is located when the message is generated. \n* `meeting` - The sender is in a meeting. \n* `breakout_room` - The sender is in a breakout room.","enum":["meeting","breakout_room"]},"recipient_session_id":{"type":"string","description":"The message recipient's session ID."},"recipient_name":{"type":"string","description":"The message recipient's name."},"recipient_email":{"type":"string","description":"The message recipient's email address. Optional only included if it is a private message.","format":"email"},"recipient_type":{"type":"string","description":"The type of message recipient. \n* `everyone` - All meeting participants. \n* `host` - The meeting host. \n* `guest` - A meeting guest. \n* `group` - A group chat. \n* `host_group` - The meeting host and all co-hosts.","enum":["everyone","host","guest","group","host_group"]},"recipient_context":{"type":"string","description":"The context where the recipient is located when the message is delivered. \n* `meeting` - The recipient is in the meeting. \n* `breakout_room` - The sender is in a breakout room.","enum":["meeting","breakout_room"]},"message_id":{"type":"string","description":"The chat message's UUID."},"file_id":{"type":"string","description":"The live meeting chat file's UUID, in base64-encoded format."},"file_name":{"type":"string","description":"The live meeting chat file's name."},"file_size":{"type":"integer","description":"The live meeting chat file's size, in bytes."},"file_type":{"type":"string","description":"The live meeting chat file's type."},"download_url":{"type":"string","description":"The live meeting chat file's download URL."}},"additionalProperties":false,"description":"Information about the chat message file."}},"additionalProperties":false,"description":"Information about the chat message file."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.deletedEvent":{"required":["event","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who deleted the meeting."},"operator":{"type":"string","description":"The email address of the user who deleted the meeting."},"operator_id":{"type":"string","description":"The user ID of the user who deleted the meeting."},"operation":{"type":"string","description":"The type of operation performed on a recurring meeting.\n* `all` - The change was applied to all occurrences.\n* `single` - The change was applied to a single occurrence.\n* `range` - The change was applied to a range of occurrences while the other occurrences are unchanged. To enable this feature for your account, please [contact Zoom Support](https://support.zoom.us/hc/en-us).","enum":["all","single","range"]},"object":{"required":["host_id","id","type","uuid"],"type":"object","properties":{"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"id":{"type":"integer","description":"The meeting ID.","format":"int64"},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type: \n* `0` — A prescheduled meeting. \n* `1` — An instant meeting. \n* `2` — A scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` — A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` — A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"type":"string","description":"The meeting's start time.","format":"date-time"},"duration":{"type":"integer","description":"The scheduled meeting duration."},"timezone":{"type":"string","description":"The meeting's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"recurrence_event_id":{"type":"string","description":"The unique identifier of the recurring event that the occurrences belong to. Updating a recurring meeting with **This and following events** splits it into two recurring events, each with its own `recurrence_event_id`. To enable this feature for your account, please [contact Zoom Support](https://support.zoom.us/hc/en-us)."},"occurrences":{"type":"array","description":"Information about recurring meetings with fixed times and their occurrences. This only returns when the meeting's `type` value is `8`.","items":{"anyOf":[{"required":["occurrence_id","start_time"],"type":"object","properties":{"occurrence_id":{"type":"string","description":"The meeting occurrence's ID."},"start_time":{"type":"string","description":"The meeting's start time.","format":"date-time"}},"additionalProperties":true}]}}},"additionalProperties":true,"description":"Information about the meeting."}},"additionalProperties":true}},"additionalProperties":true},"Meeting.participant_joinedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the meeting."},"object":{"required":["duration","host_id","participant","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The meeting ID."},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type. \n* `0` - A prescheduled meeting. \n* `1` - An instant meeting. \n* `2` - A scheduled meeting. \n* `3` - A recurring meeting with no fixed time. \n* `4` - A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` - A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` - A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"pattern":"(^\\s*$|^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$)","type":"string","description":"The meeting's start time."},"timezone":{"type":"string","description":"The meeting's [timezone](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones)."},"duration":{"type":"integer","description":"The scheduled meeting duration."},"participant":{"required":["email","join_time","user_id","user_name"],"type":"object","properties":{"user_id":{"type":"string","description":"The participant's meeting user ID. This value is assigned to a participant when they join a meeting, and is only valid for the duration of the meeting."},"user_name":{"type":"string","description":"The participant's display name."},"id":{"type":"string","description":"The participant's universally unique ID (UUID). \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value. \n\n This value returns blank for external users.\n\n**Note:** Use the `participant_user_id` value instead of this value. We will remove this response in a future release."},"participant_uuid":{"type":"string","description":"The participant's UUID for this specific meeting and any breakout rooms created in this meeting. This value is assigned to a participant when they join a meeting, and is only valid for the duration of that meeting."},"join_time":{"type":"string","description":"The time when the participant joined the meeting.","format":"date-time"},"email":{"type":"string","description":"The participant's email address. This response only returns if the participant joined the meeting by logging into Zoom. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details.","format":"email"},"registrant_id":{"type":"string","description":"The participant's registrant ID. A host or a user with administrative permissions can require [registration for Zoom meetings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065026)."},"participant_user_id":{"type":"string","description":"The participant's universally unique ID (UUID). \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value.\n\n This value returns blank for external users."},"customer_key":{"type":"string","description":"The participant's SDK identifier. This value can be alphanumeric."},"phone_number":{"type":"string","description":"Phone number of participant joined via PSTN.","example":"8615250064084"}},"additionalProperties":false,"description":"Information about the meeting participant. If the participant is **not** part of the host's account, `email` returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"User.tsp_deletedEvent":{"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who deleted the TSP."},"operator":{"type":"string","description":"The email address of the user who deleted the TSP.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who deleted the TSP."},"object":{"type":"object","properties":{"id":{"type":"string","description":"The user's ID."},"email":{"type":"string","description":"The user's email address."},"tsp_credentials":{"type":"object","properties":{"conference_code":{"type":"string","description":"The TSP conference code."},"leader_pin":{"type":"string","description":"The leader PIN."},"tsp_bridge":{"type":"string","description":"The TSP bridge zone."},"dial_in_numbers":{"type":"array","description":"Information about the TSP dial-in numbers.","items":{"type":"object","properties":{"code":{"type":"string","description":"The country code."},"number":{"type":"string","description":"The dial-in phone number."},"type":{"type":"string","description":"The type of the phone number: \n* `toll` — Toll number. \n* `tollfree` — Toll free number. \n* `media_link` — Media link.","enum":["toll","tollfree","media_link"]},"country_label":{"type":"string","description":"The TSP country label: \n* `US_TSP_TB` \n* `EU_TSP_TB`","enum":["US_TSP_TB","EU_TSP_TB"]}}}}},"description":"Information about the deleted user's TSP credentials."}},"description":"Information about the deleted user."}}}}},"Meeting.ai_companion_startedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"The timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user that hosted the meeting."},"object":{"required":["ai_companion","host_id","meeting_number","meeting_uuid"],"type":"object","properties":{"meeting_number":{"type":"integer","description":"The meeting number.","format":"int64"},"meeting_uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID)."},"host_id":{"type":"string","description":"The ID of the user set as the host of the meeting."},"ai_companion":{"type":"object","properties":{"questions":{"type":"boolean","description":"Whether the AI Companion's meeting questions feature was started."},"summary":{"type":"boolean","description":"Whether the AI Companion's meeting summary feature was started."}},"additionalProperties":false,"description":"The AI Companion features that were started."}},"additionalProperties":false,"description":"The meeting where the AI Companion was started."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.invitation_dispatchedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The meeting host's account ID."},"operator":{"type":"string","description":"The email address of the user who sent the meeting invitation."},"operator_id":{"type":"string","description":"The user ID of the user who sent the meeting invitation."},"object":{"required":["host_id","id","participant","topic","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The meeting ID."},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"participant":{"required":["email","participant_user_id"],"type":"object","properties":{"participant_user_id":{"type":"string","description":"The user ID of the user who received the meeting invitation."},"email":{"type":"string","description":"The email address of the user who received the meeting invitation. If the participant is **not** part of the host's account, the `email` field returns an empty string value, with some exceptions. For more information, read our [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) documentation.","format":"email"}},"additionalProperties":false,"description":"Information about the invited participant."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Webinar.endedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who ended the webinar."},"object":{"required":["duration","host_email","host_id","id","start_time","timezone","topic","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The webinar ID."},"uuid":{"type":"string","description":"The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."},"host_id":{"type":"string","description":"The webinar host's user ID."},"host_email":{"type":"string","description":"The meeting host's email address.","format":"email"},"topic":{"type":"string","description":"The webinar's topic."},"type":{"type":"integer","description":"The webinar type. \n* `5` - A webinar. \n* `6` - A recurring webinar without a fixed time. \n* `9` - A recurring webinar with a fixed time.","enum":[5,6,9]},"start_time":{"type":"string","description":"The webinar's start time.","format":"date-time"},"timezone":{"type":"string","description":"The webinar's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"end_time":{"type":"string","description":"The date and time when the webinar ended.","format":"date-time"},"duration":{"type":"integer","description":"The scheduled webinar duration."},"practice_session":{"type":"boolean","description":"whether this webinar is a practice session."}},"additionalProperties":false,"description":"Information about the webinar."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.converted_to_webinarEvent":{"required":["event","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who converted the meeting into a webinar."},"operator":{"type":"string","description":"The email address of the user who converted the meeting into a webinar."},"operator_id":{"type":"string","description":"The user ID of the user who converted the meeting into a webinar."},"object":{"required":["host_id","id","type","uuid"],"type":"object","properties":{"uuid":{"type":"string","description":"The webinar's universally unique identifier (UUID)."},"id":{"type":"integer","description":"The webinar ID.","format":"int64"},"host_id":{"type":"string","description":"The webinar host's user ID."},"topic":{"type":"string","description":"The webinar's topic."},"type":{"type":"integer","description":"The webinar type.\n\n* `5` - A scheduled webinar.\n* `6` - A recurring webinar with no fixed time.\n* `9` - A recurring webinar with fixed time.","enum":[5,6,9]},"start_time":{"type":"string","description":"The scheduled webinar's start time. Returned only when the webinar type is `5`, a scheduled webinar.","format":"date-time"},"duration":{"type":"integer","description":"The scheduled webinar's duration, in minutes. Returned only when the webinar type is `5`, ascheduled webinar."},"timezone":{"type":"string","description":"The webinar's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."}},"additionalProperties":true,"description":"Information about the webinar converted from a meeting."}},"additionalProperties":true}},"additionalProperties":true},"Webinar.recoveredEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who recovered the webinar."},"operator":{"type":"string","description":"The email address of the user who recovered the webinar.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who recovered the webinar."},"operation":{"type":"string","description":"The type of operation performed: \n* `all` — The change was applied to all webinars. \n* `single` — The change was applied only to a single webinar.","enum":["all","single"]},"object":{"required":["duration","host_id","id","start_time","timezone","topic","type","uuid"],"type":"object","properties":{"uuid":{"type":"string","description":"The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."},"id":{"type":"integer","description":"The webinar ID.","format":"int64"},"host_id":{"type":"string","description":"The webinar host's user ID."},"topic":{"type":"string","description":"The webinar's topic."},"type":{"type":"integer","description":"The webinar type: \n* `5` — A webinar. \n* `6` — A recurring webinar without a fixed time. \n* `9` — A recurring webinar with a fixed time.","enum":[5,6,9]},"start_time":{"type":"string","description":"The webinar's start time.","format":"date-time"},"duration":{"type":"integer","description":"The scheduled webinar duration."},"timezone":{"type":"string","description":"The webinar's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"occurrences":{"type":"array","description":"Information about recurring webinars with fixed times and their occurrences. This only returns when the webinar's `type` value is `9`.","items":{"anyOf":[{"required":["occurrence_id","start_time"],"type":"object","properties":{"occurrence_id":{"type":"string","description":"The webinar occurrence's ID."},"start_time":{"type":"string","description":"The webinar's start time.","format":"date-time"}},"additionalProperties":false}]}}},"additionalProperties":false,"description":"Information about the webinar."}},"additionalProperties":false}},"additionalProperties":false},"Webinar.participant_role_changedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the webinar."},"object":{"required":["duration","host_id","id","participant","start_time","timezone","topic","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The webinar ID."},"uuid":{"type":"string","description":"The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."},"host_id":{"type":"string","description":"The webinar host's user ID."},"topic":{"type":"string","description":"The webinar's topic."},"type":{"type":"integer","description":"The webinar type: \n* `5` — A webinar. \n* `6` — A recurring webinar without a fixed time. \n* `9` — A recurring webinar with a fixed time.","enum":[5,6,9]},"start_time":{"pattern":"(^\\s*$|^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$)","type":"string","description":"The webinar's start time.","format":"date-time"},"timezone":{"type":"string","description":"The webinar's [timezone](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones)."},"duration":{"type":"integer","description":"The scheduled webinar duration."},"participant":{"required":["date_time","email","new_role","old_role","user_id","user_name"],"type":"object","properties":{"user_id":{"type":"string","description":"The participant's webinar user ID. This value is assigned to a participant upon joining a webinar and is only valid for the duration of the webinar."},"user_name":{"type":"string","description":"The participant's display name."},"email":{"type":"string","description":"The participant's email address. This response only returns if the participant joined the webinar by logging into Zoom. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. For more information, read our [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) documentation.","format":"email"},"registrant_id":{"type":"string","description":"The participant's registrant ID. (A host or a user with administrative permissions can require [registration for Zoom meetings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065026))."},"participant_user_id":{"type":"string","description":"The participant's universally unique ID (UUID). \n* If the participant joins the webinar by logging into Zoom, this value is the `id` value in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the webinar **without** logging into Zoom, this returns an empty string value.\n\nThis value returns blank for external users"},"participant_uuid":{"type":"string","description":"The participant's UUID for this specific webinar. This value is assigned to a participant when they join a webinar, and is only valid for the duration of that webinar."},"date_time":{"type":"string","description":"The time when the participant changed the [role](https://support.zoom.us/hc/en-us/articles/360000252726-Roles-in-a-Zoom-Webinar).","format":"date-time"},"old_role":{"type":"string","description":"The participant's previous role. \n* `host` — Host. \n* `co-host` — Co-host. \n* `attendee` — Attendee.","enum":["host","co-host","attendee"]},"new_role":{"type":"string","description":"The participant's new role. \n* `host` — Host. \n* `co-host` — Co-host. \n* `attendee` — Attendee.","enum":["host","co-host","attendee"]}},"additionalProperties":false,"description":"Information about the webinar participant."}},"additionalProperties":false,"description":"Information about the webinar."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.participant_jbh_waiting_leftEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the meeting."},"object":{"required":["duration","host_id","id","participant","start_time","topic","type","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The meeting ID.","format":"int64"},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type. \n* `0` - A prescheduled meeting. \n* `1` - An instant meeting. \n* `2` - A scheduled meeting. \n* `3` - A recurring meeting with no fixed time. \n* `4` - A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` - A [PAC (personal audio conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` - A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"type":"string","description":"The meeting's start time.","format":"date-time"},"timezone":{"type":"string","description":"The meeting's [timezone](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones)."},"duration":{"type":"integer","description":"The scheduled meeting duration."},"participant":{"required":["user_name"],"type":"object","properties":{"id":{"type":"string","description":"The participant's universally unique ID (UUID). \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value."},"user_name":{"type":"string","description":"The participant's display name."},"customer_key":{"type":"string","description":"The participant's SDK identifier. This value can be alphanumeric."},"registrant_id":{"type":"string","description":"The participant's registrant ID. A host or a user with administrative permissions can require [registration for Zoom meetings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065026)."}},"additionalProperties":false,"description":"Information about the meeting participant."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"User.tsp_createdEvent":{"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the TSP."},"operator":{"type":"string","description":"The email address of the user who created the TSP.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who created the TSP."},"object":{"type":"object","properties":{"id":{"type":"string","description":"The user's ID."},"email":{"type":"string","description":"The user's email address.","format":"email"},"tsp_credentials":{"type":"object","properties":{"conference_code":{"type":"string","description":"The TSP conference code."},"leader_pin":{"type":"string","description":"The leader PIN."},"tsp_bridge":{"type":"string","description":"The TSP bridge zone."},"dial_in_numbers":{"type":"array","description":"Information about the TSP dial-in numbers.","items":{"type":"object","properties":{"code":{"type":"string","description":"The country code."},"number":{"type":"string","description":"The dial-in phone number."},"type":{"type":"string","description":"The type of the phone number: \n* `toll` — Toll number. \n* `tollfree` — Toll free number. \n* `media_link` — Media link.","enum":["toll","tollfree","media_link"]},"country_label":{"type":"string","description":"The TSP country label: \n* `US_TSP_TB` \n* `EU_TSP_TB`","enum":["US_TSP_TB","EU_TSP_TB"]}}}}},"description":"Information about the user's TSP credentials."}},"description":"Information about the created user."}}}}},"Meeting.breakout_room_sharing_endedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The main meeting host's account ID."},"object":{"required":["breakout_room_uuid","duration","host_id","id","participant","start_time","topic","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The main meeting ID."},"uuid":{"type":"string","description":"The main meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"breakout_room_uuid":{"type":"string","description":"The breakout room's universally unique identifier (UUID). Each breakout room instance generates a breakout room UUID."},"host_id":{"type":"string","description":"The main meeting host's user ID."},"topic":{"type":"string","description":"The main meeting's topic."},"type":{"type":"integer","description":"The main meeting type: \n* `0` — A prescheduled meeting. \n* `1` — An instant meeting. \n* `2` — A scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` — A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` — A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"pattern":"(^\\s*$|^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$)","type":"string","description":"The main meeting's start time."},"timezone":{"type":"string","description":"The main meeting's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"duration":{"type":"integer","description":"The main scheduled meeting duration."},"participant":{"required":["sharing_details","user_id"],"type":"object","properties":{"user_id":{"type":"string","description":"The participant's meeting user ID. This value is assigned to a participant upon joining a meeting and is only valid for the duration of the meeting."},"parent_user_id":{"type":"string","description":"The participant's main meeting user ID (`user_id`)."},"user_name":{"type":"string","description":"The participant's display name."},"id":{"type":"string","description":"The participant's universally unique ID (UUID): \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value."},"sharing_details":{"required":["content","date_time","file_link","link_source","source"],"type":"object","properties":{"content":{"type":"string","description":"The type of shared content: \n* `application` — An application. For example, a web browser. \n* `whiteboard` — The [classic whiteboard](https://support.zoom.us/hc/en-us/articles/205677665-Sharing-a-whiteboard). \n* `desktop` — A user's desktop. \n* `airplay` — A user's airplay. \n* `camera` — A user's camera. \n* `unknown` — An unrecognized application, such as a third party app.","enum":["application","whiteboard","desktop","airplay","camera","unknown"]},"link_source":{"type":"string","description":"The Dropbox sharing method: \n* `deep_link` — A [deep link](https://en.wikipedia.org/wiki/Deep_linking). \n* `in_meeting` — A link shared via Zoom. \n* An empty string value if the link source is **not** a Dropbox link.","enum":["","deep_link","in_meeting"]},"file_link":{"type":"string","description":"The Dropbox file's link. This field returns an empty string value if the file link is **not** from a Dropbox source."},"date_time":{"type":"string","description":"The screenshare's date and time.","format":"date-time"},"source":{"type":"string","description":"The source from which the file was shared: \n* `dropbox` — A Dropbox source. \n* An empty string value if the source is **not** Dropbox.","enum":["","dropbox"]}},"additionalProperties":false,"description":"Information about the meeting's screenshare."}},"additionalProperties":false,"description":"Information about the meeting participant."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.updatedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object","old_object","operator","operator_id","time_stamp"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who updated the meeting."},"operator":{"type":"string","description":"The email address of the user who updated the meeting.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who updated the meeting."},"scope":{"type":"string","description":"The type of operation performed on a recurring meeting.\n* `all` - The change was applied to all occurrences.\n* `single` - The change was applied to a single occurrence.\n* `range` - The change was applied to a range of occurrences while the other occurrences are unchanged. To enable this feature for your account, please [contact Zoom Support](https://support.zoom.us/hc/en-us).","enum":["single","all","range"]},"object":{"required":["id"],"type":"object","properties":{"id":{"type":"integer","description":"The meeting ID.","format":"int64"},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type. \n* `0` - A prescheduled meeting. \n* `1` - An instant meeting. \n* `2` - A scheduled meeting. \n* `3` - A recurring meeting with no fixed time. \n* `4` - A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` - A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` - A recurring meeting with a fixed time. \n* `10` - A screen share only meeting.","enum":[0,1,2,3,4,7,8,10]},"start_time":{"type":"string","description":"The meeting's start time.","format":"date-time"},"duration":{"type":"integer","description":"The scheduled meeting duration."},"timezone":{"type":"string","description":"The meeting's [timezone](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones)."},"join_url":{"type":"string","description":"The URL participants use to join the meeting."},"password":{"type":"string","description":"The password required to join the meeting."},"agenda":{"type":"string","description":"The meeting's agenda."},"registration_url":{"type":"string","description":"The meeting's registration URL."},"recurrence_event_id":{"type":"string","description":"The unique identifier of the recurring event that the occurrences belong to. Updating a recurring meeting with **This and following events** splits it into two recurring events, each with its own `recurrence_event_id`. To enable this feature for your account, please [contact Zoom Support](https://support.zoom.us/hc/en-us)."},"occurrences":{"type":"array","description":"Information about recurring meetings with fixed times and their occurrences. This only returns when the meeting's `type` value is `8`.","items":{"required":["occurrence_id","start_time"],"type":"object","properties":{"occurrence_id":{"type":"string","description":"The meeting occurrence's ID."},"start_time":{"type":"string","description":"The meeting's start time.","format":"date-time"},"duration":{"type":"integer","description":"The scheduled meeting duration."},"status":{"type":"string","description":"The meeting occurrence status. \n* `available` \n* `deleted`","enum":["available","deleted"]}},"additionalProperties":true}},"settings":{"type":"object","properties":{"host_video":{"type":"boolean","description":"Whether to start the meeting with the host's video on."},"participant_video":{"type":"boolean","description":"Whether to turn a participant's video on when they join the meeting. Participants can change this setting during the meeting."},"join_before_host":{"type":"boolean","description":"Whether to [allow participants to join the meeting before host arrives](https://support.zoom.us/hc/en-us/articles/202828525-Allow-participants-to-join-before-host)."},"jbh_time":{"type":"integer","description":"If the value of the `join_before_host` field is `true`, this field indicates the time limits when a participant can join a meeting before the meeting's host.\n\n* `0` - Allow the participant to join the meeting at any time.\n* `5` - Allow the participant to join 5 minutes before the meeting's start time.\n* `10` - Allow the participant to join 10 minutes before the meeting's start time.","enum":[0,5,10]},"mute_upon_entry":{"type":"boolean","description":"Whether participants are muted upon entry."},"audio":{"type":"string","description":"The available audio options for participants joining the meeting. \n* `telephony` - Telephony only. \n* `voip` - VoIP only. \n* `both` - Both Telephony and VoIP.","enum":["telephony","voip","both"]},"auto_recording":{"type":"string","description":"The [automatic recording](https://support.zoom.us/hc/en-us/articles/202921119-Automatic-Recording) settings for the meeting.\n\n* `local` - Record and save to the local device.\n* `cloud` - Record and save to the cloud.\n* `none` - Automatic recording disabled.","enum":["local","cloud","none"]},"disable_recording_control":{"type":"string","description":"Which recording options are unavailable to the in-meeting host through the Zoom client.\n\n* `none` - All recording options are available to the host. This is the default. \n* `all` - All recording options are unavailable to the host. \n\nNot supported when `auto_recording` is set to `local`.","default":"none","enum":["none","all"]},"use_pmi":{"type":"boolean","description":"Whether to use a [Personal Meeting ID (PMI)](https://support.zoom.us/hc/en-us/articles/203276937-Using-Personal-Meeting-ID-PMI) instead of an auto-generated meeting ID. PMIs are only available for scheduled meetings, instant meetings, and recurring meetings with no fixed time."},"waiting_room":{"type":"boolean","description":"Whether to enable a [waiting room](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room)."},"watermark":{"type":"boolean","description":"Whether to enable the [watermark](https://support.zoom.us/hc/en-us/articles/209605273-Adding-a-Watermark) feature."},"enforce_login":{"type":"boolean","description":"Whether to only allow signed in users to join the meeting."},"enforce_login_domains":{"type":"string","description":"A list of the domains allowed to join the meeting."},"approval_type":{"type":"integer","description":"The [approval type](https://support.zoom.us/hc/en-us/articles/211579443-Scheduling-a-meeting-with-registration) for meeting registrants. \n* `0` - Automatically approve registrants. \n* `1` - Manually approve registrants. \n* `2` - Meeting registration not required.","enum":[0,1,2]},"registration_type":{"type":"integer","description":"The meeting registration setting for recurring meetings. \n* `1` - Attendees register once and can attend any of the meeting occurrences. \n* `2` - Attendees must register for each occurrence to attend. \n* `3` - Attendees register once and can select one or more occurrences to attend.","enum":[1,2,3]},"alternative_hosts":{"type":"string","description":"A semicolon-separated list of the meeting's alternative hosts' email addresses or IDs."},"meeting_authentication":{"type":"boolean","description":"Whether only authenticated users can join the meeting."},"authentication_option":{"type":"string","description":"The [authentication](https://support.zoom.us/hc/en-us/articles/4406604615693) option ID value."},"authentication_name":{"type":"string","description":"The authentication name set in the [authentication profile](https://support.zoom.us/hc/en-us/articles/360037117472)."},"authentication_domains":{"type":"string","description":"A list of the allowed authenticated domains."},"meeting_invitees":{"type":"array","description":"A list of the meeting's invitees.","items":{"type":"object","properties":{"email":{"type":"string","description":"The invitee's email address.","format":"email"}}}},"language_interpretation":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable [language interpretation](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064768) for the meeting."},"interpreters":{"type":"array","description":"Information about the meeting's language interpreters.","items":{"type":"object","properties":{"email":{"type":"string","description":"The interpreter's email address.","format":"email"},"languages":{"type":"string","description":"A comma-separated list of the interpreter's languages. The string must contain exactly two country IDs.\n\nOnly system-supported languages are allowed: `US` (English), `CN` (Chinese), `JP` (Japanese), `DE` (German), `FR` (French), `RU` (Russian), `PT` (Portuguese), `ES` (Spanish), and `KR` (Korean).\n\nFor example, to set an interpreter translating from English to Chinese, use `US,CN`.","deprecated":true},"interpreter_languages":{"type":"string","description":"A comma-separated list of the interpreter's languages. The string must contain exactly two languages.\n\nTo get this value, use the `language_interpretation` object's `languages` and `custom_languages` values in the [**Get user settings**](https://developers.zoom.us/docs/api/users/#tag/users/GET/users/{userId}/settings) API response.\n\n**languages**: System-supported languages include `English`, `Chinese`, `Japanese`, `German`, `French`, `Russian`, `Portuguese`, `Spanish`, and `Korean`.\n\n**custom_languages**: User-defined languages added by the user.\n\nFor example, an interpreter translating between English and French should use `English,French`."}}}}},"description":"The meeting's [language interpretation settings](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** This feature is only available for certain Meeting add-on, Education, and Business and higher plans. If this feature is not enabled on the host's account, this setting will **not** be applied to the meeting."},"sign_language_interpretation":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable [sign language interpretation](https://support.zoom.us/hc/en-us/articles/9644962487309-Using-sign-language-interpretation-in-a-meeting-or-webinar) for the meeting."},"interpreters":{"maximum":20,"type":"array","description":"Information about the meeting's sign language interpreters.","items":{"type":"object","properties":{"email":{"type":"string","description":"The interpreter's email address.","format":"email"},"sign_language":{"type":"string","description":"The interpreter's sign language. \n\n To get this value, use the `sign_language_interpretation` object's `languages` and `custom_languages` values in the [**Get user settings**](/api-reference/zoom-api/methods#operation/userSettings) API response."}}}}},"description":"The meeting's [sign language interpretation settings](https://support.zoom.us/hc/en-us/articles/9644962487309-Using-sign-language-interpretation-in-a-meeting-or-webinar). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** If this feature is not enabled on the host's account, this setting will **not** be applied to the meeting."},"continuous_meeting_chat":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable the **Enable continuous meeting chat** setting."},"auto_add_invited_external_users":{"type":"boolean","description":"Whether to enable the **Automatically add invited external users** setting.","deprecated":true},"auto_add_meeting_participants":{"type":"boolean","description":"Whether to enable the **Automatically add meeting participants** setting.","deprecated":true},"channel_id":{"type":"string","description":"The channel's ID."}},"description":"Information about the **Enable continuous meeting chat** feature."},"auto_start_meeting_summary":{"type":"boolean","description":"Whether to automatically start a meeting summary."},"who_will_receive_summary":{"type":"integer","description":"Defines who will receive a summary after this meeting. This field is applicable only when `auto_start_meeting_summary` is set to `true`.\r\n* `1` - Only meeting host.\r\n* `2` - Only meeting host, co-hosts, and alternative hosts.\r\n* `3` - Only meeting host and meeting invitees in our organization.\r\n* `4` - All meeting invitees including those outside of our organization.","enum":[1,2,3,4]},"auto_start_ai_companion_questions":{"type":"boolean","description":"Whether to automatically start AI Companion questions."},"who_can_ask_questions":{"type":"integer","description":"Defines who can ask questions about this meeting's transcript. This field is applicable only when `auto_start_ai_companion_questions` is set to `true`.\r\n* `1` - All participants and invitees.\r\n* `2` - All participants only from when they join.\r\n* `3` - Only meeting host.\r\n* `4` - Participants and invitees in our organization.\r\n* `5` - Participants in our organization only from when they join.","enum":[1,2,3,4,5]},"summary_template_id":{"type":"string","description":"The summary template ID used to generate a meeting summary based on a predefined template. To get available summary templates, use the **Get user summary templates** API. To enable this feature for your account, please [contact Zoom Support](https://support.zoom.com/hc/en)."},"allow_host_control_participant_mute_state":{"type":"boolean","description":"Whether to allow host and co-hosts to fully control the mute state of participants."},"email_in_attendee_report":{"type":"boolean","description":"Whether to include authenticated guest's email addresses in meetings' attendee reports."},"prevent_screen_capture":{"type":"boolean","description":"Whether to prevent participants from capturing Zoom meeting windows, which may include shared meeting content and chat messages. If not provided, the default value will be based on the user's setting."}},"additionalProperties":true,"description":"Information about the updated meeting settings. This **only** returns updated meeting settings."},"recurrence":{"type":"object","properties":{"type":{"type":"integer","description":"The type of recurring meeting. \n* `1` - Daily. \n* `2` - Weekly. \n* `3` - Monthly.","enum":[1,2,3]},"repeat_interval":{"type":"integer","description":"The meeting's repeat interval. \n* For daily intervals, a max of `99` days. \n* For a weekly interval, a max of `50` weeks. \n* For monthly intervals, a max of `10` months."},"weekly_days":{"type":"string","description":"A comma-separated list of the days of the week when the recurring weekly meeting occurs. \n* `1` - Sunday \n* `2` - Monday \n* `3` - Tuesday \n* `4` - Wednesday \n* `5` - Thursday \n* `6` - Friday \n* `7` - Saturday","enum":["1","2","3","4","5","6","7"]},"monthly_day":{"maximum":31,"minimum":1,"type":"integer","description":"The day of the month when the recurring monthly meeting occurs. The value ranges from 1 to 31."},"monthly_week_day":{"type":"integer","description":"The day of the week when the recurring monthly meeting is scheduled. \n* `1` - Sunday \n* `2` - Monday \n* `3` - Tuesday \n* `4` - Wednesday \n* `5` - Thursday \n* `6` - Friday \n* `7` - Saturday","enum":[1,2,3,4,5,6,7]},"end_times":{"type":"integer","description":"The number of times the recurring meeting will occur before it is canceled."},"end_date_time":{"type":"string","description":"The recurring meeting's final ending date and time before it is canceled, in UTC format.","format":"date-time"},"monthly_week":{"type":"integer","description":"The week of the month when a recurring meeting occurs. \n* `-1` - The last week of the month. \n* `1` - The first week. \n* `2` - The second week. \n* `3` - The third week. \n* `4` - The fourth week.","enum":[-1,1,2,3,4]}},"additionalProperties":true,"description":"Information about [recurring meetings](https://developers.zoom.us/docs/api/rest/other-references/recurrence-object-definitions/)."},"tracking_fields":{"type":"array","description":"Information about the meeting's [tracking fields](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields).","items":{"type":"object","properties":{"field":{"type":"string","description":"The tracking field's label."},"value":{"type":"string","description":"The tracking field's value."}},"additionalProperties":true}}},"additionalProperties":true,"description":"Information about the meeting."},"time_stamp":{"type":"integer","description":"The meeting's update timestamp, in milliseconds.","format":"int64"},"old_object":{"$ref":"#/properties/payload/properties/object"}},"additionalProperties":true}},"additionalProperties":true},"Meeting.ai_companion_stoppedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user that hosted the meeting."},"object":{"required":["ai_companion","host_id","meeting_number","meeting_uuid"],"type":"object","properties":{"meeting_number":{"type":"integer","description":"The meeting ID.","format":"int64"},"meeting_uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID)."},"host_id":{"type":"string","description":"The ID of the user set as the host of the meeting."},"ai_companion":{"type":"object","properties":{"questions":{"type":"boolean","description":"Whether the AI Companion's meeting questions feature was stopped."},"summary":{"type":"boolean","description":"Whether the AI Companion's meeting summary feature was stopped."}},"additionalProperties":false,"description":"The AI Companion features that were stopped."}},"additionalProperties":false,"description":"The meeting where the AI Companion was stopped."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.registration_deniedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the meeting."},"operator":{"type":"string","description":"The email address of the user who denied the meeting registration.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who denied the meeting registration."},"object":{"required":["duration","host_id","id","registrant","start_time","timezone","topic","type","uuid"],"type":"object","properties":{"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"id":{"type":"integer","description":"The meeting ID.","format":"int64"},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type: \n* `0` — A prescheduled meeting. \n* `1` — An instant meeting. \n* `2` — A scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` — A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` — A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"type":"string","description":"The meeting's start time.","format":"date-time"},"duration":{"type":"integer","description":"The scheduled meeting duration."},"timezone":{"type":"string","description":"The meeting's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"occurrences":{"type":"array","description":"Information about recurring meetings with fixed times and their occurrences. This only returns when the meeting's `type` value is `8`.","items":{"anyOf":[{"required":["occurrence_id","start_time"],"type":"object","properties":{"occurrence_id":{"type":"string","description":"The meeting occurrence's ID."},"start_time":{"type":"string","description":"The meeting's start time."}},"additionalProperties":true}]}},"registrant":{"required":["email","first_name","id"],"type":"object","properties":{"id":{"type":"string","description":"The registrant's ID."},"first_name":{"type":"string","description":"The registrant's first name."},"last_name":{"type":"string","description":"The registrant's last name."},"email":{"type":"string","description":"The registrant's email address.","format":"email"}},"additionalProperties":true,"description":"Information about the meeting registrant."}},"additionalProperties":true,"description":"Information about the meeting registration."}},"additionalProperties":true}},"additionalProperties":true},"Webinar.registration_deniedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the webinar."},"operator":{"type":"string","description":"The email address of the user who denied the webinar registration.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who denied the webinar registration."},"object":{"required":["duration","host_id","id","registrant","start_time","timezone","topic","type","uuid"],"type":"object","properties":{"uuid":{"type":"string","description":"The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."},"id":{"type":"integer","description":"The webinar ID."},"host_id":{"type":"string","description":"The webinar host's user ID."},"topic":{"type":"string","description":"The webinar's topic."},"type":{"type":"integer","description":"The webinar type: \n* `5` — A webinar. \n* `6` — A recurring webinar without a fixed time. \n* `9` — A recurring webinar with a fixed time.","enum":[5,6,9]},"start_time":{"type":"string","description":"The webinar's start time.","format":"date-time"},"duration":{"type":"integer","description":"The scheduled webinar duration."},"timezone":{"type":"string","description":"The webinar's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"occurrences":{"type":"array","description":"Information about recurring webinars with fixed times and their occurrences. This only returns when the webinar's `type` value is `9`.","items":{"anyOf":[{"required":["occurrence_id","start_time"],"type":"object","properties":{"occurrence_id":{"type":"string","description":"The webinar occurrence's ID."},"start_time":{"type":"string","description":"The webinar's start time.","format":"date-time"}},"additionalProperties":false}]}},"registrant":{"required":["email","first_name","id"],"type":"object","properties":{"id":{"type":"string","description":"The registrant's ID."},"first_name":{"type":"string","description":"The registrant's first name."},"last_name":{"type":"string","description":"The registrant's last name."},"email":{"type":"string","description":"The registrant's email address.","format":"email"},"tracking_source":{"required":["id","source_name","tracking_url"],"type":"object","properties":{"id":{"type":"string","description":"Unique Identifier of the tracking source."},"source_name":{"type":"string","description":"Name of the source (platform) where the registration URL was shared."},"tracking_url":{"type":"string","description":"Tracking URL. The URL that was shared for the registration."}},"additionalProperties":false,"description":"Information about the source tracking. See [Creating webinar registration tracking links](https://support.zoom.us/hc/en-us/articles/360000315683-Creating-webinar-registration-tracking-links) for details."}},"additionalProperties":false,"description":"Information about the webinar registrant."}},"additionalProperties":false,"description":"Information about the webinar registration."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.registration_approvedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the meeting."},"operator":{"type":"string","description":"The email address of the user who approved the meeting registration.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who approved the meeting registration."},"object":{"required":["duration","host_id","id","registrant","start_time","timezone","topic","type","uuid"],"type":"object","properties":{"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"id":{"type":"integer","description":"The meeting ID.","format":"int64"},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type: \n* `0` — A prescheduled meeting. \n* `1` — An instant meeting. \n* `2` — A scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` — A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` — A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"type":"string","description":"The meeting's start time.","format":"date-time"},"duration":{"type":"integer","description":"The scheduled meeting duration."},"timezone":{"type":"string","description":"The meeting's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"occurrences":{"type":"array","description":"Information about recurring meetings with fixed times and their occurrences. This only returns when the meeting's `type` value is `8`.","items":{"anyOf":[{"required":["occurrence_id","start_time"],"type":"object","properties":{"occurrence_id":{"type":"string","description":"The meeting occurrence's ID."},"start_time":{"type":"string","description":"The meeting's start time."}},"additionalProperties":true}]}},"registrant":{"required":["email","first_name","id","join_url"],"type":"object","properties":{"id":{"type":"string","description":"The registrant's ID."},"first_name":{"type":"string","description":"The registrant's first name."},"last_name":{"type":"string","description":"The registrant's last name."},"email":{"type":"string","description":"The registrant's email address.","format":"email"},"join_url":{"type":"string","description":"The URL to join the meeting."},"participant_pin_code":{"type":"integer","description":"The participant PIN code is used to authenticate audio participants before they join the meeting.","format":"int64"}},"additionalProperties":true,"description":"Information about the meeting registrant."}},"additionalProperties":true,"description":"Information about the meeting registration."}},"additionalProperties":true}},"additionalProperties":true},"Webinar.participant_leftEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the webinar."},"object":{"required":["duration","host_id","id","participant","start_time","timezone","topic","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The webinar ID."},"uuid":{"type":"string","description":"The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."},"host_id":{"type":"string","description":"The webinar host's user ID."},"topic":{"type":"string","description":"The webinar's topic."},"type":{"type":"integer","description":"The webinar type. \n* `5` - A webinar. \n* `6` - A recurring webinar without a fixed time. \n* `9` - A recurring webinar with a fixed time.","enum":[5,6,9]},"start_time":{"pattern":"(^\\s*$|^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$)","type":"string","description":"The webinar's start time.","format":"date-time"},"timezone":{"type":"string","description":"The webinar's [timezone](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones)."},"duration":{"type":"integer","description":"The scheduled webinar duration."},"participant":{"required":["email","user_id"],"type":"object","properties":{"user_id":{"type":"string","description":"The participant's webinar user ID. This value is assigned to a participant upon joining a webinar and is only valid for the duration of the webinar."},"user_name":{"type":"string","description":"The participant's display name."},"id":{"type":"string","description":"The participant's universally unique ID (UUID). \n* If the participant joins the webinar by logging into Zoom, this value is the `id` value in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the webinar **without** logging into Zoom, this returns an empty string value. \n\n This value returns blank for external users.\n\n**Note:** Use the `participant_user_id` value instead of this value. We will remove this response in a future release."},"leave_time":{"type":"string","description":"The time when the participant left the webinar.","format":"date-time"},"leave_reason":{"type":"string","description":"The reason why the participant left the webinar, where `$name` is the participant's username: \n* `$name left the meeting.` \n* `$name got disconnected from the meeting.` \n* `Host ended the meeting.` \n* `Host closed the meeting.` \n* `Host started a new meeting.` \n* `Network connection error.` \n* `Host did not join.` \n* `Exceeded free meeting minutes limit.` \n* `Removed by host.` \n* `Unknown reason.` \n* `Leave waiting room.` \n* `Removed by host from waiting room.`"},"email":{"type":"string","description":"The participant's email address. This field is returned if the participant joined the webinar by logging into their Zoom account. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details.","format":"email"},"registrant_id":{"type":"string","description":"The participant's registrant ID. (A host or a user with administrative permissions can require [registration for Zoom meetings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065026))."},"participant_user_id":{"type":"string","description":"The participant's universally unique ID (UUID). \n* If the participant joins the webinar by logging into Zoom, this value is the `id` value in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the webinar **without** logging into Zoom, this returns an empty string value.\n\nThis value returns blank for external users."},"participant_uuid":{"type":"string","description":"The participant's UUID for this specific webinar. This value is assigned to a participant when they join a webinar, and is only valid for the duration of that webinar."},"customer_key":{"type":"string","description":"The participant's SDK identifier. This value can be alphanumeric."},"phone_number":{"type":"string","description":"Phone number of participant joined via PSTN.","example":"8615250064084"}},"additionalProperties":false,"description":"Information about the webinar participant. If the participant is **not** part of the host's account, `email` returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details."}},"additionalProperties":false,"description":"Information about the webinar."}},"additionalProperties":false}},"additionalProperties":false},"Recording.batch_deletedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user that completed the meeting or webinar recording."},"operator":{"type":"string","description":"The email address of the user who deleted the recording.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who deleted the recording."},"object":{"required":["meetings"],"type":"object","properties":{"meetings":{"type":"array","items":{"type":"object","properties":{"meeting_uuid":{"type":"string","description":"The universally unique identifier (UUID) of the recorded meeting or webinar instance."},"recording_file_ids":{"type":"array","description":"The recording file's unique ID. If the current field value is NULL, it means to delete the whole Meeting Recording files."}},"description":"Information about the meeting or webinar recording."}}},"additionalProperties":false,"description":"Information about the meeting or webinar recording."}},"additionalProperties":false}},"additionalProperties":false},"Webinar.alertEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the webinar."},"object":{"required":["duration","host_id","id","issues","start_time","timezone","topic","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The webinar ID."},"uuid":{"type":"string","description":"The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."},"host_id":{"type":"string","description":"The webinar host's user ID."},"topic":{"type":"string","description":"The webinar's topic."},"type":{"type":"integer","description":"The webinar type: \n* `5` — A webinar. \n* `6` — A recurring webinar without a fixed time. \n* `9` — A recurring webinar with a fixed time.","enum":[5,6,9]},"start_time":{"type":"string","description":"The webinar's start time.","format":"date-time"},"timezone":{"type":"string","description":"The webinar's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"duration":{"type":"integer","description":"The scheduled webinar duration."},"issues":{"type":"array","description":"A list of issues that occurred during the webinar: \n* `Unstable audio quality` \n* `Unstable video quality` \n* `Unstable screen share quality` \n* `High CPU occupation` \n* `Call Reconnection`","items":{"type":"string","enum":["Unstable audio quality","Unstable video quality","Unstable screen share quality","High CPU occupation","Call Reconnection"]}}},"additionalProperties":false,"description":"Information about the webinar."}},"additionalProperties":false}},"additionalProperties":false},"Webinar.chat_message_sentEvent":{"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 occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the webinar."},"object":{"required":["chat_message","id","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The webinar ID.","format":"int64"},"uuid":{"type":"string","description":"The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."},"breakout_room_uuid":{"type":"string","description":"The breakout room's universally unique identifier (UUID). Each breakout room instance generates a breakout room UUID."},"chat_message":{"required":["date_time","message_content","message_id","recipient_context","recipient_type","sender_context","sender_name","sender_session_id","sender_type"],"type":"object","properties":{"date_time":{"type":"string","description":"The date and time when the chat message was sent.","format":"date-time"},"sender_session_id":{"type":"string","description":"The message sender's session ID."},"sender_name":{"type":"string","description":"The message sender's name."},"sender_email":{"type":"string","description":"The message sender's session email address.","format":"email"},"sender_type":{"type":"string","description":"The type of user that sent the message. \n* `host` - The webinar host. \n* `alternative-host` - The webinar's [alternative host](https://support.zoom.us/hc/en-us/articles/208220166). \n* `panelist` - A webinar [panelist](https://support.zoom.us/hc/en-us/articles/360000252726#:~:text=Panelists%20are%20full,a%20webinar%20host.). \n* `guest` - A webinar guest.","enum":["host","alternative-host","panelist","guest"]},"sender_context":{"type":"string","description":"The context where the sender is located when the message is generated. \n* `webinar` - The sender is in a webinar. \n* `breakout_room` - The sender is in a breakout room. \n* `waiting_room` - The sender is in the waiting room.","enum":["webinar","breakout_room","waiting_room"]},"recipient_session_id":{"type":"string","description":"The message recipient's ID."},"recipient_name":{"type":"string","description":"The message recipient's name."},"recipient_email":{"type":"string","description":"The message recipient's email address. Optional only included if it is a private message.","format":"email"},"recipient_type":{"type":"string","description":"The type of message recipient. \n* `everyone` - All webinar participants. \n* `host` - The webinar host. \n* `guest` - A webinar guest. \n* `group` - A group chat. \n* `backstage` - The webinar backstage. \n* `host_group` - The webinar host and all panelists.","enum":["everyone","host","guest","group","backstage","host_group"]},"recipient_context":{"type":"string","description":"The context where the recipient is located when the message is delivered. \n* `webinar` - The recipient is in the webinar. \n* `breakout_room` - The recipient is in a breakout room. \n* `waiting_room` - The recipient is in the waiting room.","enum":["webinar","breakout_room","waiting_room"]},"message_id":{"type":"string","description":"The chat message's UUID."},"message_content":{"type":"string","description":"The content of the chat message."},"file_ids":{"type":"array","description":"The live webinar chat file's UUID, in base64-encoded format.","items":{"type":"string"}}},"additionalProperties":false,"description":"Information about the chat message."}},"additionalProperties":false,"description":"Information about the chat message."}},"additionalProperties":false}},"additionalProperties":false},"Webinar.chat_message_file_sentEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"The timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who hosted the webinar."},"object":{"required":["chat_message_file","webinar_id","webinar_uuid"],"type":"object","properties":{"webinar_id":{"type":"integer","description":"The webinar ID.","format":"int64"},"webinar_uuid":{"type":"string","description":"The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."},"breakout_room_uuid":{"type":"string","description":"The breakout room's universally unique identifier (UUID). Each breakout room instance generates a breakout room UUID."},"chat_message_file":{"required":["date_time","download_url","file_id","file_name","file_size","file_type","message_id","recipient_context","recipient_type","sender_context","sender_name","sender_session_id","sender_type"],"type":"object","properties":{"date_time":{"type":"string","description":"The date and time when the chat message was sent.","format":"date-time"},"sender_session_id":{"type":"string","description":"The message sender's session ID."},"sender_name":{"type":"string","description":"The message sender's name."},"sender_email":{"type":"string","description":"The message sender's email address.","format":"email"},"sender_type":{"type":"string","description":"The type of user that sent the message. \n* `host` - The meeting host. \n* `guest` - A meeting guest.","enum":["host","guest"]},"sender_context":{"type":"string","description":"The context where the sender is located when the message is generated. \n* `webinar` - The sender is in a webinar. \n* `breakout_room` - The sender is in a breakout room.","enum":["webinar","breakout_room"]},"recipient_session_id":{"type":"string","description":"The message recipient's session ID."},"recipient_name":{"type":"string","description":"The message recipient's name."},"recipient_email":{"type":"string","description":"The message recipient's email address. Optional only included if it is a private message.","format":"email"},"recipient_type":{"type":"string","description":"The type of message recipient. \n* `everyone` - All webinar participants. \n* `host` - The webinar host. \n* `guest` - A webinar guest. \n* `group` - A group chat. \n* `backstage` - The webinar backstage. \n* `host_group` - The webinar host and all panelists.","enum":["everyone","host","guest","group","backstage","host_group"]},"recipient_context":{"type":"string","description":"The context where the recipient is located when the message is delivered. \n* `webinar` - The recipient is in the webinar. \n* `breakout_room` - The sender is in a breakout room.","enum":["webinar","breakout_room"]},"message_id":{"type":"string","description":"The chat message's UUID."},"file_id":{"type":"string","description":"The live webinar chat file's UUID, in base64-encoded format."},"file_name":{"type":"string","description":"The live webinar chat file's name."},"file_size":{"type":"integer","description":"The live webinar chat file's size, in bytes."},"file_type":{"type":"string","description":"The live meeting chat file's type."},"download_url":{"type":"string","description":"The live webinar chat file's download URL."}},"additionalProperties":false,"description":"Information about the chat message file."}},"additionalProperties":false,"description":"Information about the chat message file."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.endedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the meeting."},"object":{"required":["duration","end_time","host_email","host_id","id","start_time","topic","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The meeting ID."},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"host_email":{"type":"string","description":"The meeting host's email address.","format":"email"},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type. \n* `0` - A prescheduled meeting. \n* `1` - An instant meeting. \n* `2` - A scheduled meeting. \n* `3` - A recurring meeting with no fixed time. \n* `4` - A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` - A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` - A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"type":"string","description":"The meeting's start time.","format":"date-time"},"timezone":{"type":"string","description":"The meeting's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"duration":{"type":"integer","description":"The scheduled meeting duration."},"end_time":{"type":"string","description":"The date and time at which the meeting ended.","format":"date-time"}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.participant_joined_breakout_roomEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the main meeting."},"object":{"required":["breakout_room_uuid","duration","host_id","id","participant","start_time","topic","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The main meeting ID."},"uuid":{"type":"string","description":"The main meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"breakout_room_uuid":{"type":"string","description":"The breakout room's universally unique identifier (UUID). Each breakout room instance generates a breakout room UUID."},"host_id":{"type":"string","description":"The main meeting host's user ID."},"topic":{"type":"string","description":"The main meeting's topic."},"type":{"type":"integer","description":"The main meeting type. \n* `0` - A prescheduled meeting. \n* `1` - An instant meeting. \n* `2` - A scheduled meeting. \n* `3` - A recurring meeting with no fixed time. \n* `4` - A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` - A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` - A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"pattern":"(^\\s*$|^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$)","type":"string","description":"The main meeting's start time."},"timezone":{"type":"string","description":"The main meeting's [timezone](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones)."},"duration":{"type":"integer","description":"The main scheduled meeting duration."},"participant":{"required":["email","join_time","user_id","user_name"],"type":"object","properties":{"user_id":{"type":"string","description":"The participant's meeting user ID. This value is assigned to a participant when they join a meeting, and is only valid for the duration of the meeting."},"parent_user_id":{"type":"string","description":"The participant's main meeting user ID (`user_id`)."},"user_name":{"type":"string","description":"The participant's display name."},"id":{"type":"string","description":"The participant's unique ID. \n * If meeting registration was **not** required and the participant joined by logging into Zoom, this value is the same as the `userId` field used in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API. \n* If registration was required for the meeting and the participant joined the meeting by logging into Zoom, this value is the same as the `id` value in the [**List meeting registrants**](/api-reference/zoom-api/methods#operation/meetingRegistrants) API response. \n* If participant joins without logging into Zoom, this returns an empty value. \n\n This value returns blank for external users.\n\n**Note:** Use the `participant_user_id` value instead of this value. We will remove this response in a future release."},"participant_uuid":{"type":"string","description":"The participant's UUID for this specific meeting and any breakout rooms created in this meeting. This value is assigned to a participant when they join a meeting, and is only valid for the duration of that meeting."},"join_time":{"type":"string","description":"The time when the participant joined the meeting.","format":"date-time"},"email":{"type":"string","description":"The participant's email address. This response only returns if the participant joined the meeting by logging into Zoom.","format":"email"},"registrant_id":{"type":"string","description":"The participant's registrant ID. A host or a user with administrative permissions can require [registration for Zoom meetings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065026)."},"participant_user_id":{"type":"string","description":"The participant's unique ID. \n * If meeting registration was **not** required and the participant joined by logging into Zoom, this value is the same as the `userId` field used in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API. \n* If registration was required for the meeting and the participant joined the meeting by logging into Zoom, this value is the same as the `id` value in the [**List meeting registrants**](/api-reference/zoom-api/methods#operation/meetingRegistrants) API response. \n* If participant joins without logging into Zoom, this returns an empty value. \n\nThis value returns blank for external users."},"phone_number":{"type":"string","description":"Phone number of participant joined via PSTN.","example":"8615250064084"},"customer_key":{"type":"string","description":"The participant's SDK identifier. This value can be alphanumeric."}},"additionalProperties":false,"description":"Information about the meeting participant."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.participant_left_waiting_roomEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the meeting."},"object":{"required":["duration","host_id","id","participant","start_time","topic","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The meeting ID."},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type. \n* `0` - A prescheduled meeting. \n* `1` - An instant meeting. \n* `2` - A scheduled meeting. \n* `3` - A recurring meeting with no fixed time. \n* `4` — A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` — A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` — A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"pattern":"(^\\s*$|^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$)","type":"string","description":"The meeting's start time."},"timezone":{"type":"string","description":"The meeting's [timezone](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones)."},"duration":{"type":"integer","description":"The scheduled meeting duration."},"participant":{"required":["date_time","email","user_id"],"type":"object","properties":{"user_id":{"type":"string","description":"The participant's meeting user ID. This value is assigned to a participant when they join a meeting, and is only valid for the duration of the meeting."},"user_name":{"type":"string","description":"The participant's display name."},"id":{"type":"string","description":"The participant's universally unique ID (UUID). \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/docs/api/rest/reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value. \n\n This value returns blank for external users.\n\n**Note:** Use the `participant_user_id` value instead of this value. We will remove this response in a future release."},"participant_uuid":{"type":"string","description":"The participant's UUID for this specific meeting and any breakout rooms created in this meeting. This value is assigned to a participant when they join a meeting, and is only valid for the duration of that meeting."},"date_time":{"type":"string","description":"The time when the participant joined the meeting.","format":"date-time"},"email":{"type":"string","description":"The participant's email address. This response only returns if the participant joined the meeting by logging into Zoom. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details.","format":"email"},"phone_number":{"type":"string","description":"Phone number of participant joined via PSTN-","example":"8615250064084"},"participant_user_id":{"type":"string","description":"The participant's universally unique ID (UUID). \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/docs/api/rest/reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value.\n\nThis value returns blank for external users."},"customer_key":{"type":"string","description":"The participant's SDK identifier. This value can be alphanumeric."},"registrant_id":{"type":"string","description":"The participant's registrant ID. A host or a user with administrative permissions can require [registration for Zoom meetings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065026)."}},"additionalProperties":false,"description":"Information about the meeting participant. If the participant is **not** part of the host's account, `email` returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.startedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the meeting."},"object":{"required":["duration","host_email","host_id","id","start_time","topic","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The meeting ID."},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"host_email":{"type":"string","description":"The meeting host's email address.","format":"email"},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type. \n* `0` - A prescheduled meeting. \n* `1` - An instant meeting. \n* `2` - A scheduled meeting. \n* `3` - A recurring meeting with no fixed time. \n* `4` - A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` - A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` - A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"type":"string","description":"The meeting's start time.","format":"date-time"},"timezone":{"type":"string","description":"The meeting's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"duration":{"type":"integer","description":"The scheduled meeting duration."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.registration_cancelledEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the meeting."},"operator":{"type":"string","description":"The email address of the user who canceled the meeting registration.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who canceled the meeting registration."},"object":{"required":["duration","host_id","id","registrant","start_time","timezone","topic","type","uuid"],"type":"object","properties":{"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"id":{"type":"integer","description":"The meeting ID.","format":"int64"},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type: \n* `0` — A prescheduled meeting. \n* `1` — An instant meeting. \n* `2` — A scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` — A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` — A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"type":"string","description":"The meeting's start time.","format":"date-time"},"duration":{"type":"integer","description":"The scheduled meeting duration."},"timezone":{"type":"string","description":"The meeting's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"occurrences":{"type":"array","description":"Information about recurring meetings with fixed times and their occurrences. This only returns when the meeting's `type` value is `8`.","items":{"anyOf":[{"required":["occurrence_id","start_time"],"type":"object","properties":{"occurrence_id":{"type":"string","description":"The meeting occurrence's ID."},"start_time":{"type":"string","description":"The meeting's start time."}},"additionalProperties":true}]}},"registrant":{"required":["email","first_name","id"],"type":"object","properties":{"id":{"type":"string","description":"The registrant's ID."},"first_name":{"type":"string","description":"The registrant's first name."},"last_name":{"type":"string","description":"The registrant's last name."},"email":{"type":"string","description":"The registrant's email address.","format":"email"}},"additionalProperties":true,"description":"Information about the meeting registrant."}},"additionalProperties":true,"description":"Information about the meeting registration."}},"additionalProperties":true}},"additionalProperties":true},"Meeting.summary_completedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who hosted the meeting."},"object":{"required":["meeting_end_time","meeting_host_email","meeting_host_id","meeting_id","meeting_start_time","meeting_topic","meeting_uuid","next_steps","summary_created_time","summary_details","summary_end_time","summary_last_modified_time","summary_start_time","summary_title"],"type":"object","properties":{"meeting_host_id":{"type":"string","description":"The ID of the user who is set as the meeting host."},"meeting_host_email":{"type":"string","description":"The meeting host's email address.","format":"email"},"meeting_uuid":{"type":"string","description":"Unique meeting ID. Each meeting instance generates its own meeting UUID - after a meeting ends, a new UUID is generated for the next instance of the meeting. Retrieve a list of UUIDs from past meeting instances using the [**List past meeting instances**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/pastMeetings) API. [Double encode](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#meeting-id-and-uuid) your UUID when using it for API calls if the UUID begins with a `/` or contains `//` in it.\n"},"meeting_id":{"type":"integer","description":"[Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-) - the meeting's unique identifier in **long** format, represented as int64 data type in JSON. Also known as the meeting number.","format":"int64"},"meeting_topic":{"type":"string","description":"Meeting topic."},"meeting_start_time":{"type":"string","description":"The meeting's start date and time.","format":"date-time"},"meeting_end_time":{"type":"string","description":"The meeting's end date and time.","format":"date-time","example":"2020-07-15T23:30:19Z"},"summary_start_time":{"type":"string","description":"The summary's start date and time.","format":"date-time"},"summary_end_time":{"type":"string","description":"The summary's end date and time.","format":"date-time"},"summary_created_time":{"type":"string","description":"The date and time when the meeting summary was created.","format":"date-time"},"summary_last_modified_time":{"type":"string","description":"The date and time when the meeting summary was last modified.","format":"date-time"},"summary_title":{"type":"string","description":"The summary title."},"summary_overview":{"type":"string","description":"The summary overview.","deprecated":true},"summary_details":{"type":"array","description":"The summary content details.","deprecated":true,"items":{"required":["label","summary"],"type":"object","properties":{"label":{"type":"string","description":"The summary label."},"summary":{"type":"string","description":"The summary content."}},"description":"The summary detail object."}},"next_steps":{"type":"array","description":"The next steps.","deprecated":true,"items":{"type":"string","description":"The next step."}},"summary_content":{"type":"string","description":"The complete meeting summary in Markdown format. This unified field is used for all summaries. For compatibility, the legacy fields `summary_overview`, `summary_details`, `next_steps` are still returned, but are deprecated and will not be supported in the future."},"summary_doc_url":{"type":"string","description":"The URL to view the full summary document in Zoom Docs."}},"additionalProperties":true,"description":"Information about the meeting summary."}},"additionalProperties":true}},"additionalProperties":true},"Meeting.participant_leftEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the meeting."},"object":{"required":["duration","host_id","id","participant","start_time","topic","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The meeting ID."},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type: \n* `0` — A prescheduled meeting. \n* `1` — An instant meeting. \n* `2` — A scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` — A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` — A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"pattern":"(^\\s*$|^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$)","type":"string","description":"The meeting's start time."},"timezone":{"type":"string","description":"The meeting's [timezone](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones)."},"duration":{"type":"integer","description":"The scheduled meeting duration."},"participant":{"required":["email","leave_time","user_id"],"type":"object","properties":{"user_id":{"type":"string","description":"The participant's meeting user ID. This value is assigned to a participant when they join a meeting, and is only valid for the duration of the meeting."},"user_name":{"type":"string","description":"The participant's display name."},"id":{"type":"string","description":"The participant's universally unique ID (UUID). \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value. \n\n This value returns blank for external users.\n\n**Note:** Use the `participant_user_id` value instead of this value. We will remove this response in a future release."},"participant_uuid":{"type":"string","description":"The participant's UUID for this specific meeting and any breakout rooms created in this meeting. This value is assigned to a participant when they join a meeting, and is only valid for the duration of that meeting."},"leave_time":{"type":"string","description":"The time when the participant left the meeting.","format":"date-time"},"leave_reason":{"type":"string","description":"The reason why the participant left the meeting, where `$name` is the participant's username: \n* `$name left the meeting.` \n* `$name got disconnected from the meeting.` \n* `Host ended the meeting.` \n* `Host closed the meeting.` \n* `Host started a new meeting.` \n* `Network connection error.` \n* `Host did not join.` \n* `Exceeded free meeting minutes limit.` \n* `Removed by host.` \n* `Unknown reason.` \n* `Leave waiting room.` \n* `Removed by host from waiting room.`"},"email":{"type":"string","description":"The participant's email address. This response only returns if the participant joined the meeting by logging into Zoom. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details.","format":"email"},"registrant_id":{"type":"string","description":"The participant's registrant ID. (A host or a user with administrative permissions can require [registration for Zoom meetings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065026))."},"participant_user_id":{"type":"string","description":"The participant's universally unique ID (UUID). \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value.\n\nThis value returns blank for external users."},"customer_key":{"type":"string","description":"The participant's SDK identifier. This value can be alphanumeric."},"phone_number":{"type":"string","description":"Phone number of participant joined via PSTN","example":"8615250064084"}},"additionalProperties":false,"description":"Information about the meeting participant. If the participant is **not** part of the host's account, `email` returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.participant_phone_callout_rejectedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The meeting host's account ID."},"object":{"required":["host_id","id","participant","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The meeting ID.","format":"int64"},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"participant":{"required":["invitee_name","phone_number"],"type":"object","properties":{"invitee_name":{"type":"string","description":"The user's name to display in the meeting."},"phone_number":{"type":"integer","description":"The user's phone number.","format":"int64"}},"additionalProperties":false,"description":"Information about the invited participant."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.participant_phone_callout_acceptedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The meeting host's account ID."},"object":{"required":["host_id","id","participant","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The meeting ID.","format":"int64"},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"participant":{"required":["invitee_name","phone_number"],"type":"object","properties":{"invitee_name":{"type":"string","description":"The user's name to display in the meeting."},"phone_number":{"type":"integer","description":"The user's phone number.","format":"int64"}},"additionalProperties":false,"description":"Information about the invited participant."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Webinar.sharing_startedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the webinar."},"object":{"required":["duration","host_id","id","participant","start_time","topic","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The webinar ID."},"uuid":{"type":"string","description":"The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."},"host_id":{"type":"string","description":"The webinar host's user ID."},"topic":{"type":"string","description":"The webinar's topic."},"type":{"type":"integer","description":"The webinar type: \n* `5` — A webinar. \n* `6` — A recurring webinar without a fixed time. \n* `9` — A recurring webinar with a fixed time.","enum":[5,6,9]},"start_time":{"pattern":"(^\\s*$|^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$)","type":"string","description":"The webinar's start time."},"timezone":{"type":"string","description":"The webinar's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"duration":{"type":"integer","description":"The scheduled webinar duration."},"participant":{"required":["sharing_details","user_id"],"type":"object","properties":{"user_id":{"type":"string","description":"The participant's webinar user ID. This value is assigned to a participant upon joining a webinar and is only valid for the duration of the webinar."},"user_name":{"type":"string","description":"The participant's display name."},"id":{"type":"string","description":"The participant's universally unique ID (UUID): \n* If the participant joins the webinar by logging into Zoom, this value is the `id` value in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the webinar **without** logging into Zoom, this returns an empty string value."},"sharing_details":{"required":["content","date_time","file_link","link_source","source"],"type":"object","properties":{"content":{"type":"string","description":"The type of shared content: \n* `application` — An application. For example, a web browser. \n* `whiteboard` — The [classic whiteboard](https://support.zoom.us/hc/en-us/articles/205677665-Sharing-a-whiteboard). \n* `desktop` — A user's desktop. \n* `airplay` — A user's [AirPlay (Apple screen mirroring)](https://support.zoom.us/hc/en-us/articles/204726885-Sharing-screen-using-Apple-screen-mirroring-AirPlay-). \n* `camera` — A user's camera. \n* `unknown` — An unrecognized application, such as a third party app.","enum":["application","whiteboard","desktop","airplay","camera","unknown"]},"link_source":{"type":"string","description":"The Dropbox sharing method: \n* `deep_link` — A [deep link](https://en.wikipedia.org/wiki/Deep_linking). \n* `in_meeting` — A link shared via Zoom. \n* An empty string value if the link source is **not** a Dropbox link.","enum":["","deep_link","in_meeting"]},"file_link":{"type":"string","description":"The Dropbox file's link. This field returns an empty string value if the file link is **not** from a Dropbox source."},"date_time":{"type":"string","description":"The screenshare's date and time.","format":"date-time"},"source":{"type":"string","description":"The source from which the file was shared: \n* `dropbox` — A Dropbox source. \n* An empty string value if the source is **not** Dropbox.","enum":["","dropbox"]}},"additionalProperties":false,"description":"Information about the webinar's screenshare."}},"additionalProperties":false,"description":"Information about the webinar participant."}},"additionalProperties":false,"description":"Information about the webinar."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.registration_createdEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the meeting."},"object":{"required":["duration","host_id","id","registrant","start_time","timezone","topic","type","uuid"],"type":"object","properties":{"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"id":{"type":"integer","description":"The meeting ID.","format":"int64"},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type: \n* `0` — A prescheduled meeting. \n* `1` — An instant meeting. \n* `2` — A scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` — A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` — A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"type":"string","description":"The meeting's start time.","format":"date-time"},"duration":{"type":"integer","description":"The scheduled meeting duration."},"timezone":{"type":"string","description":"The meeting's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"occurrences":{"type":"array","description":"Information about recurring meetings with fixed times and their occurrences. This only returns when the meeting's `type` value is `8`.","items":{"anyOf":[{"required":["occurrence_id","start_time"],"type":"object","properties":{"occurrence_id":{"type":"string","description":"The meeting occurrence's ID."},"start_time":{"type":"string","description":"The meeting's start time.","format":"date-time"}},"additionalProperties":true}]}},"registrant":{"required":["email","first_name","id","join_url","status"],"type":"object","properties":{"id":{"type":"string","description":"The registrant's ID."},"first_name":{"type":"string","description":"The registrant's first name."},"last_name":{"type":"string","description":"The registrant's last name."},"email":{"type":"string","description":"The registrant's email address.","format":"email"},"address":{"type":"string","description":"The registrant's address."},"city":{"type":"string","description":"The registrant's city."},"country":{"type":"string","description":"The registrant's two-letter [country code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries)."},"zip":{"type":"string","description":"The registrant's ZIP or postal code."},"state":{"type":"string","description":"The registrant's state or province."},"phone":{"type":"string","description":"The registrant's phone number."},"industry":{"type":"string","description":"The registrant's industry."},"org":{"type":"string","description":"The registrant's organization."},"job_title":{"type":"string","description":"The registrant's job title."},"purchasing_time_frame":{"type":"string","description":"The registrant's purchasing time frame: \n* `Within a month` \n* `1-3 months` \n* `4-6 months` \n* `More than 6 months` \n* `No timeframe` \n* An empty string. — No purchasing time frame set.","enum":["","Within a month","1-3 months","4-6 months","More than 6 months","No timeframe"]},"role_in_purchase_process":{"type":"string","description":"The registrant's role in the purchase process: \n* `Decision Maker` \n* `Evaluator/Recommender` \n* `Influencer` \n* `Not involved` \n* An empty string. — No role set.","enum":["","Decision Maker","Evaluator/Recommender","Influencer","Not involved"]},"no_of_employees":{"type":"string","description":"The registrant's number of employees: \n* `1-20` \n* `21-50` \n* `51-100` \n* `101-250` \n* `251-500` \n* `501-1,000` \n* `1,001-5,000` \n* `5,001-10,000` \n* `More than 10,000` \n* An empty string. — No employee number set.","enum":["","1-20","21-50","51-100","101-250","251-500","501-1,000","1,001-5,000","5,001-10,000","More than 10,000"]},"comments":{"type":"string","description":"The registrant's questions and comments."},"custom_questions":{"type":"array","description":"Information about custom questions.","items":{"anyOf":[{"required":["title","value"],"type":"object","properties":{"title":{"type":"string","description":"The title of the custom question."},"value":{"maxLength":128,"type":"string","description":"The custom question's response value. This has a limit of 128 characters."}},"additionalProperties":true}]}},"status":{"type":"string","description":"The registrant's registration approval status: \n* `approve` — Approved registrant. \n* `pending` — Registration approval pending.","enum":["approved","pending"]},"join_url":{"type":"string","description":"The URL to join the meeting."},"participant_pin_code":{"type":"integer","description":"The participant PIN code is used to authenticate audio participants before they join the meeting.","format":"int64"}},"additionalProperties":true,"description":"Information about the meeting registrant."}},"additionalProperties":true,"description":"Information about the meeting registration."}},"additionalProperties":true}},"additionalProperties":true},"Recording.recoveredEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"download_token":{"type":"string","description":"Use the generated token value with the `download_url` value to download the cloud recording via an [OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app). The download token only lasts for 24 hours after its creation and you can only download the file within 24 hours of receiving the event notification. You can either include the `download_token` as a query parameter or pass it as a Bearer token in the Authorization header of your HTTP request: \n\n **Using an Authorization header (Recommended)** \n\n ```\ncurl --request GET \\\n  --url {download_url} \\\n  --header 'authorization: Bearer {download_token} \\\n  --header 'content-type: application/json'\n``` \n\n**Using a query parameter** \n\n ```\n{download_url}/?access_token={download_token}\n``` \n\n For example: `https://zoom.us/recording/download/123456?access_token=abcdefgh`"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user that completed the meeting or webinar recording."},"operator":{"type":"string","description":"The email address of the user who recovered the recording.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who recovered the recording."},"object":{"required":["account_id","duration","host_id","id","recording_count","recording_files","share_url","start_time","topic","total_size","type","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The ID of the recorded meeting (`meetingId`) or webinar (`webinarId`).","format":"int64"},"uuid":{"type":"string","description":"The universally unique identifier (UUID) of the recorded meeting or webinar instance."},"host_id":{"type":"string","description":"The ID of the user set as the host of the meeting or webinar."},"topic":{"type":"string","description":"The meeting or webinar topic."},"type":{"type":"integer","description":"The type of recorded meeting or webinar: \n\n If the recording is of a meeting: \n* `1` — Instant meeting. \n* `2` — Scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A meeting created via PMI (Personal Meeting ID). \n* `7` — A [Personal Audio Conference](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) (PAC). \n* `8` - Recurring meeting with a fixed time. \n\n If the recording is of a webinar: \n* `5` — A webinar. \n* `6` — A recurring webinar without a fixed time. \n* `9` — A recurring webinar with a fixed time. \n\n If the recording is **not** from a meeting or webinar: \n\n* `99` — A recording uploaded via the [**Recordings**](https://zoom.us/recording) interface on the Zoom Web Portal.","enum":[1,2,3,4,5,6,7,8,9,99]},"start_time":{"type":"string","description":"The meeting or webinar's start time.","format":"date-time"},"account_id":{"type":"string","description":"The account ID of the user that completed the meeting or webinar recording."},"timezone":{"type":"string","description":"The meeting or webinar's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"duration":{"type":"integer","description":"The meeting or webinar's scheduled duration."},"share_url":{"type":"string","description":"The URL at which approved users can view the recording."},"total_size":{"type":"integer","description":"The recording file's total size, in bytes."},"recording_count":{"type":"integer","description":"The number of recovered recording files."},"recording_files":{"type":"array","description":"Information about the recovered recording files.","items":{"required":["download_url","file_extension","file_size","file_type","id","meeting_id","recording_end","recording_start","recording_type","status"],"type":"object","properties":{"id":{"type":"string","description":"The recording file's ID."},"meeting_id":{"type":"string","description":"The meeting's ID."},"recording_start":{"type":"string","description":"The date and time at which recording started.","format":"date-time"},"recording_end":{"type":"string","description":"The date and time at which recording ended.","format":"date-time"},"file_type":{"type":"string","description":"The file type of the recording file.","enum":["MP4","M4A","CHAT","TRANSCRIPT","CSV","TB","CC","CHAT_MESSAGE","SUMMARY","TIMELINE"]},"file_size":{"type":"integer","description":"The recording file's size, in bytes."},"file_extension":{"type":"string","description":"The file extension type of the recording file.","enum":["MP4","M4A","TXT","VTT","CSV","JSON","JPG"]},"file_name":{"type":"string","description":"The recording file's name."},"play_url":{"type":"string","description":"The URL at which the recording file can be opened and played."},"download_url":{"type":"string","description":"The URL at which to download the the recording. \n\n **JWT apps** \n\n To access a private or password-protected cloud recording of a user in your account, use a [Zoom JWT app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-jwt-app). Use the generated JWT token as the value of the `access_token` query parameter and include this query parameter at the end of the URL. \n\n `https://{{base-domain}}/recording/download/{{path-to-file-download}}?access_token={{JWT-token}}` \n\n **OAuth apps** \n\n If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) to download the file. For example: \n\n `https://{{base-domain}}/rec/archive/download/xxx?access_token={{OAuth-access-token}}`.  \n\n**Note:** We recommend that you send the access_token as a Bearer token in the Authorization header, for example: \"Authorization\": \"Bearer <ACCESS_TOKEN>”."},"status":{"type":"string","description":"The recording file's processing status: \n* `completed` — The processing of the file is complete. \n* `processing` — The file is processing.","enum":["completed","processing"]},"recording_type":{"type":"string","description":"The recording file type. \n* `shared_screen_with_speaker_view(CC)` \n* `shared_screen_with_speaker_view` \n* `shared_screen_with_gallery_view` \n* `gallery_view` \n* `shared_screen` \n* `audio_only` \n* `audio_transcript` \n* `chat_file` \n* `active_speaker` \n* `host_video` \n* `audio_only_each_participant` \n* `cc_transcript` \n* `closed_caption` \n* `poll` \n* `timeline` \n* `thumbnail` \n* `audio_interpretation` \n* `summary` \n* `summary_next_steps` \n* `summary_smart_chapters` \n*`sign_interpretation` \n*`production_studio` \n\nFor more information, read our [Managing and sharing cloud recordings](https://support.zoom.us/hc/en-us/articles/205347605-Managing-and-sharing-cloud-recordings#h_9898497b-e736-4980-a749-d55608f10773) documentation.","enum":["shared_screen_with_speaker_view(CC)","shared_screen_with_speaker_view","shared_screen_with_gallery_view","gallery_view","shared_screen","audio_only","audio_transcript","chat_file","active_speaker","host_video","audio_only_each_participant","cc_transcript","closed_caption","poll","timeline","thumbnail","audio_interpretation","summary","summary_next_steps","summary_smart_chapters","sign_interpretation","production_sutdio"]}},"additionalProperties":false}},"participant_audio_files":{"type":"array","description":"Information about the recovered participants' recording files.","items":{"required":["download_url","file_extension","file_name","file_size","file_type","id","recording_end","recording_start","status"],"type":"object","properties":{"id":{"type":"string","description":"The recording file's unique ID."},"recording_start":{"type":"string","description":"The recording file's start time.","format":"date-time"},"recording_end":{"type":"string","description":"The recording file's end time.","format":"date-time"},"file_type":{"type":"string","description":"The recording file's format."},"file_name":{"type":"string","description":"The recording file's name."},"file_size":{"type":"integer","description":"The size of the recording file, in bytes."},"file_extension":{"type":"string","description":"The recording file's extension."},"play_url":{"type":"string","description":"The URL at which the recording file can be opened and played."},"download_url":{"type":"string","description":"The URL at which to download the the recording. \n\n **JWT apps** \n\n To access a private or password-protected cloud recording of a user in your account, use a [Zoom JWT app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-jwt-app). Use the generated JWT token as the value of the `access_token` query parameter and include this query parameter at the end of the URL. \n\n `https://{{base-domain}}/recording/download/{{path-to-file-download}}?access_token={{JWT-token}}` \n\n **OAuth apps** \n\n If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) to download the file. For example: \n\n `https://{{base-domain}}/rec/archive/download/xxx?access_token={{OAuth-access-token}}` \n\n **Note:** This field does **not** return for [Zoom On-Premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). Instead, this API will return the `file_path` field."},"file_path":{"type":"string","description":"The file path to the On-Premise account recording. \n\n **Note:** This API returns this field for [Zoom On-Premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). It does **not** return the `download_url` field."},"status":{"type":"string","description":"The participant audio file's processing status: \n* `completed` — The processing of the file is complete. \n* `processing` — The file is processing.","enum":["completed","processing"]}},"additionalProperties":false}}},"additionalProperties":false,"description":"Information about the meeting or webinar recording."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.sharing_endedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the meeting."},"object":{"required":["duration","host_id","id","participant","start_time","topic","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The meeting ID."},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type: \n* `0` — A prescheduled meeting. \n* `1` — An instant meeting. \n* `2` — A scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` — A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` — A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"pattern":"(^\\s*$|^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$)","type":"string","description":"The meeting's start time."},"timezone":{"type":"string","description":"The meeting's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"duration":{"type":"integer","description":"The scheduled meeting duration."},"participant":{"required":["sharing_details","user_id"],"type":"object","properties":{"user_id":{"type":"string","description":"The participant's meeting user ID. This value is assigned to a participant upon joining a meeting and is only valid for the duration of the meeting."},"user_name":{"type":"string","description":"The participant's display name."},"id":{"type":"string","description":"The participant's universally unique ID (UUID): \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value."},"sharing_details":{"required":["content","date_time","file_link","link_source","source"],"type":"object","properties":{"content":{"type":"string","description":"The type of shared content: \n* `application` — An application. For example, a web browser. \n* `whiteboard` — The [classic whiteboard](https://support.zoom.us/hc/en-us/articles/205677665-Sharing-a-whiteboard). \n* `desktop` — A user's desktop. \n* `airplay` — A user's [AirPlay (Apple screen mirroring)](https://support.zoom.us/hc/en-us/articles/204726885-Sharing-screen-using-Apple-screen-mirroring-AirPlay-). \n* `camera` — A user's camera. \n* `unknown` — An unrecognized application, such as a third party app.","enum":["application","whiteboard","desktop","airplay","camera","unknown"]},"link_source":{"type":"string","description":"The Dropbox sharing method: \n* `deep_link` — A [deep link](https://en.wikipedia.org/wiki/Deep_linking). \n* `in_meeting` — A link shared via Zoom. \n* An empty (`””`) value if the link source is **not** a Dropbox link.","enum":["","deep_link","in_meeting"]},"file_link":{"type":"string","description":"The Dropbox file's link. This field returns an empty (`””`) value if the file link is **not** from a Dropbox source."},"date_time":{"type":"string","description":"The screenshare's date and time.","format":"date-time"},"source":{"type":"string","description":"The source from which the file was shared: \n* `dropbox` — A Dropbox source. \n* An empty (`””`) value if the source is **not** Dropbox.","enum":["","dropbox"]}},"additionalProperties":false,"description":"Information about the meeting's screenshare."}},"additionalProperties":false,"description":"Information about the meeting participant."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Recording.cloud_storage_usage_updatedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the host who recorded the webinar."},"object":{"required":["free_storage","plan_storage","plan_type","storage_exceed","storage_used","storage_used_percentage"],"type":"object","properties":{"free_storage":{"type":"string","description":"Recording free storage.","example":"2 GB"},"plan_storage":{"type":"string","description":"Recording plan storage.","example":"10 GB"},"plan_type":{"type":"string","description":"Recording plan type.","example":"cmr_monthly_commitment_40"},"storage_used":{"type":"string","description":"Amount of storage used.","example":"1 GB"},"storage_used_percentage":{"maximum":100,"minimum":0,"type":"number","description":"The percentage of storage used.","example":85},"storage_exceed":{"type":"string","description":"Amount of storage exceed.","example":"0"},"max_exceed_date":{"type":"string","description":"The maximum date that overage storage.","example":"2023-03-01"}},"additionalProperties":false,"description":"Information about the recording plan."}},"additionalProperties":false}},"additionalProperties":false},"Recording.transcript_completedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"download_token":{"type":"string","description":"Use the generated token value with the `download_url` value to download the cloud recording via an [OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app). The download token only lasts for 24 hours after its creation and you can only download the file within 24 hours of receiving the event notification. You can either include the `download_token` as a query parameter or pass it as a Bearer token in the Authorization header of your HTTP request: \n\n **Using an Authorization header (Recommended)** \n\n ```\ncurl --request GET \\\n  --url {download_url} \\\n  --header 'authorization: Bearer {download_token} \\\n  --header 'content-type: application/json'\n``` \n\n**Using a query parameter** \n\n ```\n{download_url}/?access_token={download_token}\n``` \n\n For example: `https://zoom.us/recording/download/123456?access_token=abcdefgh`"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user that hosted the meeting or the webinar."},"object":{"required":["account_id","duration","host_email","host_id","id","recording_count","recording_files","share_url","start_time","topic","total_size","type","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The ID of the meeting (`meetingId`) or the webinar (`webinarId`).","format":"int64"},"uuid":{"type":"string","description":"The universally unique identifier (UUID) of the recorded meeting or webinar instance. Each meeting or webinar instance generates its own meeting UUID."},"host_id":{"type":"string","description":"The ID of the user set as the host of the archived meeting or webinar."},"account_id":{"type":"string","description":"The account ID of the user that ended the meeting and completed the recording."},"topic":{"type":"string","description":"The meeting or webinar topic."},"type":{"type":"integer","description":"The type of recorded meeting or webinar: \n\n If the recording is of a meeting: \n* `1` — Instant meeting. \n* `2` — Scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A meeting created via PMI (Personal Meeting ID). \n* `7` — A [Personal Audio Conference](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) (PAC). \n* `8` - Recurring meeting with a fixed time. \n\n If the recording is of a webinar: \n* `5` — A webinar. \n* `6` — A recurring webinar without a fixed time. \n* `9` — A recurring webinar with a fixed time. \n\n If the recording is **not** from a meeting or webinar: \n\n* `99` — A recording uploaded via the [**Recordings**](https://zoom.us/recording) interface on the Zoom Web Portal.","enum":[1,2,3,4,5,6,7,8,9,99]},"start_time":{"type":"string","description":"The meeting or webinar's start time.","format":"date-time"},"timezone":{"type":"string","description":"The meeting or webinar's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"host_email":{"type":"string","description":"The host's email address.","format":"email"},"duration":{"type":"integer","description":"The meeting or webinar's scheduled duration."},"password":{"type":"string","description":"The meeting's password."},"share_url":{"type":"string","description":"The URL at which approved users can view the recording."},"total_size":{"type":"integer","description":"The recording file's total size, in bytes."},"recording_count":{"type":"integer","description":"The number of completed recording files."},"recording_files":{"type":"array","description":"Information about the completed recording files.","items":{"required":["download_url","file_extension","file_size","file_type","id","meeting_id","recording_end","recording_start","recording_type","status"],"type":"object","properties":{"id":{"type":"string","description":"The recording file's ID."},"meeting_id":{"type":"string","description":"The meeting's ID."},"recording_start":{"type":"string","description":"The date and time at which recording started.","format":"date-time"},"recording_end":{"type":"string","description":"The date and time at which recording ended.","format":"date-time"},"file_type":{"type":"string","description":"The recording file's type."},"file_size":{"type":"integer","description":"The recording file's size, in bytes."},"file_extension":{"type":"string","description":"The recording file's extension."},"file_name":{"type":"string","description":"The recording file's name."},"play_url":{"type":"string","description":"The URL at which the recording file can be opened and played."},"download_url":{"type":"string","description":"The URL at which to download the the recording. \n\n **JWT apps** \n\n To access a private or password-protected cloud recording of a user in your account, use a [Zoom JWT app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-jwt-app). Use the generated JWT token as the value of the `access_token` query parameter and include this query parameter at the end of the URL. \n\n `https://{{base-domain}}/recording/download/{{path-to-file-download}}?access_token={{JWT-token}}` \n\n **OAuth apps** \n\n If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) to download the file. For example: \n\n `https://{{base-domain}}/rec/archive/download/xxx?access_token={{OAuth-access-token}}` \n\n **Note:** This field does **not** return for [Zoom On-Premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). Instead, this API will return the `file_path` field."},"file_path":{"type":"string","description":"The file path to the On-Premise account recording. \n\n **Note:** This API returns this field for [Zoom On-Premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). It does **not** return the `download_url` field."},"status":{"type":"string","description":"The recording file's processing status: \n* `completed` — The processing of the file is complete. \n* `processing` — The file is processing.","enum":["completed","processing"]},"recording_type":{"type":"string","description":"The type of recording file: \n* `shared_screen_with_speaker_view(CC)` \n* `shared_screen_with_speaker_view` \n* `shared_screen_with_gallery_view` \n* `gallery_view` \n* `shared_screen` \n* `audio_only` \n* `audio_transcript` \n* `chat_file` \n* `active_speaker` \n* `host_video` \n* `audio_only_each_participant` \n* `cc_transcript` \n* `closed_caption` \n* `poll` \n* `timeline` \n* `thumbnail` \n\nFor more information, read our [Managing and sharing cloud recordings](https://support.zoom.us/hc/en-us/articles/205347605-Managing-and-sharing-cloud-recordings#h_9898497b-e736-4980-a749-d55608f10773) documentation.","enum":["shared_screen_with_speaker_view(CC)","shared_screen_with_speaker_view","shared_screen_with_gallery_view","gallery_view","shared_screen","audio_only","audio_transcript","chat_file","active_speaker","host_video","audio_only_each_participant","cc_transcript","closed_caption","poll","timeline","thumbnail"]}},"additionalProperties":false}}},"additionalProperties":false,"description":"Information about the webinar or meeting recording."}},"additionalProperties":false}},"additionalProperties":false},"Recording.stoppedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user that stopped the meeting or webinar recording."},"object":{"required":["duration","host_id","id","recording_file","start_time","topic","type","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The ID of the recorded meeting (`meetingId`) or webinar (`webinarId`).","format":"int64"},"uuid":{"type":"string","description":"The universally unique identifier (UUID) of the recorded meeting or webinar instance."},"host_id":{"type":"string","description":"The ID of the user set as the host of the meeting or webinar."},"topic":{"type":"string","description":"The meeting or webinar topic."},"type":{"type":"integer","description":"The type of recorded meeting or webinar: \n\n If the recording is of a meeting: \n* `1` — Instant meeting. \n* `2` — Scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A meeting created via PMI (Personal Meeting ID). \n* `7` — A [Personal Audio Conference](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) (PAC). \n* `8` - Recurring meeting with a fixed time. \n\n If the recording is of a webinar: \n* `5` — A webinar. \n* `6` — A recurring webinar without a fixed time. \n* `9` — A recurring webinar with a fixed time. \n\n If the recording is **not** from a meeting or webinar: \n\n* `99` — A recording uploaded via the [**Recordings**](https://zoom.us/recording) interface on the Zoom Web Portal.","enum":[1,2,3,4,5,6,7,8,9,99]},"start_time":{"type":"string","description":"The meeting or webinar's start time.","anyOf":[{"format":"date-time"},{"enum":[""]}]},"timezone":{"type":"string","description":"The meeting or webinar's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"duration":{"type":"integer","description":"The meeting or webinar's scheduled duration."},"recording_file":{"required":["recording_end","recording_start"],"type":"object","properties":{"recording_start":{"type":"string","description":"The date and time at which the recording started.","anyOf":[{"format":"date-time"},{"enum":[""]}]},"recording_end":{"type":"string","description":"The date and time at which the recording ended.","anyOf":[{"format":"date-time"},{"enum":[""]}]}},"additionalProperties":false,"description":"Information about the recording files."}},"additionalProperties":false,"description":"Information about the meeting or webinar recording."}},"additionalProperties":false}},"additionalProperties":false},"Recording.batch_trashedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","operation","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who batch deleted recordings to trash."},"operator":{"type":"string","description":"The email address of the user who batch deleted recordings to trash.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who batch deleted recordings to trash."},"operation":{"type":"string","description":"The type of batch operation: \n* `trash_user_recordings` — User recordings trashed. \n* `trash_account_recordings` — Account recordings trashed.","enum":["trash_user_recordings","trash_account_recordings"]},"object":{"required":["meeting_uuids"],"type":"object","properties":{"meeting_uuids":{"type":"array","items":{"type":"string","description":"A list of the recorded meeting (`meetingId`) or webinar (`webinarId`) UUIDs."}}},"additionalProperties":false,"description":"Information about the webinar or meeting recording."}},"additionalProperties":false}},"additionalProperties":false},"Webinar.startedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who started the webinar."},"object":{"required":["duration","host_email","host_id","id","start_time","timezone","topic","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The webinar ID."},"uuid":{"type":"string","description":"The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."},"host_id":{"type":"string","description":"The webinar host's user ID."},"host_email":{"type":"string","description":"The meeting host's email address.","format":"email"},"topic":{"type":"string","description":"The webinar's topic."},"type":{"type":"integer","description":"The webinar type. \n* `5` - A webinar. \n* `6` - A recurring webinar without a fixed time. \n* `9` - A recurring webinar with a fixed time.","enum":[5,6,9]},"start_time":{"type":"string","description":"The webinar's start time.","format":"date-time"},"timezone":{"type":"string","description":"The webinar's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"duration":{"type":"integer","description":"The scheduled webinar duration."}},"additionalProperties":false,"description":"Information about the webinar."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.chat_message_file_downloadedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"The timestamp when the event occurred.","format":"int64"},"payload":{"required":["object","operator"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who downloaded the file. This value returns blank for external users."},"operator":{"type":"string","description":"The email address of the user who downloaded the file. This value returns the operator name for external users.","format":"email or name"},"operator_id":{"type":"string","description":"The user ID of the user who downloaded the file. This value returns blank for external users."},"object":{"required":["chat_message_file","host_account_id","id","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The meeting ID.","format":"int64"},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_account_id":{"type":"string","description":"The meeting host's account ID. The value will be an empty string if this info is from an external user."},"chat_message_file":{"required":["file_id","file_name","file_size","file_type"],"type":"object","properties":{"file_id":{"type":"string","description":"The live meeting chat file's UUID."},"file_name":{"type":"string","description":"The live meeting chat file's name."},"file_size":{"type":"integer","description":"The live meeting chat file's size, in bytes."},"file_type":{"type":"string","description":"The live meeting chat file's file type."},"file_owner_id":{"type":"string","description":"The user ID of the user who uploaded the team chat file. This value returns blank for external users."}},"additionalProperties":false,"description":"Information about the chat message file."}},"additionalProperties":false,"description":"Information about the chat message file."}},"additionalProperties":false}},"additionalProperties":false},"Webinar.sharing_endedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the webinar."},"object":{"required":["duration","host_id","id","participant","start_time","topic","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The webinar ID."},"uuid":{"type":"string","description":"The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."},"host_id":{"type":"string","description":"The webinar host's user ID."},"topic":{"type":"string","description":"The webinar's topic."},"type":{"type":"integer","description":"The webinar type: \n* `5` — A webinar. \n* `6` — A recurring webinar without a fixed time. \n* `9` — A recurring webinar with a fixed time.","enum":[5,6,9]},"start_time":{"pattern":"(^\\s*$|^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$)","type":"string","description":"The webinar's start time."},"timezone":{"type":"string","description":"The webinar's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"duration":{"type":"integer","description":"The scheduled webinar duration."},"participant":{"required":["sharing_details","user_id"],"type":"object","properties":{"user_id":{"type":"string","description":"The participant's webinar user ID. This value is assigned to a participant upon joining a webinar and is only valid for the duration of the webinar."},"user_name":{"type":"string","description":"The participant's display name."},"id":{"type":"string","description":"The participant's universally unique ID (UUID): \n* If the participant joins the webinar by logging into Zoom, this value is the `id` value in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the webinar **without** logging into Zoom, this returns an empty string value."},"sharing_details":{"required":["content","date_time","file_link","link_source","source"],"type":"object","properties":{"content":{"type":"string","description":"The type of shared content: \n* `application` — An application. For example, a web browser. \n* `whiteboard` — The [classic whiteboard](https://support.zoom.us/hc/en-us/articles/205677665-Sharing-a-whiteboard). \n* `desktop` — A user's desktop. \n* `airplay` — A user's [AirPlay (Apple screen mirroring)](https://support.zoom.us/hc/en-us/articles/204726885-Sharing-screen-using-Apple-screen-mirroring-AirPlay-). \n* `camera` — A user's camera. \n* `unknown` — An unrecognized application, such as a third party app.","enum":["application","whiteboard","desktop","airplay","camera","unknown"]},"link_source":{"type":"string","description":"The Dropbox sharing method: \n* `deep_link` — A [deep link](https://en.wikipedia.org/wiki/Deep_linking). \n* `in_meeting` — A link shared via Zoom. \n* An empty string value if the link source is **not** a Dropbox link.","enum":["","deep_link","in_meeting"]},"file_link":{"type":"string","description":"The Dropbox file's link. This field returns an empty string value if the file link is **not** from a Dropbox source."},"date_time":{"type":"string","description":"The screenshare's date and time.","format":"date-time"},"source":{"type":"string","description":"The source from which the file was shared: \n* `dropbox` — A Dropbox source. \n* An empty string if the source is **not** Dropbox.","enum":["","dropbox"]}},"additionalProperties":false,"description":"Information about the webinar's screenshare."}},"additionalProperties":false,"description":"Information about the webinar participant."}},"additionalProperties":false,"description":"Information about the webinar."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.summary_trashedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who hosted the meeting."},"operator":{"type":"string","description":"The email address of the user who deleted the meeting summary."},"operator_id":{"type":"string","description":"The user ID of the user who deleted the meeting summary."},"object":{"required":["meeting_end_time","meeting_host_email","meeting_host_id","meeting_id","meeting_start_time","meeting_topic","meeting_uuid","summary_created_time","summary_end_time","summary_last_modified_time","summary_start_time","summary_title"],"type":"object","properties":{"meeting_host_id":{"type":"string","description":"The ID of the user who is set as the meeting host."},"meeting_host_email":{"type":"string","description":"The meeting host's email address.","format":"email"},"meeting_uuid":{"type":"string","description":"Unique meeting ID. Each meeting instance generates its own meeting UUID - after a meeting ends, a new UUID is generated for the next instance of the meeting. Retrieve a list of UUIDs from past meeting instances using the [**List past meeting instances**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/pastMeetings) API. [Double encode](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#meeting-id-and-uuid) your UUID when using it for API calls if the UUID begins with a `/` or contains `//` in it.\n"},"meeting_id":{"type":"integer","description":"[Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-) - the meeting's unique identifier in **long** format, represented as int64 data type in JSON. Also known as the meeting number.","format":"int64"},"meeting_topic":{"type":"string","description":"Meeting topic."},"meeting_start_time":{"type":"string","description":"The meeting's start date and time.","format":"date-time"},"meeting_end_time":{"type":"string","description":"The meeting's end date and time.","format":"date-time","example":"2020-07-15T23:30:19Z"},"summary_start_time":{"type":"string","description":"The summary's start date and time.","format":"date-time"},"summary_end_time":{"type":"string","description":"The summary's end date and time.","format":"date-time"},"summary_created_time":{"type":"string","description":"The date and time when the meeting summary was created.","format":"date-time"},"summary_last_modified_time":{"type":"string","description":"The date and time when the meeting summary was last modified.","format":"date-time"},"summary_title":{"type":"string","description":"The summary title."}},"additionalProperties":true,"description":"Information about the meeting summary."}},"additionalProperties":true}},"additionalProperties":true},"Meeting.sharing_startedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the meeting."},"object":{"required":["duration","host_id","id","participant","start_time","topic","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The meeting ID."},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type: \n* `0` — A prescheduled meeting. \n* `1` — An instant meeting. \n* `2` — A scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` — A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` — A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"pattern":"(^\\s*$|^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$)","type":"string","description":"The meeting's start time."},"timezone":{"type":"string","description":"The meeting's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"duration":{"type":"integer","description":"The scheduled meeting duration."},"participant":{"required":["sharing_details","user_id"],"type":"object","properties":{"user_id":{"type":"string","description":"The participant's meeting user ID. This value is assigned to a participant upon joining a meeting and is only valid for the duration of the meeting."},"user_name":{"type":"string","description":"The participant's display name."},"id":{"type":"string","description":"The participant's universally unique ID (UUID): \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value."},"sharing_details":{"required":["content","date_time","file_link","link_source","source"],"type":"object","properties":{"content":{"type":"string","description":"The type of shared content: \n* `application` — An application. For example, a web browser. \n* `whiteboard` — The [classic whiteboard](https://support.zoom.us/hc/en-us/articles/205677665-Sharing-a-whiteboard). \n* `desktop` — A user's desktop. \n* `airplay` — A user's [AirPlay (Apple screen mirroring)](https://support.zoom.us/hc/en-us/articles/204726885-Sharing-screen-using-Apple-screen-mirroring-AirPlay-). \n* `camera` — A user's camera. \n* `unknown` — An unrecognized application, such as a third party app.","enum":["application","whiteboard","desktop","airplay","camera","unknown"]},"link_source":{"type":"string","description":"The Dropbox sharing method: \n* `deep_link` — A [deep link](https://en.wikipedia.org/wiki/Deep_linking). \n* `in_meeting` — A link shared via Zoom. \n* An empty (`””`) value if the link source is **not** a Dropbox link.","enum":["","deep_link","in_meeting"]},"file_link":{"type":"string","description":"The Dropbox file's link. This field returns an empty (`””`) value if the file link is **not** from a Dropbox source."},"date_time":{"type":"string","description":"The screenshare's date and time.","format":"date-time"},"source":{"type":"string","description":"The source from which the file was shared: \n* `dropbox` — A Dropbox source. \n* An empty (`””`) value if the source is **not** Dropbox.","enum":["","dropbox"]}},"additionalProperties":false,"description":"Information about the meeting's screenshare."}},"additionalProperties":false,"description":"Information about the meeting participant."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Webinar.registration_createdEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the webinar."},"object":{"required":["duration","host_id","id","registrant","start_time","timezone","topic","type","uuid"],"type":"object","properties":{"uuid":{"type":"string","description":"The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."},"id":{"type":"integer","description":"The webinar ID."},"host_id":{"type":"string","description":"The webinar host's user ID."},"topic":{"type":"string","description":"The webinar's topic."},"type":{"type":"integer","description":"The webinar type: \n* `5` — A webinar. \n* `6` — A recurring webinar without a fixed time. \n* `9` — A recurring webinar with a fixed time.","enum":[5,6,9]},"start_time":{"type":"string","description":"The webinar's start time.","format":"date-time"},"duration":{"type":"integer","description":"The scheduled webinar duration."},"timezone":{"type":"string","description":"The webinar's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"occurrences":{"type":"array","description":"Information about recurring webinar with fixed times and their occurrences. This only returns when the webinar's `type` value is `9`.","items":{"anyOf":[{"required":["occurrence_id","start_time"],"type":"object","properties":{"occurrence_id":{"type":"string","description":"The webinar occurrence's ID."},"start_time":{"type":"string","description":"The webinar's start time.","format":"date-time"}},"additionalProperties":false}]}},"registrant":{"required":["email","first_name","id","join_url","status"],"type":"object","properties":{"id":{"type":"string","description":"The registrant's ID."},"first_name":{"type":"string","description":"The registrant's first name."},"last_name":{"type":"string","description":"The registrant's last name."},"email":{"type":"string","description":"The registrant's email address.","format":"email"},"address":{"type":"string","description":"The registrant's address."},"city":{"type":"string","description":"The registrant's city."},"country":{"type":"string","description":"The registrant's two-letter [country code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries)."},"zip":{"type":"string","description":"The registrant's ZIP or postal code."},"state":{"type":"string","description":"The registrant's state or province."},"phone":{"type":"string","description":"The registrant's phone number."},"industry":{"type":"string","description":"The registrant's industry."},"org":{"type":"string","description":"The registrant's organization."},"job_title":{"type":"string","description":"The registrant's job title."},"purchasing_time_frame":{"type":"string","description":"The registrant's purchasing time frame: \n* `Within a month` \n* `1-3 months` \n* `4-6 months` \n* `More than 6 months` \n* `No timeframe`","enum":["","Within a month","1-3 months","4-6 months","More than 6 months","No timeframe"]},"role_in_purchase_process":{"type":"string","description":"The registrant's role in the purchase process: \n* `Decision Maker` \n* `Evaluator/Recommender` \n* `Influencer` \n* `Not involved`","enum":["","Decision Maker","Evaluator/Recommender","Influencer","Not involved"]},"no_of_employees":{"type":"string","description":"The registrant's number of employees: \n* `1-20` \n* `21-50` \n* `51-100` \n* `101-250` \n* `251-500` \n* `501-1,000` \n* `1,001-5,000` \n* `5,001-10,000` \n* `More than 10,000`","enum":["","1-20","21-50","51-100","101-250","251-500","501-1,000","1,001-5,000","5,001-10,000","More than 10,000"]},"comments":{"type":"string","description":"The registrant's questions and comments."},"custom_questions":{"type":"array","description":"Information about custom questions.","items":{"anyOf":[{"required":["title","value"],"type":"object","properties":{"title":{"type":"string","description":"The title of the custom question."},"value":{"maxLength":128,"type":"string","description":"The custom question's response value. This has a limit of 128 characters."}},"additionalProperties":false}]}},"status":{"type":"string","description":"The registrant's registration approval status: \n* `approve` — Approved registrant. \n* `pending` — Registration approval pending.","enum":["approved","pending"]},"join_url":{"type":"string","description":"The URL to join the webinar."},"tracking_source":{"required":["id","source_name","tracking_url"],"type":"object","properties":{"id":{"type":"string","description":"Unique Identifier of the tracking source."},"source_name":{"type":"string","description":"Name of the source (platform) where the registration URL was shared."},"tracking_url":{"type":"string","description":"Tracking URL. The URL that was shared for the registration."}},"additionalProperties":false,"description":"Information about the source tracking. See [Creating webinar registration tracking links](https://support.zoom.us/hc/en-us/articles/360000315683-Creating-webinar-registration-tracking-links) for details."}},"additionalProperties":false,"description":"Information about the webinar registrant."}},"additionalProperties":false,"description":"Information about the webinar registration."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.chat_message_sentEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"The timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the meeting."},"object":{"required":["chat_message","id","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The meeting ID.","format":"int64"},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"breakout_room_uuid":{"type":"string","description":"The breakout room's universally unique identifier (UUID). Each breakout room instance generates a breakout room UUID."},"chat_message":{"required":["date_time","message_content","message_id","recipient_context","recipient_type","sender_context","sender_name","sender_session_id","sender_type"],"type":"object","properties":{"date_time":{"type":"string","description":"The date and time when the chat message was sent.","format":"date-time"},"sender_session_id":{"type":"string","description":"The message sender's session ID."},"sender_name":{"type":"string","description":"The message sender's name."},"sender_email":{"type":"string","description":"The message sender's email address.","format":"email"},"sender_type":{"type":"string","description":"The type of user that sent the message: \n* `host` — The meeting host. \n* `guest` — A meeting guest.","enum":["host","guest"]},"sender_context":{"type":"string","description":"The context where the sender is located when the message is generated. \n* `meeting` - The sender is in a meeting. \n* `breakout_room` - The sender is in a breakout room. \n* `waiting_room` - The sender is in the waiting room.","enum":["meeting","breakout_room","waiting_room"]},"recipient_session_id":{"type":"string","description":"The message recipient's session ID."},"recipient_name":{"type":"string","description":"The message recipient's name."},"recipient_email":{"type":"string","description":"The message recipient's email address. Optional only included if it is a private message.","format":"email"},"recipient_type":{"type":"string","description":"The type of message recipient. \n* `everyone` - All meeting participants. \n* `host` - The meeting host. \n* `guest` - A meeting guest. \n* `group` - A group chat. \n* `host_group` - The meeting host and all co-hosts.","enum":["everyone","host","guest","group","host_group"]},"recipient_context":{"type":"string","description":"The context where the recipient is located when the message is delivered. \n* `meeting` - The recipient is in the meeting. \n* `breakout_room` - The recipient is in a breakout room. \n* `waiting_room` - The recipient is in the waiting room.","enum":["meeting","breakout_room","waiting_room"]},"message_id":{"type":"string","description":"The chat message's UUID."},"message_content":{"type":"string","description":"The chat message's content."},"file_ids":{"type":"array","description":"The live webinar chat file's UUID, in base64-encoded format.","items":{"type":"string"}}},"additionalProperties":false,"description":"Information about the chat message."}},"additionalProperties":false,"description":"Information about the chat message."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.invitation_rejectedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The meeting host's account ID."},"operator":{"type":"string","description":"The email address of the user who rejected the meeting."},"operator_id":{"type":"string","description":"The user ID of the user who rejected the meeting."},"object":{"required":["host_id","id","participant","topic","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The meeting ID."},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"participant":{"required":["email","participant_user_id"],"type":"object","properties":{"participant_user_id":{"type":"string","description":"The user ID of the user who received the meeting invitation."},"email":{"type":"string","description":"The email address of the user who received the meeting invitation. If the participant is **not** part of the host's account, the `email` field returns an empty string value, with some exceptions. For more information, read our [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) documentation.","format":"email"}},"additionalProperties":false,"description":"Information about the invited participant."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.participant_role_changedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the meeting."},"object":{"required":["duration","host_id","participant","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The meeting ID."},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type. \n* `0` - A prescheduled meeting. \n* `1` - An instant meeting. \n* `2` - A scheduled meeting. \n* `3` - A recurring meeting with no fixed time. \n* `4` - A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` - A [PAC (personal audio conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` - A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"pattern":"(^\\s*$|^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$)","type":"string","description":"The meeting's start time."},"timezone":{"type":"string","description":"The meeting's [timezone](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones)."},"duration":{"type":"integer","description":"The scheduled meeting duration."},"participant":{"required":["date_time","email","new_role","old_role","user_id","user_name"],"type":"object","properties":{"user_id":{"type":"string","description":"The participant's meeting user ID. This value is assigned to a participant when they join a meeting, and is only valid for the duration of the meeting."},"user_name":{"type":"string","description":"The participant's display name."},"email":{"type":"string","description":"The participant's email address. This response only returns if the participant joined the meeting by logging into Zoom. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. For more information, read our [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) documentation.","format":"email"},"registrant_id":{"type":"string","description":"The participant's registrant ID. A host or a user with administrative permissions can require [registration for Zoom meetings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065026)."},"participant_user_id":{"type":"string","description":"The participant's universally unique ID (UUID).\n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value.\n\nThis value returns blank for external users."},"participant_uuid":{"type":"string","description":"The participant's UUID for this specific meeting and any breakout rooms created in this meeting. This value is assigned to a participant when they join a meeting, and is only valid for the duration of that meeting."},"date_time":{"type":"string","description":"The time at which the participant changed the [role](https://support.zoom.us/hc/en-us/articles/360040324512-Roles-in-a-meeting).","format":"date-time"},"old_role":{"type":"string","description":"The participant's previous role: \n* `host` — Host. \n* `co-host` — Co-host. \n* `attendee` — Attendee.","enum":["host","co-host","attendee"]},"new_role":{"type":"string","description":"The participant's new role: \n* `host` — Host. \n* `co-host` — Co-host. \n* `attendee` — Attendee.","enum":["host","co-host","attendee"]}},"additionalProperties":false,"description":"Information about the meeting participant."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.permanently_deletedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who permanently deleted the meeting."},"operator":{"type":"string","description":"The email address of the user who permanently deleted the meeting.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who permanently deleted the meeting."},"operation":{"type":"string","description":"The type of operation performed: \n* `all` — The change was applied to all meetings. \n* `single` — The change was applied only to a single meeting.","enum":["all","single"]},"object":{"required":["duration","host_id","id","start_time","timezone","topic","type","uuid"],"type":"object","properties":{"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"id":{"type":"integer","description":"The meeting ID.","format":"int64"},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type: \n* `0` — A prescheduled meeting. \n* `1` — An instant meeting. \n* `2` — A scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` — A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` — A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"type":"string","description":"The meeting's start time.","format":"date-time"},"duration":{"type":"integer","description":"The scheduled meeting duration."},"timezone":{"type":"string","description":"The meeting's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"occurrences":{"type":"array","description":"Information about recurring meetings with fixed times and their occurrences. This only returns when the meeting's `type` value is `8`.","items":{"anyOf":[{"required":["occurrence_id","start_time"],"type":"object","properties":{"occurrence_id":{"type":"string","description":"The meeting occurrence's ID."},"start_time":{"type":"string","description":"The meeting's start time.","format":"date-time"}},"additionalProperties":true}]}}},"additionalProperties":true,"description":"Information about the meeting."}},"additionalProperties":true}},"additionalProperties":true},"Recording.registration_createdEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the host that recorded the meeting or webinar."},"object":{"required":["duration","host_id","id","registrant","start_time","topic","type","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The ID of the recorded meeting (`meetingId`) or webinar (`webinarId`).","format":"int64"},"uuid":{"type":"string","description":"The universally unique identifier (UUID) of the recorded meeting or webinar instance."},"host_id":{"type":"string","description":"The webinar or meeting host's user ID."},"topic":{"type":"string","description":"The meeting or webinar topic."},"type":{"type":"integer","description":"The type of recorded meeting or webinar: \n\n If the recording is of a meeting: \n* `1` — Instant meeting. \n* `2` — Scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A meeting created via PMI (Personal Meeting ID). \n* `7` — A [Personal Audio Conference](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) (PAC). \n* `8` - Recurring meeting with a fixed time. \n\n If the recording is of a webinar: \n* `5` — A webinar. \n* `6` — A recurring webinar without a fixed time. \n* `9` — A recurring webinar with a fixed time. \n\n If the recording is **not** from a meeting or webinar: \n\n* `99` — A recording uploaded via the [**Recordings**](https://zoom.us/recording) interface on the Zoom Web Portal.","enum":[1,2,3,4,5,6,7,8,9,99]},"start_time":{"type":"string","description":"The meeting or webinar's start time.","format":"date-time"},"timezone":{"type":"string","description":"The meeting or webinar's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"duration":{"type":"integer","description":"The scheduled meeting or webinar duration."},"registrant":{"required":["address","city","comments","country","email","first_name","industry","job_title","last_name","no_of_employees","org","phone","purchasing_time_frame","role_in_purchase_process","state","status","zip"],"type":"object","properties":{"id":{"type":"string","description":"The registrant's ID."},"email":{"type":"string","description":"The registrant's email address.","format":"email"},"status":{"type":"string","description":"The registrant's status: \n* `approved` — Registrant is approved. \n* `denied` — Registrant is denied. \n* `pending` — Registrant is waiting for approval. \n* `all` — The default status code.","default":"all","enum":["approved","denied","pending","all"]},"first_name":{"type":"string","description":"The registrant's first name."},"last_name":{"type":"string","description":"The registrant's last name."},"address":{"type":"string","description":"The registrant's address."},"city":{"type":"string","description":"The registrant's city."},"country":{"type":"string","description":"The registrant's two-letter [country code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries)."},"zip":{"type":"string","description":"The registrant's ZIP or postal code."},"state":{"type":"string","description":"The registrant's state or province."},"phone":{"type":"string","description":"The registrant's phone number."},"industry":{"type":"string","description":"The registrant's industry."},"org":{"type":"string","description":"The registrant's organization."},"job_title":{"type":"string","description":"The registrant's job title."},"purchasing_time_frame":{"type":"string","description":"The registrant's purchasing time frame: \n* `Within a month` \n* `1-3 months` \n* `4-6 months` \n* `More than 6 months` \n* `No timeframe`","enum":["","Within a month","1-3 months","4-6 months","More than 6 months","No timeframe"]},"role_in_purchase_process":{"type":"string","description":"The registrant's role in the purchase process: \n* `Decision Maker` \n* `Evaluator/Recommender` \n* `Influencer` \n* `Not involved`","enum":["","Decision Maker","Evaluator/Recommender","Influencer","Not involved"]},"no_of_employees":{"type":"string","description":"The registrant's number of employees: \n* `1-20` \n* `21-50` \n* `51-100` \n* `101-250` \n* `251-500` \n* `501-1,000` \n* `1,001-5,000` \n* `5,001-10,000` \n* `More than 10,000`","enum":["","1-20","21-50","51-100","101-250","251-500","501-1,000","1,001-5,000","5,001-10,000","More than 10,000"]},"comments":{"type":"string","description":"The registrant's questions and comments."},"custom_questions":{"type":"array","description":"Information about custom questions.","items":{"type":"object","properties":{"title":{"type":"string","description":"The title of the custom question."},"value":{"maxLength":128,"type":"string","description":"The custom question's response value. This has a limit of 128 characters."}},"additionalProperties":false}}},"additionalProperties":false,"description":"Information about the recording registrant."}},"additionalProperties":false,"description":"Information about the recording registration."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.createdEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the meeting."},"operator":{"type":"string","description":"The email address of the user who created the meeting.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who created the meeting."},"operation":{"type":"string","description":"The type of operation performed on a recurring meeting.\n* `all` - The change was applied to all occurrences.\n* `single` - The change was applied to a single occurrence.\n* `range` - The change was applied to a range of occurrences while the other occurrences are unchanged. To enable this feature for your account, please [contact Zoom Support](https://support.zoom.us/hc/en-us).","enum":["all","single","range"]},"object":{"required":["creation_source","duration","host_id","id","join_url","settings","topic","type","uuid"],"type":"object","properties":{"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"id":{"type":"integer","description":"The meeting ID.","format":"int64"},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type. \n* `0` - A prescheduled meeting. \n* `1` - An instant meeting. \n* `2` - A scheduled meeting. \n* `3` - A recurring meeting with no fixed time. \n* `4` - A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` - A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` - A recurring meeting with a fixed time. \n* `10` - A screen share only meeting.","enum":[0,1,2,3,4,7,8,10]},"start_time":{"type":"string","description":"The meeting's start time.","format":"date-time"},"duration":{"type":"integer","description":"The scheduled meeting duration."},"timezone":{"type":"string","description":"The meeting's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"join_url":{"type":"string","description":"The URL to join the meeting."},"password":{"type":"string","description":"The password required to join the meeting."},"pmi":{"type":"string","description":"The [Personal Meeting ID (PMI)](https://support.zoom.us/hc/en-us/articles/201362843-What-is-Personal-Meeting-ID-PMI-and-Personal-Link-)."},"creation_source":{"type":"string","description":"The platform that the meeting was created through.\n* `other` - Created through another platform.\n* `open_api` - Created through Open API.\n* `web_portal` - Created through the web portal.","enum":["other","open_api","web_portal"]},"recurrence_event_id":{"type":"string","description":"The unique identifier of the recurring event that the occurrences belong to. Updating a recurring meeting with **This and following events** splits it into two recurring events, each with its own `recurrence_event_id`. To enable this feature for your account, please [contact Zoom Support](https://support.zoom.us/hc/en-us)."},"occurrences":{"type":"array","description":"Information about recurring meetings with fixed times and their occurrences. This only returns when the meeting's `type` value is `8`.","items":{"required":["occurrence_id","start_time"],"type":"object","properties":{"occurrence_id":{"type":"string","description":"The meeting occurrence's ID."},"start_time":{"type":"string","description":"The meeting's start time.","format":"date-time"},"duration":{"type":"integer","description":"The scheduled meeting duration."},"status":{"type":"string","description":"The meeting occurrence status: \n* `available` \n* `deleted`","enum":["available","deleted"]}},"additionalProperties":true}},"settings":{"required":["alternative_hosts","use_pmi"],"type":"object","properties":{"use_pmi":{"type":"boolean","description":"Whether the use of PMI is enabled."},"alternative_hosts":{"type":"string","description":"A semicolon-separated list of the meeting's alternative hosts' email addresses or IDs."},"meeting_invitees":{"type":"array","description":"A list of the meeting's invitees.","items":{"type":"object","properties":{"email":{"type":"string","description":"The invitee's email address.","format":"email"}}}},"join_before_host":{"type":"boolean","description":"Whether participants can join the meeting before its host. This field is only used for scheduled meetings (`2`) or recurring meetings (`3` and `8`). This value defaults to `false`.\n\nIf the [**Waiting Room** feature](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) is enabled, this setting is **disabled**."},"jbh_time":{"type":"integer","description":"If the value of the `join_before_host` field is `true`, this field indicates the time limits when a participant can join a meeting before the meeting's host.\n\n* `0` - Allow the participant to join the meeting at anytime.\n* `5` - Allow the participant to join 5 minutes before the meeting's start time.\n* `10` - Allow the participant to join 10 minutes before the meeting's start time.\n* `15` - Allow the participant to join 15 minutes before the meeting's start time.","enum":[0,5,10,15]}},"additionalProperties":true,"description":"Information about the meeting's settings."},"recurrence":{"type":"object","properties":{"type":{"type":"integer","description":"The type of recurring meeting. \n* `1` - Daily. \n* `2` - Weekly. \n* `3` - Monthly.","enum":[1,2,3]},"repeat_interval":{"type":"integer","description":"The meeting's repeat interval. \n* For daily intervals, a max of `99` days. \n* For a weekly interval, a max of `50` weeks. \n* For monthly intervals, a max of `10` months."},"weekly_days":{"type":"string","description":"A comma-separated list of the days of the week when the recurring weekly meeting occurs. \n* `1` - Sunday \n* `2` - Monday \n* `3` - Tuesday \n* `4` - Wednesday \n* `5` - Thursday \n* `6` - Friday \n* `7` - Saturday"},"monthly_day":{"maximum":31,"minimum":1,"type":"integer","description":"The day of the month when the recurring monthly meeting occurs. The value ranges from 1 to 31."},"monthly_week_day":{"type":"integer","description":"The day of the week when the recurring monthly meeting is scheduled. \n* `1` - Sunday \n* `2` - Monday \n* `3` - Tuesday \n* `4` - Wednesday \n* `5` - Thursday \n* `6` - Friday \n* `7` - Saturday","enum":[1,2,3,4,5,6,7]},"end_times":{"type":"integer","description":"The number of times the recurring meeting will occur before it is canceled."},"end_date_time":{"type":"string","description":"The recurring meeting's final ending date and time before it is canceled, in UTC format.","format":"date-time"},"monthly_week":{"type":"integer","description":"The week of the month when a recurring meeting occurs. \n* `-1` - The last week of the month. \n* `1` - The first week. \n* `2` - The second week. \n* `3` - The third week. \n* `4` - The fourth week.","enum":[-1,1,2,3,4]}},"additionalProperties":true,"description":"Information about [recurring meetings](https://marketplace.zoom.us/docs/api-reference/other-references/recurrence-object-definitions)."},"tracking_fields":{"type":"array","description":"Information about the meeting's [tracking fields](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields).","items":{"type":"object","properties":{"field":{"type":"string","description":"The tracking field's label."},"value":{"type":"string","description":"The tracking field's value."},"visible":{"type":"boolean","description":"Whether the tracking field is visible in the meeting scheduling options in the Zoom web portal. When the tracking field is disabled, the field can be only be set by users via API."}},"additionalProperties":true}}},"additionalProperties":true,"description":"Information about the meeting."}},"additionalProperties":true}},"additionalProperties":true},"Meeting.live_streaming_startedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the meeting."},"operator":{"type":"string","description":"The email address of the user who updated the meeting.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who updated the meeting."},"object":{"required":["duration","host_id","id","live_streaming","start_time","topic","type","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The meeting ID.","format":"int64"},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type: \n* `0` — A prescheduled meeting. \n* `1` — An instant meeting. \n* `2` — A scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` — A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` — A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"type":"string","description":"The meeting's start time.","format":"date-time"},"timezone":{"type":"string","description":"The meeting's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"duration":{"type":"integer","description":"The scheduled meeting duration."},"live_streaming":{"required":["date_time","service"],"type":"object","properties":{"service":{"type":"string","description":"The name of the live streaming service: \n* `Facebook` \n* `Workplace_by_Facebook` \n* `YouTube` \n* `Twitch` \n* `Custom_Live_Streaming_Service`","enum":["Facebook","Workplace_by_Facebook","YouTube","Twitch","Custom_Live_Streaming_Service"]},"custom_live_streaming_settings":{"required":["page_url","stream_key","stream_url"],"type":"object","properties":{"stream_url":{"type":"string","description":"The live stream's URL."},"stream_key":{"type":"string","description":"The live stream's key."},"page_url":{"type":"string","description":"The live stream's page URL."},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display."}},"description":"Information about the custom live stream."},"date_time":{"type":"string","description":"The date and time the live stream started.","format":"date-time"}},"description":"Information about the live stream."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.participant_room_system_callout_acceptedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the meeting host."},"object":{"required":["host_id","id","inviter_name","message_id","participant","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The meeting ID.","format":"int64"},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The user ID of the meeting host."},"message_id":{"type":"string","description":"The request unique identifier (UUID)."},"inviter_name":{"type":"string","description":"The user name of the event's trigger."},"participant":{"required":["call_type","device_ip"],"type":"object","properties":{"call_type":{"type":"string","description":"The type of call out. Use a value of `h323` or `sip`."},"device_ip":{"type":"string","description":"The user's device IP address."}},"additionalProperties":false,"description":"Information about the invited participant."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Webinar.registration_approvedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who approved the registration."},"operator":{"type":"string","description":"The email address of the user who approved the webinar registration.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who approved the webinar registration."},"object":{"required":["duration","host_id","id","registrant","start_time","timezone","topic","type","uuid"],"type":"object","properties":{"uuid":{"type":"string","description":"The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."},"id":{"type":"integer","description":"The webinar ID."},"host_id":{"type":"string","description":"The webinar host's user ID."},"topic":{"type":"string","description":"The webinar's topic."},"type":{"type":"integer","description":"The webinar type: \n* `5` — A webinar. \n* `6` — A recurring webinar without a fixed time. \n* `9` — A recurring webinar with a fixed time.","enum":[5,6,9]},"start_time":{"type":"string","description":"The webinar's start time.","format":"date-time"},"duration":{"type":"integer","description":"The scheduled webinar duration."},"timezone":{"type":"string","description":"The webinar's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"occurrences":{"type":"array","description":"Information about recurring webinar with fixed times and their occurrences. This only returns when the webinar's `type` value is `9`.","items":{"anyOf":[{"required":["occurrence_id","start_time"],"type":"object","properties":{"occurrence_id":{"type":"string","description":"The webinar occurrence's ID."},"start_time":{"type":"string","description":"The webinar's start time.","format":"date-time"}},"additionalProperties":false}]}},"registrant":{"required":["email","first_name","id","join_url"],"type":"object","properties":{"id":{"type":"string","description":"The registrant's ID."},"first_name":{"type":"string","description":"The registrant's first name."},"last_name":{"type":"string","description":"The registrant's last name."},"email":{"type":"string","description":"The registrant's email address.","format":"email"},"join_url":{"type":"string","description":"The URL to join the webinar."},"tracking_source":{"required":["id","source_name","tracking_url"],"type":"object","properties":{"id":{"type":"string","description":"Unique Identifier of the tracking source."},"source_name":{"type":"string","description":"Name of the source (platform) where the registration URL was shared."},"tracking_url":{"type":"string","description":"Tracking URL. The URL that was shared for the registration."}},"additionalProperties":false,"description":"Information about the source tracking. See [Creating webinar registration tracking links](https://support.zoom.us/hc/en-us/articles/360000315683-Creating-webinar-registration-tracking-links) for details."}},"additionalProperties":false,"description":"Information about the webinar registrant."}},"additionalProperties":false,"description":"Information about the webinar registration."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.breakout_room_sharing_startedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The main meeting host's account ID."},"object":{"required":["breakout_room_uuid","duration","host_id","id","participant","start_time","topic","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The main meeting ID."},"uuid":{"type":"string","description":"The main meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"breakout_room_uuid":{"type":"string","description":"The breakout room's universally unique identifier (UUID). Each breakout room instance generates a breakout room UUID."},"host_id":{"type":"string","description":"The main meeting host's user ID."},"topic":{"type":"string","description":"The main meeting's topic."},"type":{"type":"integer","description":"The main meeting type: \n* `0` — A prescheduled meeting. \n* `1` — An instant meeting. \n* `2` — A scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` — A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` — A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"pattern":"(^\\s*$|^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$)","type":"string","description":"The main meeting's start time."},"timezone":{"type":"string","description":"The main meeting's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"duration":{"type":"integer","description":"The main scheduled meeting duration."},"participant":{"required":["sharing_details","user_id"],"type":"object","properties":{"user_id":{"type":"string","description":"The participant's ID. This is a unique ID assigned to the participant upon joining the meeting and is only valid for that meeting."},"parent_user_id":{"type":"string","description":"The participant's main meeting user ID (`user_id`)."},"user_name":{"type":"string","description":"The participant's username."},"id":{"type":"string","description":"The participant's user ID. This is the same value used in the [**Users**](/api-reference/zoom-api/methods#tag/Users) APIs if the participant logged in to join the meeting."},"sharing_details":{"required":["content","date_time","file_link","link_source","source"],"type":"object","properties":{"content":{"type":"string","description":"The type of shared content: \n* `application` — An application. For example, a web browser. \n* `whiteboard` — The [Zoom Whiteboard](https://support.zoom.us/hc/en-us/articles/4410916881421). \n* `desktop` — A user's desktop. \n* `airplay` — A user's airplay. \n* `camera` — A user's camera. \n* `unknown` — An unrecognized application, such as a third party app.","enum":["application","whiteboard","desktop","airplay","camera","unknown"]},"link_source":{"type":"string","description":"The Dropbox sharing method: \n* `deep_link` — A [deep link](https://en.wikipedia.org/wiki/Deep_linking). \n* `in_meeting` — A link shared via Zoom. \n* An empty string value if the link source is **not** a Dropbox link.","enum":["","deep_link","in_meeting"]},"file_link":{"type":"string","description":"The Dropbox file's link. This field returns an empty string value if the file link is **not** from a Dropbox source."},"date_time":{"type":"string","description":"The screenshare's date and time.","format":"date-time"},"source":{"type":"string","description":"The source from which the file was shared: \n* `dropbox` — A Dropbox source. \n* An empty string value if the source is **not** Dropbox.","enum":["","dropbox"]}},"additionalProperties":false,"description":"Information about the meeting's screenshare."}},"additionalProperties":false,"description":"Information about the meeting participant."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.participant_bindEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the meeting."},"object":{"required":["host_id","participant","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The meeting ID."},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type. \n* `0` - A prescheduled meeting. \n* `1` - An instant meeting. \n* `2` - A scheduled meeting. \n* `3` - A recurring meeting with no fixed time. \n* `4` - A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` - A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` - A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"pattern":"(^\\s*$|^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$)","type":"string","description":"The meeting's start time."},"timezone":{"type":"string","description":"The meeting's [timezone](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones)."},"duration":{"type":"integer","description":"The scheduled meeting duration."},"participant":{"required":["bind_user_id","join_time","phone_number","user_id"],"type":"object","properties":{"user_id":{"type":"string","description":"The participant's meeting user ID. This value is assigned to a participant when they join a meeting, and is only valid for the duration of the meeting."},"bind_user_id":{"type":"string","description":"The particpant's meeting user ID of participant the phone user bind to. This value is assigned to a participant when they join a meeting, and is only valid for the duration of the meeting."},"user_name":{"type":"string","description":"The participant's display name."},"id":{"type":"string","description":"The participant's universally unique ID (UUID). \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value. \n\n This value returns blank for external users.\n\n**Note:** Use the `participant_user_id` value instead of this value. We will remove this response in a future release."},"participant_uuid":{"type":"string","description":"The participant's UUID for this specific meeting and any breakout rooms created in this meeting. This value is assigned to a participant when they join a meeting, and is only valid for the duration of that meeting."},"bind_participant_uuid":{"type":"string","description":"The participant's UUID of the user which this phone user binds to."},"date_time":{"type":"string","description":"The time when the participant is bond.","format":"date-time"},"email":{"type":"string","description":"The participant's email address. This response only returns if the participant joined the meeting by logging into Zoom. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details.","format":"email"},"participant_user_id":{"type":"string","description":"The participant's universally unique ID (UUID). \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value.\n\n This value returns blank for external users."},"registrant_id":{"type":"string","description":"The registrant ID of the participants this phone user binds to. A host or a user with administrative permissions can require [registration for Zoom meetings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065026)."},"phone_number":{"type":"string","description":"Phone number of participants who joined via PSTN.","example":"8615250064084"}},"additionalProperties":false,"description":"Information about the meeting participant. If the participant is **not** part of the host's account, `email` returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.participant_feedbackEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who commits the feedback."},"object":{"required":["id","participant","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The meeting ID."},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"participant":{"required":["feedback","participant_user_id","participant_uuid","user_name"],"type":"object","properties":{"participant_uuid":{"type":"string","description":"The participant's meeting universally unique ID (UUID). This value is assigned to a participant when they join a meeting, and is only valid for the duration of the meeting. This value will not be changed when the participant joins/leaves a breakout room."},"participant_user_id":{"type":"string","description":"The participant's universally unique ID (UUID). This value returns blank for users who aren't logged into Zoom."},"user_name":{"type":"string","description":"The participant's display name."},"feedback":{"required":["rating_quality","satisfied"],"type":"object","properties":{"satisfied":{"type":"boolean","description":"Whether the participant is satisfied.","deprecated":true},"rating_quality":{"description":"The feedback rating quality. ","oneOf":[{"required":["quality","type"],"type":"object","properties":{"type":{"type":"string","description":"Indicates 2-point feedback.","enum":["2-point"]},"quality":{"type":"string","description":"Quality submitted for 2-point feedback.","enum":["GOOD","NOT GOOD"]}},"description":"2-point feedback mode."},{"required":["quality","type"],"type":"object","properties":{"type":{"type":"string","description":"Indicates 5-point feedback.","enum":["5-point"]},"quality":{"type":"string","description":"Quality submitted for 5-point feedback.","enum":["VERY GOOD","GOOD","FAIR","POOR","VERY POOR"]}},"description":"5-point feedback mode."}]},"feedback_details":{"type":"array","description":"The feedback details.","items":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"The feedback ID. \n* `1` — Poor video quality. \n* `2` — Poor audio quality. \n* `5` — Unable to present using share.zoom.us. \n* `7` — Unable to make phone call. \n* `8` — They could not hear us. \n* `9` — We could not hear them. \n* `10` — They could not see us. \n* `11` — We could not see them. \n* `12` — Could not present computer screen. \n* `999` — Others."},"name":{"type":"string","description":"The feedback name."}},"additionalProperties":false}},"comments":{"type":"string","description":"The participant's comments."}},"additionalProperties":false,"description":"Information about the feedback."},"zoom_room_id":{"type":"string","description":"The ID of the Zoom Room submitted the feedback. This field is only returned when the feedback is submitted by Zoom Rooms."},"zoom_room_platform":{"type":"string","description":"The platform of the Zoom Room submitted the feedback. This field is only returned when the feedback is submitted by Zoom Rooms."},"zoom_room_sender_email":{"type":"string","description":"Zoom Rooms feedback sender email. This field is only returned when the feedback is submitted by Zoom Rooms."}},"additionalProperties":false,"description":"Information about the meeting participant."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Recording.deletedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user that completed the meeting or webinar recording."},"operator":{"type":"string","description":"The email address of the user who deleted the recording.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who deleted the recording."},"object":{"required":["account_id","duration","host_id","id","recording_count","recording_files","share_url","start_time","topic","total_size","type","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The ID of the recorded meeting (`meetingId`) or webinar (`webinarId`).","format":"int64"},"uuid":{"type":"string","description":"The universally unique identifier (UUID) of the recorded meeting or webinar instance."},"host_id":{"type":"string","description":"The ID of the user set as the host of the meeting or webinar."},"account_id":{"type":"string","description":"The account ID of the user that completed the meeting or webinar recording."},"topic":{"type":"string","description":"The meeting or webinar topic."},"type":{"type":"integer","description":"The type of recorded meeting or webinar: \n\n If the recording is of a meeting: \n* `1` — Instant meeting. \n* `2` — Scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A meeting created via PMI (Personal Meeting ID). \n* `7` — A [Personal Audio Conference](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) (PAC). \n* `8` - Recurring meeting with a fixed time. \n\n If the recording is of a webinar: \n* `5` — A webinar. \n* `6` — A recurring webinar without a fixed time. \n* `9` — A recurring webinar with a fixed time. \n\n If the recording is **not** from a meeting or webinar: \n\n* `99` — A recording uploaded via the [**Recordings**](https://zoom.us/recording) interface on the Zoom Web Portal.","enum":[1,2,3,4,5,6,7,8,9,99]},"start_time":{"type":"string","description":"The meeting or webinar's start time.","format":"date-time"},"timezone":{"type":"string","description":"The meeting or webinar's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"duration":{"type":"integer","description":"The meeting or webinar's scheduled duration."},"share_url":{"type":"string","description":"The URL at which approved users can view the recording."},"total_size":{"type":"integer","description":"The recording file's total size, in bytes."},"recording_count":{"type":"integer","description":"The number of recording files deleted."},"recording_files":{"type":"array","description":"Information about the deleted recording files.","items":{"required":["download_url","file_extension","file_size","file_type","id","meeting_id","recording_end","recording_start","recording_type","status"],"type":"object","properties":{"id":{"type":"string","description":"The recording file's ID."},"meeting_id":{"type":"string","description":"The meeting's ID."},"recording_start":{"type":"string","description":"The date and time at which recording started.","format":"date-time"},"recording_end":{"type":"string","description":"The date and time at which recording ended.","format":"date-time"},"file_type":{"type":"string","description":"The type of the recording file.","enum":["MP4","M4A","CHAT","TRANSCRIPT","CSV","TB","CC","CHAT_MESSAGE","SUMMARY","TIMELINE"]},"file_size":{"type":"integer","description":"The recording file's size, in bytes."},"file_extension":{"type":"string","description":"The file extension type of the recording file.","enum":["MP4","M4A","TXT","VTT","CSV","JSON","JPG"]},"file_name":{"type":"string","description":"The recording file's name."},"play_url":{"type":"string","description":"The URL at which the recording file can be opened and played."},"download_url":{"type":"string","description":"The URL at which to download the the recording. \n\n **JWT apps** \n\n To access a private or password-protected cloud recording of a user in your account, use a [Zoom JWT app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-jwt-app). Use the generated JWT token as the value of the `access_token` query parameter and include this query parameter at the end of the URL. \n\n `https://{{base-domain}}/recording/download/{{path-to-file-download}}?access_token={{JWT-token}}` \n\n **OAuth apps** \n\n If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) to download the file. For example: \n\n `https://{{base-domain}}/rec/archive/download/xxx?access_token={{OAuth-access-token}}`. \n\n**Note:** We recommend that you send the access_token as a Bearer token in the Authorization header, for example: \"Authorization\": \"Bearer <ACCESS_TOKEN>”."},"status":{"type":"string","description":"The recording file's processing status: \n* `completed` — The processing of the file is complete. \n* `processing` — The file is processing.","enum":["completed","processing"]},"recording_type":{"type":"string","description":"The recording file type. \n* `shared_screen_with_speaker_view(CC)` \n* `shared_screen_with_speaker_view` \n* `shared_screen_with_gallery_view` \n* `gallery_view` \n* `shared_screen` \n* `audio_only` \n* `audio_transcript` \n* `chat_file` \n* `active_speaker` \n* `host_video` \n* `audio_only_each_participant` \n* `cc_transcript` \n* `closed_caption` \n* `poll` \n* `timeline` \n* `thumbnail` \n* `audio_interpretation` \n* `summary` \n* `summary_next_steps` \n* `summary_smart_chapters` \n*`sign_interpretation` \n*`production_studio` \n\n For more information, read our [Managing and sharing cloud recordings](https://support.zoom.us/hc/en-us/articles/205347605-Managing-and-sharing-cloud-recordings#h_9898497b-e736-4980-a749-d55608f10773) documentation.","enum":["shared_screen_with_speaker_view(CC)","shared_screen_with_speaker_view","shared_screen_with_gallery_view","gallery_view","shared_screen","audio_only","audio_transcript","chat_file","active_speaker","host_video","audio_only_each_participant","cc_transcript","closed_caption","poll","timeline","thumbnail","audio_interpretation","summary","summary_next_steps","summary_smart_chapters","sign_interpretation","production_sutdio"]}},"additionalProperties":false}},"participant_audio_files":{"type":"array","description":"Information about the participants' deleted audio files.","items":{"required":["download_url","file_extension","file_name","file_size","file_type","id","recording_end","recording_start","status"],"type":"object","properties":{"id":{"type":"string","description":"The participant audio file's ID."},"recording_start":{"type":"string","description":"The participant audio file's start time.","format":"date-time"},"recording_end":{"type":"string","description":"The participant audio file's end time.","format":"date-time"},"file_type":{"type":"string","description":"The participant audio file's format."},"file_name":{"type":"string","description":"The participant audio file's name."},"file_size":{"type":"integer","description":"The participant audio file's size, in bytes."},"file_extension":{"type":"string","description":"The participant audio file's extension."},"play_url":{"type":"string","description":"The URL at which the participant audio file can be opened and played."},"download_url":{"type":"string","description":"The URL at which to download the the recording. \n\n **JWT apps** \n\n To access a private or password-protected cloud recording of a user in your account, use a [Zoom JWT app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-jwt-app). Use the generated JWT token as the value of the `access_token` query parameter and include this query parameter at the end of the URL. \n\n `https://{{base-domain}}/recording/download/{{path-to-file-download}}?access_token={{JWT-token}}` \n\n **OAuth apps** \n\n If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) to download the file. For example: \n\n`https://{{base-domain}}/rec/archive/download/xxx?access_token={{OAuth-access-token}}` \n\n **Note:** This field does **not** return for [Zoom On-Premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). Instead, this API will return the `file_path` field."},"file_path":{"type":"string","description":"The file path to the On-Premise account recording. \n\n **Note:** This API returns this field for [Zoom On-Premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). It does **not** return the `download_url` field."},"status":{"type":"string","description":"The participant audio file's processing status: \n* `completed` — The processing of the file is complete. \n* `processing` — The file is processing.","enum":["completed","processing"]}},"additionalProperties":false}}},"additionalProperties":false,"description":"Information about the webinar or meeting recording."}},"additionalProperties":false}},"additionalProperties":false},"Recording.pausedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user that started the meeting or webinar recording."},"object":{"required":["duration","host_id","id","recording_file","start_time","topic","type","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The ID of the recorded meeting (`meetingId`) or webinar (`webinarId`).","format":"int64"},"uuid":{"type":"string","description":"The universally unique identifier (UUID) of the recorded meeting or webinar instance."},"host_id":{"type":"string","description":"The ID of the user set as the host of the meeting or webinar."},"topic":{"type":"string","description":"The meeting or webinar topic."},"type":{"type":"integer","description":"The type of recorded meeting or webinar: \n\n If the recording is of a meeting: \n* `1` — Instant meeting. \n* `2` — Scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A meeting created via PMI (Personal Meeting ID). \n* `7` — A [Personal Audio Conference](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) (PAC). \n* `8` - Recurring meeting with a fixed time. \n\n If the recording is of a webinar: \n* `5` — A webinar. \n* `6` — A recurring webinar without a fixed time. \n* `9` — A recurring webinar with a fixed time. \n\n If the recording is **not** from a meeting or webinar: \n\n* `99` — A recording uploaded via the [**Recordings**](https://zoom.us/recording) interface on the Zoom Web Portal.","enum":[1,2,3,4,5,6,7,8,9,99]},"start_time":{"type":"string","description":"The meeting or webinar's start time.","format":"date-time"},"timezone":{"type":"string","description":"The meeting or webinar's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"duration":{"type":"integer","description":"The meeting or webinar's scheduled duration."},"recording_file":{"required":["recording_end","recording_start"],"type":"object","properties":{"recording_start":{"type":"string","description":"The date and time at which the recording started.","format":"date-time"},"recording_end":{"type":"string","description":"The date and time at which the recording ended.","anyOf":[{"format":"date-time"},{"enum":[""]}]}},"additionalProperties":false,"description":"Information about the recording files."}},"additionalProperties":false,"description":"Information about the meeting or webinar recording."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.participant_room_system_callout_ringingEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the meeting host."},"object":{"required":["host_id","id","inviter_name","message_id","participant","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The meeting ID.","format":"int64"},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The user ID of the meeting host."},"message_id":{"type":"string","description":"The request unique identifier (UUID)."},"inviter_name":{"type":"string","description":"The user name of the event's trigger."},"participant":{"required":["call_type","device_ip"],"type":"object","properties":{"call_type":{"type":"string","description":"The type of call out. Use a value of `h323` or `sip`."},"device_ip":{"type":"string","description":"The user's device IP address."}},"additionalProperties":false,"description":"Information about the invited participant."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Recording.startedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user that started the meeting or webinar recording."},"object":{"required":["duration","host_id","id","recording_file","start_time","topic","type","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The ID of the recorded meeting (`meetingId`) or webinar (`webinarId`).","format":"int64"},"uuid":{"type":"string","description":"The universally unique identifier (UUID) of the recorded meeting or webinar instance."},"host_id":{"type":"string","description":"The ID of the user set as the host of the meeting or webinar."},"topic":{"type":"string","description":"The meeting or webinar topic."},"type":{"type":"integer","description":"The type of recorded meeting or webinar: \n\n If the recording is of a meeting: \n* `1` — Instant meeting. \n* `2` — Scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A meeting created via PMI (Personal Meeting ID). \n* `7` — A [Personal Audio Conference](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) (PAC). \n* `8` - Recurring meeting with a fixed time. \n\n If the recording is of a webinar: \n* `5` — A webinar. \n* `6` — A recurring webinar without a fixed time. \n* `9` — A recurring webinar with a fixed time. \n\n If the recording is **not** from a meeting or webinar: \n\n* `99` — A recording uploaded via the [**Recordings**](https://zoom.us/recording) interface on the Zoom Web Portal.","enum":[1,2,3,4,5,6,7,8,9,99]},"start_time":{"type":"string","description":"The meeting or webinar's start time.","format":"date-time"},"timezone":{"type":"string","description":"The meeting or webinar's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"duration":{"type":"integer","description":"The meeting or webinar's scheduled duration."},"recording_file":{"required":["recording_end","recording_start"],"type":"object","properties":{"recording_start":{"type":"string","description":"The date and time at which the recording started.","anyOf":[{"format":"date-time"},{"enum":[""]}]},"recording_end":{"type":"string","description":"The date and time at which the recording ended.","anyOf":[{"format":"date-time"},{"enum":[""]}]}},"additionalProperties":false,"description":"Information about the recording files."}},"additionalProperties":false,"description":"Information about the meeting or webinar recording."}},"additionalProperties":false}},"additionalProperties":false},"User.tsp_updatedEvent":{"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who updated the TSP."},"operator":{"type":"string","description":"The email address of the user who updated the TSP.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who updated the TSP."},"object":{"type":"object","properties":{"id":{"type":"string","description":"The user's ID."},"email":{"type":"string","description":"The user's email address.","format":"email"},"tsp_credentials":{"type":"object","properties":{"conference_code":{"type":"string","description":"The TSP conference code."},"leader_pin":{"type":"string","description":"The leader PIN."},"tsp_bridge":{"type":"string","description":"The TSP bridge zone."},"dial_in_numbers":{"type":"array","description":"Information about the TSP dial-in numbers.","items":{"type":"object","properties":{"code":{"type":"string","description":"The country code."},"number":{"type":"string","description":"The dial-in phone number."},"type":{"type":"string","description":"The phone number's type. \n* `toll` - Toll number. \n* `tollfree` - Toll free number. \n* `media_link` - Media link.","enum":["toll","tollfree","media_link"]},"country_label":{"type":"string","description":"The TSP country label. \n* `US_TSP_TB` \n* `EU_TSP_TB`","enum":["US_TSP_TB","EU_TSP_TB"]}}}}},"description":"Information about the updated user's TSP credentials."}},"description":"Information about the updated user."},"old_object":{"$ref":"#/properties/payload/properties/object/properties/tsp_credentials"}}}}},"Meeting.invitation_timeoutEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The meeting host's account ID."},"operator":{"type":"string","description":"The email address of the user who missed the meeting invitation."},"operator_id":{"type":"string","description":"The user ID of the user who missed the meeting invitation."},"object":{"required":["host_id","id","participant","topic","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The meeting ID."},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"participant":{"required":["email","participant_user_id"],"type":"object","properties":{"participant_user_id":{"type":"string","description":"The user ID of the user who received the meeting invitation."},"email":{"type":"string","description":"The email address of the user who received the meeting invitation. If the participant is **not** part of the host's account, the `email` field returns an empty string value, with some exceptions. For more information, read our [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) documentation.","format":"email"}},"additionalProperties":false,"description":"Information about the invited participant."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.participant_admittedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the meeting."},"object":{"required":["duration","host_id","id","participant","start_time","topic","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The meeting ID."},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type. \n* `0` - A prescheduled meeting. \n* `1` - An instant meeting. \n* `2` - A scheduled meeting. \n* `3` - A recurring meeting with no fixed time. \n* `4` - A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` - A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` - A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"type":"string","description":"The meeting's start time.","format":"date-time"},"timezone":{"type":"string","description":"The meeting's [timezone](/docs/api/references/abbreviations/#timezones)."},"duration":{"type":"integer","description":"The scheduled meeting duration."},"participant":{"required":["date_time","email","user_id"],"type":"object","properties":{"user_id":{"type":"string","description":"The participant's meeting user ID. This value is assigned to a participant upon joining a meeting and is only valid for the duration of the meeting."},"user_name":{"type":"string","description":"The participant's display name."},"id":{"type":"string","description":"The participant's universally unique ID (UUID). \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty (`””`) value."},"participant_uuid":{"type":"string","description":"The participant's meeting universally unique ID (UUID). This value is assigned to a participant upon joining a meeting and is only valid for the duration of the meeting. This value will not be changed when the participant joins/leaves a breakout room."},"participant_user_id":{"type":"string","description":"The participant's universally unique ID (UUID). \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value.\n\n This value returns blank for external users."},"phone_number":{"type":"string","description":"Phone number of participant joined via PSTN."},"date_time":{"type":"string","description":"The time when the participant joined the meeting.","format":"date-time"},"email":{"type":"string","description":"The participant's email address. This response only returns if the participant joined the meeting by logging into Zoom. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#email-address) for details.","format":"email"},"customer_key":{"type":"string","description":"The participant's SDK identifier. This value can be alphanumeric."},"registrant_id":{"type":"string","description":"The participant's registrant ID. A host or a user with administrative permissions can require [registration for Zoom meetings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065026)."}},"additionalProperties":false,"description":"Information about the meeting participant. If the participant is not part of the host's account, `email` returns an empty string value, with some exceptions. See [Email address display rules](/docs/api/using-zoom-apis/#email-address-display-rules) for details."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.participant_room_system_callout_failedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the meeting host."},"object":{"required":["host_id","id","inviter_name","message_id","participant","reason_type","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The meeting ID.","format":"int64"},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The user ID of the meeting host."},"message_id":{"type":"string","description":"The request unique identifier (UUID)."},"inviter_name":{"type":"string","description":"The user name of the event's trigger."},"reason_type":{"type":"integer","description":"reason type for failure: \n* `1` — Encryption_Fail. \n* `2` — Disconnected_By_Remote. \n* `3` — Retry. \n* `4` — Bad_Seq. \n* `5` — Call_Limit. \n* `6` — Not_Registered. \n* `7` — Timeout. \n* `8` — Bad_Addr. \n* `9` — Unreachable \n* `10` — Disconnect_By_Local \n* `11` — Server_Internal_Error \n* `12` — Exceed_Free_Port \n* `13` — Connect_Error \n* `14` — Proxy_Connect_Error \n* `0` — Other_Failed_Reason.","enum":[0,1,2,3,4,7,8,9,10,11,12,13,14]},"participant":{"required":["call_type","device_ip"],"type":"object","properties":{"call_type":{"type":"string","description":"The type of call out. Use a value of `h323` or `sip`."},"device_ip":{"type":"string","description":"The user's device IP address."}},"additionalProperties":false,"description":"Information about the invited participant."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.participant_data_connection_establishedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp for when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the meeting."},"object":{"required":["data_connections","host_id","participant","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The meeting number."},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type. \n* `0` - A prescheduled meeting. \n* `1` - An instant meeting. \n* `2` - A scheduled meeting. \n* `3` - A recurring meeting with no fixed time. \n* `4` - A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` - A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` - A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"pattern":"(^\\s*$|^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$)","type":"string","description":"The meeting's start time."},"participant":{"required":["email","join_time","user_id","user_name"],"type":"object","properties":{"user_id":{"type":"string","description":"The participant's meeting user ID. This value is assigned to a participant when they join a meeting and is only valid for the duration of the meeting."},"user_name":{"type":"string","description":"The participant's display name."},"participant_uuid":{"type":"string","description":"The participant's UUID for this specific meeting and any breakout rooms created in this meeting. This value is assigned to a participant when they join a meeting and is only valid for the duration of that meeting."},"join_time":{"type":"string","description":"The time when the participant joined the meeting.","format":"date-time"},"email":{"type":"string","description":"The participant's email address. This response only returns if the participant joined the meeting by logging into Zoom. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details.","format":"email"},"registrant_id":{"type":"string","description":"The participant's registrant ID. A host or a user with administrative permissions can require [registration for Zoom meetings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065026)."},"participant_user_id":{"type":"string","description":"The participant's universally unique ID (UUID). \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value.\n\n This value returns blank for external users."},"customer_key":{"type":"string","description":"The participant's SDK identifier. This value can be alphanumeric."},"phone_number":{"type":"string","description":"The phone number of the participant who joined via PSTN.","example":"8611111111111"}},"additionalProperties":false,"description":"Information about the meeting participant. If the participant is **not** part of the host's account, the `email` field returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details."},"data_connections":{"type":"array","description":"A list of data connection records established by the participant in the meeting.","items":{"required":["command_connection_time_cost_ms","connection_type","data_socket_time_cost_ms","first_package_time_cost_ms","total_time_cost_ms"],"type":"object","properties":{"connection_type":{"type":"string","description":"The type of in-meeting data connection.","enum":["audio","video","screen_share"]},"total_time_cost_ms":{"type":"integer","description":"The total time, in milliseconds, that it took to establish the data connection."},"command_connection_time_cost_ms":{"type":"integer","description":"The time, in milliseconds, spent establishing the command connection."},"data_socket_time_cost_ms":{"type":"integer","description":"The time, in milliseconds, spent establishing the data socket connection."},"first_package_time_cost_ms":{"type":"integer","description":"The time, in milliseconds, from data socket establishment to receiving the first package."}},"additionalProperties":false}}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Recording.resumedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user that resumed the meeting or webinar recording."},"object":{"required":["duration","host_id","id","recording_file","start_time","topic","type","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The ID of the recorded meeting (`meetingId`) or webinar (`webinarId`).","format":"int64"},"uuid":{"type":"string","description":"The universally unique identifier (UUID) of the recorded meeting or webinar instance."},"host_id":{"type":"string","description":"The ID of the user set as the host of the meeting or webinar."},"topic":{"type":"string","description":"The meeting or webinar topic."},"type":{"type":"integer","description":"The type of recorded meeting or webinar: \n\n If the recording is of a meeting: \n* `1` — Instant meeting. \n* `2` — Scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A meeting created via PMI (Personal Meeting ID). \n* `7` — A [Personal Audio Conference](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) (PAC). \n* `8` - Recurring meeting with a fixed time. \n\n If the recording is of a webinar: \n* `5` — A webinar. \n* `6` — A recurring webinar without a fixed time. \n* `9` — A recurring webinar with a fixed time. \n\n If the recording is **not** from a meeting or webinar: \n\n* `99` — A recording uploaded via the [**Recordings**](https://zoom.us/recording) interface on the Zoom Web Portal.","enum":[1,2,3,4,5,6,7,8,9,99]},"start_time":{"type":"string","description":"The meeting or webinar's start time.","format":"date-time"},"timezone":{"type":"string","description":"The meeting or webinar's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"duration":{"type":"integer","description":"The meeting or webinar's scheduled duration."},"recording_file":{"required":["recording_end","recording_start"],"type":"object","properties":{"recording_start":{"type":"string","description":"The date and time at which recording started.","anyOf":[{"format":"date-time"},{"enum":[""]}]},"recording_end":{"type":"string","description":"The date and time at which the recording ended.","anyOf":[{"format":"date-time"},{"enum":[""]}]}},"additionalProperties":false,"description":"Information about the recording files."}},"additionalProperties":false,"description":"Information about the meeting or webinar recording."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.participant_phone_callout_missedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The meeting host's account ID."},"object":{"required":["host_id","id","participant","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The meeting ID.","format":"int64"},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"participant":{"required":["invitee_name","phone_number"],"type":"object","properties":{"invitee_name":{"type":"string","description":"The user's name to display in the meeting."},"phone_number":{"type":"integer","description":"The user's phone number.","format":"int64"}},"additionalProperties":false,"description":"Information about the invited participant."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.summary_updatedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who hosted the meeting."},"operator":{"type":"string","description":"The email address of the user who updated the meeting summary."},"operator_id":{"type":"string","description":"The user ID of the user who updated the meeting summary."},"object":{"required":["edited_summary","meeting_end_time","meeting_host_email","meeting_host_id","meeting_id","meeting_start_time","meeting_topic","meeting_uuid","next_steps","summary_created_time","summary_details","summary_end_time","summary_last_modified_time","summary_last_modified_user_email","summary_last_modified_user_id","summary_start_time","summary_title"],"type":"object","properties":{"meeting_host_id":{"type":"string","description":"The ID of the user who is set as the meeting host."},"meeting_host_email":{"type":"string","description":"The meeting host's email address.","format":"email"},"meeting_uuid":{"type":"string","description":"Unique meeting ID. Each meeting instance generates its own meeting UUID. After a meeting ends, a new UUID is generated for the next instance of the meeting. Retrieve a list of UUIDs from past meeting instances using the [**List past meeting instances**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/pastMeetings) API. [Double encode](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#meeting-id-and-uuid) your UUID when using it for API calls if the UUID begins with a `/` or contains `//` in it.\n"},"meeting_id":{"type":"integer","description":"[Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-) - the meeting's unique identifier in **long** format, represented as int64 data type in JSON. Also known as the meeting number.","format":"int64"},"meeting_topic":{"type":"string","description":"Meeting topic."},"meeting_start_time":{"type":"string","description":"The meeting's start date and time.","format":"date-time"},"meeting_end_time":{"type":"string","description":"The meeting's end date and time.","format":"date-time","example":"2020-07-15T23:30:19Z"},"summary_start_time":{"type":"string","description":"The summary's start date and time.","format":"date-time"},"summary_end_time":{"type":"string","description":"The summary's end date and time.","format":"date-time"},"summary_created_time":{"type":"string","description":"The date and time when the meeting summary was created.","format":"date-time"},"summary_last_modified_time":{"type":"string","description":"The date and time when the meeting summary was last modified.","format":"date-time"},"summary_last_modified_user_id":{"type":"string","description":"The user ID of the user who last modified the meeting summary."},"summary_last_modified_user_email":{"type":"string","description":"The user email of the user who last modified the meeting summary."},"summary_title":{"type":"string","description":"The summary title."},"summary_overview":{"type":"string","description":"The summary overview.","deprecated":true},"summary_details":{"type":"array","description":"The summary content details.","deprecated":true,"items":{"required":["label","summary"],"type":"object","properties":{"label":{"type":"string","description":"The summary label."},"summary":{"type":"string","description":"The summary content."}},"description":"The summary detail object."}},"next_steps":{"type":"array","description":"The next steps.","deprecated":true,"items":{"type":"string","description":"The next step."}},"edited_summary":{"type":"object","properties":{"summary_overview":{"type":"string","description":"The user edited summary overview."},"summary_details":{"type":"string","description":"The user-edited summary details."},"next_steps":{"type":"array","description":"The user-edited next steps.","items":{"type":"string","description":"The user-edited next step."}}},"description":"Information about the edited meeting summary.","deprecated":true},"summary_content":{"type":"string","description":"The complete meeting summary in Markdown format. This unified field is used for all summaries. For compatibility, the legacy fields `summary_overview`, `summary_details`, `next_steps`, and `edited_summary` are still returned, but are deprecated and will not be supported in the future."},"summary_doc_url":{"type":"string","description":"The URL to view the full summary document in Zoom Docs."}},"additionalProperties":true,"description":"Information about the meeting summary."}},"additionalProperties":true}},"additionalProperties":true},"Webinar.participant_joinedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the webinar."},"object":{"required":["duration","host_id","id","participant","start_time","timezone","topic","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The webinar ID."},"uuid":{"type":"string","description":"The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."},"host_id":{"type":"string","description":"The webinar host's user ID."},"topic":{"type":"string","description":"The webinar's topic."},"type":{"type":"integer","description":"The webinar type: \n* `5` - A webinar. \n* `6` - A recurring webinar without a fixed time. \n* `9` - A recurring webinar with a fixed time.","enum":[5,6,9]},"start_time":{"pattern":"(^\\s*$|^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$)","type":"string","description":"The webinar's start time.","format":"date-time"},"timezone":{"type":"string","description":"The webinar's [timezone](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones)."},"duration":{"type":"integer","description":"The scheduled webinar duration."},"participant":{"required":["email","id","join_time","user_id","user_name"],"type":"object","properties":{"user_id":{"type":"string","description":"The participant's webinar user ID. This value is assigned to a participant upon joining a webinar and is only valid for the duration of the webinar."},"user_name":{"type":"string","description":"The participant's display name."},"id":{"type":"string","description":"The participant's universally unique ID (UUID). \n* If the participant joins the webinar by logging into Zoom, this value is the `id` value in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the webinar **without** logging into Zoom, this returns an empty string value. \n\n This value returns blank for external users.\n\n This value returns blank for external users.\n\n **Note:** Use the `participant_user_id` value instead of this value. We will remove this response in a future release."},"join_time":{"type":"string","description":"The date and time when the participant joined the webinar.","format":"date-time"},"email":{"type":"string","description":"The participant's email address. This response only returns if the participant joined the webinar by logging into Zoom. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details.","format":"email"},"registrant_id":{"type":"string","description":"The participant's registrant ID. (A host or a user with administrative permissions can require [registration for Zoom meetings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065026))."},"participant_user_id":{"type":"string","description":"The participant's universally unique ID (UUID). \n* If the participant joins the webinar by logging into Zoom, this value is the `id` value in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the webinar **without** logging into Zoom, this returns an empty string value."},"participant_uuid":{"type":"string","description":"The participant's UUID for this specific webinar. This value is assigned to a participant when they join a webinar, and is only valid for the duration of that webinar."},"customer_key":{"type":"string","description":"The participant's SDK identifier. This value can be alphanumeric."},"phone_number":{"type":"string","description":"Phone number of participant joined via PSTN.","example":"8615250064084"}},"additionalProperties":false,"description":"Information about the webinar participant. If the participant is **not** part of the host's account, `email` returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details."}},"additionalProperties":false,"description":"Information about the webinar."}},"additionalProperties":false}},"additionalProperties":false},"Recording.renamedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","old_object","operator","operator_id","time_stamp"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user that renamed the meeting or webinar recording."},"operator":{"type":"string","description":"The email address of the user that renamed the meeting or webinar recording."},"operator_id":{"type":"string","description":"The user Id of the user that renamed the meeting or webinar recording."},"time_stamp":{"type":"number","description":"A timestamp at which the user renamed the meeting or webinar recording."},"object":{"required":["host_id","id","topic","type","uuid"],"type":"object","properties":{"uuid":{"type":"string","description":"The universally unique identifier (UUID) of the recorded meeting or webinar instance."},"id":{"type":"integer","description":"The ID of the recorded meeting (`meetingId`) or webinar (`webinarId`).","format":"int64"},"topic":{"type":"string","description":"The updated recording title."},"type":{"type":"integer","description":"The type of recorded meeting or webinar: \n\n If the recording is of a meeting: \n* `1` — Instant meeting. \n* `2` — Scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A meeting created via PMI (Personal Meeting ID). \n* `7` — A [Personal Audio Conference](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) (PAC). \n* `8` - Recurring meeting with a fixed time. \n\n If the recording is of a webinar: \n* `5` — A webinar. \n* `6` — A recurring webinar without a fixed time. \n* `9` — A recurring webinar with a fixed time. \n\n If the recording is **not** from a meeting or webinar: \n\n* `99` — A recording uploaded via the [**Recordings**](https://zoom.us/recording) interface on the Zoom Web Portal.","enum":[1,2,3,4,5,6,7,8,9,99]},"host_id":{"type":"string","description":"The ID of the user set as the host of the meeting or webinar."}},"additionalProperties":false,"description":"Information about meeting or webinar recording."},"old_object":{"required":["host_id","id","topic","type","uuid"],"type":"object","properties":{"uuid":{"type":"string","description":"The universally unique identifier (UUID) of the recorded meeting or webinar instance."},"id":{"type":"integer","description":"The ID of the recorded meeting (`meetingId`) or webinar (`webinarId`).","format":"int64"},"topic":{"type":"string","description":"The previous recording title."},"type":{"type":"integer","description":"The type of recorded meeting or webinar: \n\n If the recording is of a meeting: \n* `1` — Instant meeting. \n* `2` — Scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A meeting created via PMI (Personal Meeting ID). \n* `7` — A [Personal Audio Conference](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) (PAC). \n* `8` - Recurring meeting with a fixed time. \n\n If the recording is of a webinar: \n* `5` — A webinar. \n* `6` — A recurring webinar without a fixed time. \n* `9` — A recurring webinar with a fixed time. \n\n If the recording is **not** from a meeting or webinar: \n\n* `99` — A recording uploaded via the [**Recordings**](https://zoom.us/recording) interface on the Zoom Web Portal.","enum":[1,2,3,4,5,6,7,8,9,99]},"host_id":{"type":"string","description":"The ID of the user set as the host of the meeting or webinar."}},"additionalProperties":false,"description":"Information about the previous meeting or webinar recording's settings."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.participant_room_system_callout_missedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the meeting host."},"object":{"required":["host_id","id","inviter_name","message_id","participant","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The meeting ID.","format":"int64"},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The user ID of the meeting host."},"message_id":{"type":"string","description":"The request unique identifier (UUID)."},"inviter_name":{"type":"string","description":"The user name of the event's trigger."},"participant":{"required":["call_type","device_ip"],"type":"object","properties":{"call_type":{"type":"string","description":"The type of call out. Use a value of `h323` or `sip`."},"device_ip":{"type":"string","description":"The user's device IP address."}},"additionalProperties":false,"description":"Information about the invited participant."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Webinar.createdEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the webinar."},"operator":{"type":"string","description":"The email address of the user who created the webinar.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who created the webinar."},"operation":{"type":"string","description":"The type of operation performed: \n* `all` — The change was applied to all webinar. \n* `single` — The change was applied only to a single webinar.","enum":["all","single"]},"object":{"required":["creation_source","duration","host_id","id","join_url","settings","timezone","topic","type","uuid"],"type":"object","properties":{"uuid":{"type":"string","description":"The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."},"id":{"type":"integer","description":"The webinar ID.","format":"int64"},"host_id":{"type":"string","description":"The webinar host's user ID."},"topic":{"type":"string","description":"The webinar's topic."},"type":{"type":"integer","description":"The webinar type: \n* `5` — A webinar. \n* `6` — A recurring webinar without a fixed time. \n* `9` — A recurring webinar with a fixed time.","enum":[5,6,9]},"start_time":{"type":"string","description":"The webinar's start time.","format":"date-time"},"duration":{"type":"integer","description":"The scheduled webinar duration."},"timezone":{"type":"string","description":"The webinar's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"join_url":{"type":"string","description":"The URL to join the webinar."},"password":{"type":"string","description":"The password required to join the webinar."},"creation_source":{"type":"string","description":"The platform through which the meeting was created.\n* `other` - Created through another platform.\n* `open_api` - Created through Open API.\n* `web_portal` - Created through the web portal.","enum":["other","open_api","web_portal"]},"occurrences":{"type":"array","description":"Information about recurring webinars with fixed times and their occurrences. This only returns when the webinar's `type` value is `9`.","items":{"anyOf":[{"required":["occurrence_id","start_time"],"type":"object","properties":{"occurrence_id":{"type":"string","description":"The webinar occurrence's ID."},"start_time":{"type":"string","description":"The webinar's start time.","format":"date-time"},"duration":{"type":"integer","description":"The scheduled webinar duration."},"status":{"type":"string","description":"The webinar occurrence status: \n* `available` \n* `deleted`","enum":["available","deleted"]}},"additionalProperties":true}]}},"settings":{"required":["alternative_hosts","use_pmi"],"type":"object","properties":{"use_pmi":{"type":"boolean","description":"Whether the use of PMI is enabled."},"alternative_hosts":{"type":"string","description":"A semicolon-separated list of the webinar's alternative hosts' email addresses or IDs."}},"additionalProperties":true,"description":"Information about the webinar's settings."},"recurrence":{"type":"object","properties":{"type":{"type":"integer","description":"The type of recurring meeting: \n* `1` — Daily. \n* `2` — Weekly. \n* `3` — Monthly.","enum":[1,2,3]},"repeat_interval":{"type":"integer","description":"The meeting's repeat interval: \n* For daily intervals, a max of `90` days. \n* For a weekly interval, a max of `12` weeks. \n* For monthly intervals, a max of `3` months."},"weekly_days":{"type":"string","description":"A comma-separated list of the days of the week on which the recurring weekly meeting occurs: \n* `1` — Sunday \n* `2` — Monday \n* `3` — Tuesday \n* `4` — Wednesday \n* `5` — Thursday \n* `6` — Friday \n* `7` — Saturday"},"monthly_day":{"maximum":31,"minimum":1,"type":"integer","description":"The day of the month on which the recurring monthly meeting occurs. The value ranges from 1 to 31."},"monthly_week_day":{"type":"integer","description":"The day of the week on which the recurring monthly meeting is scheduled: \n* `1` — Sunday \n* `2` — Monday \n* `3` — Tuesday \n* `4` — Wednesday \n* `5` — Thursday \n* `6` — Friday \n* `7` — Saturday","enum":[1,2,3,4,5,6,7]},"end_times":{"type":"integer","description":"The number of times the recurring meeting will occur before it is canceled."},"end_date_time":{"type":"string","description":"The recurring meeting's final ending date and time before it is canceled, in UTC format.","format":"date-time"},"monthly_week":{"type":"integer","description":"The week of the month on which a recurring meeting occurs: \n* `-1` — The last week of the month. \n* `1` — The first week. \n* `2` — The second week. \n* `3` — The third week. \n* `4` — The fourth week.","enum":[-1,1,2,3,4]}},"additionalProperties":true,"description":"Information about [recurring meetings](https://marketplace.zoom.us/docs/api-reference/other-references/recurrence-object-definitions)."}},"additionalProperties":true,"description":"Information about the webinar."}},"additionalProperties":true}},"additionalProperties":true},"Recording.registration_deniedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the host that recorded the meeting or webinar."},"operator":{"type":"string","description":"The email address of the user who denied the recording registration.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who denied the recording registration."},"object":{"required":["duration","host_id","id","registrant","start_time","topic","type","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The ID of the recorded meeting (`meetingId`) or webinar (`webinarId`).","format":"int64"},"uuid":{"type":"string","description":"The universally unique identifier (UUID) of the recorded meeting or webinar instance."},"host_id":{"type":"string","description":"The webinar or meeting host's user ID."},"topic":{"type":"string","description":"The meeting or webinar topic."},"type":{"type":"integer","description":"The type of recorded meeting or webinar: \n\n If the recording is of a meeting: \n* `1` — Instant meeting. \n* `2` — Scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A meeting created via PMI (Personal Meeting ID). \n* `7` — A [Personal Audio Conference](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) (PAC). \n* `8` - Recurring meeting with a fixed time. \n\n If the recording is of a webinar: \n* `5` — A webinar. \n* `6` — A recurring webinar without a fixed time. \n* `9` — A recurring webinar with a fixed time. \n\n If the recording is **not** from a meeting or webinar: \n\n* `99` — A recording uploaded via the [**Recordings**](https://zoom.us/recording) interface on the Zoom Web Portal.","enum":[1,2,3,4,5,6,7,8,9,99]},"start_time":{"type":"string","description":"The meeting or webinar's start time.","format":"date-time"},"timezone":{"type":"string","description":"The meeting or webinar's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"duration":{"type":"integer","description":"The meeting or webinar's scheduled duration."},"registrant":{"required":["email","first_name","last_name"],"type":"object","properties":{"id":{"type":"string","description":"The registrant's ID."},"email":{"type":"string","description":"The registrant's email address.","format":"email"},"first_name":{"type":"string","description":"The registrant's first name."},"last_name":{"type":"string","description":"The registrant's last name."}},"additionalProperties":false,"description":"Information about the recording registrant."}},"additionalProperties":false,"description":"Information about the recording registration."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.participant_phone_callout_failedEvent":{"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 occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The meeting host's account ID."},"object":{"required":["host_id","id","participant","reason_type","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The meeting ID.","format":"int64"},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"reason_type":{"type":"integer","description":"The reason type for the failure: \n* `1` — Not_Allow_PSTN. \n* `2` — Block_Too_Frequent. \n* `3` — Block_By_No_Host. \n* `4` — PhoneNumber_Blocked. \n* `5` — Call_Count_Limit_InConf. \n* `6` — SipTrunk_Error. \n* `7` — Timeout. \n* `8` — PhoneNumber_Invalid. \n* `0` — Other_Failed_Reason.","enum":[0,1,2,3,4,7,8,9,10,11,12,13,14]},"participant":{"required":["invitee_name","phone_number"],"type":"object","properties":{"invitee_name":{"type":"string","description":"The user's display name in the meeting."},"phone_number":{"type":"integer","description":"The user's phone number.","format":"int64"}},"additionalProperties":false,"description":"Information about the invited participant."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.live_streaming_stoppedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the meeting."},"operator":{"type":"string","description":"The email address of the user who updated the meeting.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who updated the meeting."},"object":{"required":["duration","host_id","id","live_streaming","start_time","topic","type","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The meeting ID.","format":"int64"},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type: \n* `0` — A prescheduled meeting. \n* `1` — An instant meeting. \n* `2` — A scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` — A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` — A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"type":"string","description":"The meeting's start time.","format":"date-time"},"timezone":{"type":"string","description":"The meeting's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"duration":{"type":"integer","description":"The scheduled meeting duration."},"live_streaming":{"required":["date_time","service"],"type":"object","properties":{"service":{"type":"string","description":"The name of the live streaming service: \n* `Facebook` \n* `Workplace_by_Facebook` \n* `YouTube` \n* `Twitch` \n* `Custom_Live_Streaming_Service`","enum":["Facebook","Workplace_by_Facebook","YouTube","Twitch","Custom_Live_Streaming_Service"]},"custom_live_streaming_settings":{"required":["page_url","stream_key","stream_url"],"type":"object","properties":{"stream_url":{"type":"string","description":"The live stream's URL."},"stream_key":{"type":"string","description":"The live stream's key."},"page_url":{"type":"string","description":"The live stream's page URL."},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display."}},"description":"Information about the custom live stream."},"date_time":{"type":"string","description":"The date and time the live stream ended.","format":"date-time"}},"description":"Information about the live stream."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Webinar.participant_data_connection_establishedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp for when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the webinar."},"object":{"required":["data_connections","host_id","participant","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The webinar number."},"uuid":{"type":"string","description":"The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."},"host_id":{"type":"string","description":"The webinar host's user ID."},"topic":{"type":"string","description":"The webinar's topic."},"type":{"type":"integer","description":"The webinar type: \n* `5` - A webinar. \n* `6` - A recurring webinar without a fixed time. \n* `9` - A recurring webinar with a fixed time.","enum":[5,6,9]},"start_time":{"pattern":"(^\\s*$|^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$)","type":"string","description":"The webinar's start time."},"participant":{"required":["email","join_time","user_id","user_name"],"type":"object","properties":{"user_id":{"type":"string","description":"The participant's webinar user ID. This value is assigned to a participant when they join a webinar and is only valid for the duration of the webinar."},"user_name":{"type":"string","description":"The participant's display name."},"participant_uuid":{"type":"string","description":"The participant's UUID for this specific webinar and any breakout rooms created in this webinar. This value is assigned to a participant when they join a webinar and is only valid for the duration of that webinar."},"join_time":{"type":"string","description":"The time when the participant joined the webinar.","format":"date-time"},"email":{"type":"string","description":"The participant's email address. This response only returns if the participant joined the webinar by logging into Zoom. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details.","format":"email"},"registrant_id":{"type":"string","description":"The participant's registrant ID. A host or a user with administrative permissions can require [registration for Zoom meetings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065026)."},"participant_user_id":{"type":"string","description":"The participant's universally unique ID (UUID). \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value.\n\n This value returns blank for external users."},"customer_key":{"type":"string","description":"The participant's SDK identifier. This value can be alphanumeric."},"phone_number":{"type":"string","description":"The phone number of the participant who joined via PSTN.","example":"8611111111111"}},"additionalProperties":false,"description":"Information about the webinar participant. If the participant is **not** part of the host's account, the `email` field returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details."},"data_connections":{"type":"array","description":"A list of data connection records established by the participant in the webinar.","items":{"required":["command_connection_time_cost_ms","connection_type","data_socket_time_cost_ms","first_package_time_cost_ms","total_time_cost_ms"],"type":"object","properties":{"connection_type":{"type":"string","description":"The type of in-webinar data connection.","enum":["audio","video","screen_share"]},"total_time_cost_ms":{"type":"integer","description":"The total time, in milliseconds, that it took to establish the data connection."},"command_connection_time_cost_ms":{"type":"integer","description":"The time, in milliseconds, spent establishing the command connection."},"data_socket_time_cost_ms":{"type":"integer","description":"The time, in milliseconds, spent establishing the data socket connection."},"first_package_time_cost_ms":{"type":"integer","description":"The time, in milliseconds, from data socket establishment to receiving the first package."}},"additionalProperties":false}}},"additionalProperties":false,"description":"Information about the webinar."}},"additionalProperties":false}},"additionalProperties":false},"Webinar.registration_cancelledEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the webinar."},"operator":{"type":"string","description":"The email address of the user who canceled the webinar registration.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who canceled the webinar registration."},"object":{"required":["duration","host_id","id","registrant","start_time","timezone","topic","type","uuid"],"type":"object","properties":{"uuid":{"type":"string","description":"The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."},"id":{"type":"integer","description":"The webinar ID."},"host_id":{"type":"string","description":"The webinar host's user ID."},"topic":{"type":"string","description":"The webinar's topic."},"type":{"type":"integer","description":"The webinar type: \n* `5` — A webinar. \n* `6` — A recurring webinar without a fixed time. \n* `9` — A recurring webinar with a fixed time.","enum":[5,6,9]},"start_time":{"type":"string","description":"The webinar's start time.","format":"date-time"},"duration":{"type":"integer","description":"The scheduled webinar duration."},"timezone":{"type":"string","description":"The webinar's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"occurrences":{"type":"array","description":"Information about recurring webinars with fixed times and their occurrences. This only returns when the webinar's `type` value is `9`.","items":{"anyOf":[{"required":["occurrence_id","start_time"],"type":"object","properties":{"occurrence_id":{"type":"string","description":"The webinar occurrence's ID."},"start_time":{"type":"string","description":"The webinar's start time.","format":"date-time"}},"additionalProperties":false}]}},"registrant":{"required":["email","first_name","id"],"type":"object","properties":{"id":{"type":"string","description":"The registrant's ID."},"first_name":{"type":"string","description":"The registrant's first name."},"last_name":{"type":"string","description":"The registrant's last name."},"email":{"type":"string","description":"The registrant's email address.","format":"email"},"tracking_source":{"required":["id","source_name","tracking_url"],"type":"object","properties":{"id":{"type":"string","description":"Unique Identifier of the tracking source."},"source_name":{"type":"string","description":"Name of the source (platform) where the registration URL was shared."},"tracking_url":{"type":"string","description":"Tracking URL. The URL that was shared for the registration."}},"additionalProperties":false,"description":"Information about the source tracking. See [Creating webinar registration tracking links](https://support.zoom.us/hc/en-us/articles/360000315683-Creating-webinar-registration-tracking-links) for details."}},"additionalProperties":false,"description":"Information about the webinar registrant."}},"additionalProperties":false,"description":"Information about the webinar registration."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.recoveredEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who recovered the meeting."},"operator":{"type":"string","description":"The email address of the user who recovered the meeting.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who recovered the meeting."},"operation":{"type":"string","description":"The type of operation performed: \n* `all` — The change was applied to all meetings. \n* `single` — The change was applied only to a single meeting.","enum":["all","single"]},"object":{"required":["duration","host_id","id","start_time","timezone","topic","type","uuid"],"type":"object","properties":{"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"id":{"type":"integer","description":"The meeting ID.","format":"int64"},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type: \n* `0` — A prescheduled meeting. \n* `1` — An instant meeting. \n* `2` — A scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` — A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` — A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"type":"string","description":"The meeting's start time.","format":"date-time"},"duration":{"type":"integer","description":"The scheduled meeting duration."},"timezone":{"type":"string","description":"The meeting's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"occurrences":{"type":"array","description":"Information about recurring meetings with fixed times and their occurrences. This only returns when the meeting's `type` value is `8`.","items":{"anyOf":[{"required":["occurrence_id","start_time"],"type":"object","properties":{"occurrence_id":{"type":"string","description":"The meeting occurrence's ID."},"start_time":{"type":"string","description":"The meeting's start time.","format":"date-time"}},"additionalProperties":true}]}}},"additionalProperties":true,"description":"Information about the meeting."}},"additionalProperties":true}},"additionalProperties":true},"Webinar.permanently_deletedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who permanently deleted the webinar."},"operator":{"type":"string","description":"The email address of the user who permanently deleted the webinar.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who permanently deleted the webinar."},"operation":{"type":"string","description":"The type of operation performed. \n* `all` — The change was applied to all webinars. \n* `single` — The change was applied only to a single webinar.","enum":["all","single"]},"object":{"required":["duration","host_id","id","start_time","timezone","topic","type","uuid"],"type":"object","properties":{"uuid":{"type":"string","description":"The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."},"id":{"type":"integer","description":"The webinar ID.","format":"int64"},"host_id":{"type":"string","description":"The webinar host's user ID."},"topic":{"type":"string","description":"The webinar's topic."},"type":{"type":"integer","description":"The webinar type. \n* `5` — A webinar. \n* `6` — A recurring webinar without a fixed time. \n* `9` — A recurring webinar with a fixed time.","enum":[5,6,9]},"start_time":{"type":"string","description":"The webinar's start time.","format":"date-time"},"duration":{"type":"integer","description":"The scheduled webinar duration."},"timezone":{"type":"string","description":"The webinar's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"occurrences":{"type":"array","description":"Information about recurring webinars with fixed times and their occurrences. This only returns when the webinar's `type` value is `9`.","items":{"anyOf":[{"required":["occurrence_id","start_time"],"type":"object","properties":{"occurrence_id":{"type":"string","description":"The webinar occurrence's ID."},"start_time":{"type":"string","description":"The webinar's start time.","format":"date-time"}},"additionalProperties":false}]}}},"additionalProperties":false,"description":"Information about the webinar."}},"additionalProperties":false}},"additionalProperties":false},"Recording.completedEvent":{"required":["download_token","event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"download_token":{"type":"string","description":"Use the generated token value with the `download_url` value to download the cloud recording via an [OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app). The download token only lasts for 24 hours after its creation, and you can only download the file within 24 hours of receiving the event notification. Pass `download_token` as a bearer token in the authorization header of your HTTP request. \n\n ```\ncurl --request GET \\\n  --url {download_url} \\\n  --header 'authorization: Bearer {download_token} \\\n  --header 'content-type: application/json'\n```."},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who completed the meeting or webinar recording."},"object":{"required":["account_id","duration","host_email","host_id","id","password","recording_count","recording_files","share_url","start_time","topic","total_size","type","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The ID of the recorded meeting `meetingId` or webinar `webinarId`.","format":"int64"},"uuid":{"type":"string","description":"The universally unique identifier (UUID) of the recorded meeting or webinar instance."},"host_id":{"type":"string","description":"The ID of the user set as the host of the meeting or webinar."},"account_id":{"type":"string","description":"The account ID of the user who completed the meeting or webinar recording."},"topic":{"type":"string","description":"The meeting or webinar topic."},"type":{"type":"integer","description":"The type of recorded meeting or webinar. \n\n If the recording is of a meeting: \n* `1` — Instant meeting. \n* `2` — Scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A meeting created via PMI (Personal Meeting ID). \n* `7` — A [Personal Audio Conference](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) (PAC). \n* `8` - Recurring meeting with a fixed time. \n\n If the recording is of a webinar: \n* `5` — A webinar. \n* `6` — A recurring webinar without a fixed time. \n* `9` — A recurring webinar with a fixed time. \n\n If the recording is **not** from a meeting or webinar: \n\n* `99` — A recording uploaded via the [**Recordings**](https://zoom.us/recording) interface on the Zoom Web Portal.","enum":[1,2,3,4,5,6,7,8,9,99]},"start_time":{"type":"string","description":"The meeting's or webinar's start time.","format":"date-time"},"password":{"type":"string","description":"The meeting's or webinar's password."},"timezone":{"type":"string","description":"The meeting's or webinar's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"host_email":{"type":"string","description":"The host's email address.","format":"email"},"duration":{"type":"integer","description":"The recording's duration."},"share_url":{"type":"string","description":"The URL where approved users can view the recording."},"total_size":{"type":"integer","description":"The recording file's total size, in bytes."},"recording_count":{"type":"integer","description":"The number of completed recording files."},"on_prem":{"type":"boolean","description":"Whether the recording is an [on-premise](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment) recording."},"recording_play_passcode":{"type":"string","description":"The cloud recording's password to be used in the URL. This recording's password can be directly spliced in `play_url` or `share_url` with `?pwd=` to access and play, such as in 'https://zoom.us/rec/share/**************?pwd=yNYIS408EJygs7rE5vVsJwXIz4-VW7MH'. See [Embedding meeting passcode in invite link](https://support.zoom.us/hc/en-us/articles/360060396571-Embedding-meeting-passcode-in-invite-link) for details. If you want to use this field, please contact Zoom support.","example":"yNYIS408EJygs7rE5vVsJwXIz4-VW7MH"},"auto_delete":{"type":"boolean","description":"Auto-delete status of a meeting's [cloud recording](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording). \n\n Prerequisite: To get the auto-delete status, the host of the recording must have the recording setting 'Delete cloud recordings after a specified number of days' enabled."},"auto_delete_date":{"type":"string","description":"The date on which the recording will be auto-deleted when auto_delete is true. Otherwise, no date will be returned."},"recording_files":{"type":"array","description":"Information about the completed recording files.","items":{"required":["download_url","file_extension","file_size","file_type","id","meeting_id","recording_end","recording_start","recording_type","status"],"type":"object","properties":{"id":{"type":"string","description":"The recording file's ID."},"meeting_id":{"type":"string","description":"The meeting's ID."},"recording_start":{"type":"string","description":"The date and time when recording started.","format":"date-time"},"recording_end":{"type":"string","description":"The date and time when recording ended.","format":"date-time"},"file_type":{"type":"string","description":"The type of the recording file.","enum":["MP4","M4A","CHAT","TRANSCRIPT","CSV","TB","CC","CHAT_MESSAGE","SUMMARY","TIMELINE"]},"file_size":{"type":"integer","description":"The recording file's size, in bytes."},"file_extension":{"type":"string","description":"The file extension type of the recording file.","enum":["MP4","M4A","TXT","VTT","CSV","JSON","JPG"]},"file_name":{"type":"string","description":"The recording file's name."},"play_url":{"type":"string","description":"The URL where the recording file can be opened and played."},"download_url":{"type":"string","description":"The URL to download the the recording. To download the recording file of a meeting or a webinar, use the `download_token` value to download the file. For example: \n\n `https://{{base-domain}}/rec/webhook_download/download/xxx--header 'Authorization: Bearer {{your-download_token-value}}`"},"file_path":{"type":"string","description":"The file path to the on-premise account recording. \n\n **Note:** This API returns this field for [Zoom On-Premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). It does **not** return the `download_url` field."},"status":{"type":"string","description":"The recording file's processing status. \n* `completed` — The processing of the file is complete. \n* `processing` — The file is processing.","enum":["completed","processing"]},"recording_type":{"type":"string","description":"The recording file type. \n* `shared_screen_with_speaker_view(CC)` \n* `shared_screen_with_speaker_view` \n* `shared_screen_with_gallery_view` \n* `gallery_view` \n* `shared_screen` \n* `audio_only` \n* `audio_transcript` \n* `chat_file` \n* `active_speaker` \n* `host_video` \n* `audio_only_each_participant` \n* `cc_transcript` \n* `closed_caption` \n* `poll` \n* `timeline` \n* `thumbnail` \n* `audio_interpretation` \n* `summary` \n* `summary_next_steps` \n* `summary_smart_chapters` \n*`sign_interpretation` \n\nFor more information, read our [Managing and sharing cloud recordings](https://support.zoom.us/hc/en-us/articles/205347605-Managing-and-sharing-cloud-recordings#h_9898497b-e736-4980-a749-d55608f10773) documentation.","enum":["shared_screen_with_speaker_view(CC)","shared_screen_with_speaker_view","shared_screen_with_gallery_view","gallery_view","shared_screen","audio_only","chat_file","active_speaker","host_video","audio_only_each_participant","cc_transcript","closed_caption","poll","timeline","thumbnail","audio_interpretation","summary","summary_next_steps","summary_smart_chapters","sign_interpretation","production_studio"]}},"additionalProperties":false}},"participant_audio_files":{"type":"array","description":"Information about the participants' audio files.","items":{"required":["download_url","file_extension","file_name","file_size","file_type","id","recording_end","recording_start","status"],"type":"object","properties":{"id":{"type":"string","description":"The participant audio file's ID."},"recording_start":{"type":"string","description":"The participant audio file's start time.","format":"date-time"},"recording_end":{"type":"string","description":"The participant audio file's end time.","format":"date-time"},"file_type":{"type":"string","description":"The participant audio file's format."},"file_name":{"type":"string","description":"The participant audio file's name."},"file_size":{"type":"integer","description":"The participant audio file's size, in bytes."},"file_extension":{"type":"string","description":"The participant audio file's extension."},"play_url":{"type":"string","description":"The URL to open and play the participant audio file."},"download_url":{"type":"string","description":"The URL to download the the recording. To download the recording file of a meeting or a webinar, use the `download_token` value to download the file. For example: \n\n `https://{{base-domain}}/rec/webhook_download/download/xxx--header 'Authorization: Bearer {{your-download_token-value}}`"},"file_path":{"type":"string","description":"The file path to the on-premise account recording. \n\n **Note:** This API returns this field for [Zoom On-Premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). It does **not** return the `download_url` field."},"status":{"type":"string","description":"The participant audio file's processing status. \n* `completed` — The processing of the file is complete. \n* `processing` — The file is processing.","enum":["completed","processing"]}},"additionalProperties":false}}},"additionalProperties":false,"description":"Information about the meeting or webinar recording."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.participant_put_in_waiting_roomEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the meeting."},"object":{"required":["duration","host_id","id","participant","start_time","topic","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The meeting ID."},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The meeting host's user ID."},"topic":{"type":"string","description":"The meeting's topic."},"type":{"type":"integer","description":"The meeting type. \n* `0` - A prescheduled meeting. \n* `1` - An instant meeting. \n* `2` - A scheduled meeting. \n* `3` - A recurring meeting with no fixed time. \n* `4` - A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` - A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` - A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"pattern":"(^\\s*$|^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$)","type":"string","description":"The meeting's start time."},"timezone":{"type":"string","description":"The meeting's [timezone](/docs/api/references/abbreviations/#timezones)."},"duration":{"type":"integer","description":"The scheduled meeting duration."},"participant":{"required":["date_time","email","user_id"],"type":"object","properties":{"user_id":{"type":"string","description":"The participant's meeting user ID. This value is assigned to a participant when they join a meeting, and is only valid for the duration of the meeting."},"user_name":{"type":"string","description":"The participant's display name."},"id":{"type":"string","description":"The participant's universally unique ID (UUID). \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value. \n\n This value returns blank for external users.\n\n**Note:** Use the `participant_user_id` value instead of this value. We will remove this response in a future release."},"participant_uuid":{"type":"string","description":"The participant's UUID for this specific meeting and any breakout rooms created in this meeting. This value is assigned to a participant when they join a meeting, and is only valid for the duration of that meeting."},"date_time":{"type":"string","description":"The time when the participant joined the meeting.","format":"date-time"},"email":{"type":"string","description":"The participant's email address. This response only returns if the participant joined the meeting by logging into Zoom. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details.","format":"email"},"phone_number":{"type":"string","description":"Phone number of participant joined via PSTN."},"participant_user_id":{"type":"string","description":"The participant's universally unique ID (UUID). \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value.\n\nThis value returns blank for external users."},"customer_key":{"type":"string","description":"The participant's SDK identifier. This value can be alphanumeric."},"registrant_id":{"type":"string","description":"The participant's registrant ID. A host or a user with administrative permissions can require [registration for Zoom meetings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065026)."}},"additionalProperties":false,"description":"Information about the meeting participant. If the participant is not part of the host's account, `email` returns an empty string value, with some exceptions. See [Email address display rules](/docs/api/using-zoom-apis/#email-address-display-rules) for details."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Recording.trashedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"download_token":{"type":"string","description":"Use the generated token value with the `download_url` value to download the cloud recording via an [OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app). The download token only lasts for 24 hours after its creation and you can only download the file within 24 hours of receiving the event notification. You can either include the `download_token` as a query parameter or pass it as a Bearer token in the Authorization header of your HTTP request: \n\n **Using an Authorization header (Recommended)** \n\n ```\ncurl --request GET \\\n  --url {download_url} \\\n  --header 'authorization: Bearer {download_token} \\\n  --header 'content-type: application/json'\n``` \n\n**Using a query parameter** \n\n ```\n{download_url}/?access_token={download_token}\n``` \n\n For example: `https://zoom.us/recording/download/123456?access_token=abcdefgh`"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who deleted the recording to the trash."},"operator":{"type":"string","description":"The email address of the user who deleted the recording to the trash.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who deleted the recording to the trash."},"object":{"required":["account_id","duration","host_id","id","recording_count","share_url","start_time","topic","total_size","type","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The ID of the recorded meeting (`meetingId`) or webinar (`webinarId`).","format":"int64"},"uuid":{"type":"string","description":"The universally unique identifier (UUID) of the recorded meeting or webinar instance."},"host_id":{"type":"string","description":"The ID of the user set as the host of the meeting or webinar."},"topic":{"type":"string","description":"The meeting or webinar topic."},"type":{"type":"integer","description":"The type of recorded meeting or webinar: \n\n If the recording is of a meeting: \n* `1` — Instant meeting. \n* `2` — Scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A meeting created via PMI (Personal Meeting ID). \n* `7` — A [Personal Audio Conference](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) (PAC). \n* `8` - Recurring meeting with a fixed time. \n\n If the recording is of a webinar: \n* `5` — A webinar. \n* `6` — A recurring webinar without a fixed time. \n* `9` — A recurring webinar with a fixed time. \n\n If the recording is **not** from a meeting or webinar: \n\n* `99` — A recording uploaded via the [**Recordings**](https://zoom.us/recording) interface on the Zoom Web Portal.","enum":[1,2,3,4,5,6,7,8,9,99]},"start_time":{"type":"string","description":"The meeting or webinar's start time.","format":"date-time"},"timezone":{"type":"string","description":"The meeting or webinar's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"duration":{"type":"integer","description":"The meeting or webinar's scheduled duration."},"share_url":{"type":"string","description":"The URL at which approved users can view the recording."},"total_size":{"type":"integer","description":"The recording file's total size, in bytes."},"recording_count":{"type":"integer","description":"The number of recording files deleted to the trash."},"account_id":{"type":"string","description":"The account ID of the user that completed the meeting or webinar recording."},"recording_files":{"type":"array","description":"Information about the trashed recording files.","items":{"required":["download_url","file_extension","file_size","file_type","id","meeting_id","recording_end","recording_start","recording_type","status"],"type":"object","properties":{"id":{"type":"string","description":"The recording file's ID."},"meeting_id":{"type":"string","description":"The meeting's ID."},"recording_start":{"type":"string","description":"The date and time at which recording started.","format":"date-time"},"recording_end":{"type":"string","description":"The date and time at which recording ended.","format":"date-time"},"file_type":{"type":"string","description":"The recording file's type.","enum":["MP4","M4A","CHAT","TRANSCRIPT","CSV","TB","CC","CHAT_MESSAGE","SUMMARY","TIMELINE"]},"file_extension":{"type":"string","description":"The recording file's extension.","enum":["MP4","M4A","TXT","VTT","CSV","JSON","JPG"]},"file_name":{"type":"string","description":"The recording file's name."},"file_size":{"type":"integer","description":"The recording file's size, in bytes."},"play_url":{"type":"string","description":"The URL at which the recording file can be opened and played."},"download_url":{"type":"string","description":"The URL at which to download the the recording. \n\n **JWT apps** \n\n To access a private or password-protected cloud recording of a user in your account, use a [Zoom JWT app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-jwt-app). Use the generated JWT token as the value of the `access_token` query parameter and include this query parameter at the end of the URL. \n\n `https://{{base-domain}}/recording/download/{{path-to-file-download}}?access_token={{JWT-token}}` \n\n **OAuth apps** \n\n If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) to download the file. For example: \n\n `https://{{base-domain}}/rec/archive/download/xxx?access_token={{OAuth-access-token}}`. \n\n**Note:** We recommend that you send the access_token as a Bearer token in the Authorization header, for example: \"Authorization\": \"Bearer <ACCESS_TOKEN>”."},"status":{"type":"string","description":"The recording file's processing status: \n* `completed` — The processing of the file is complete. \n* `processing` — The file is processing.","enum":["completed","processing"]},"recording_type":{"type":"string","description":"The type of recording file: \n* `shared_screen_with_speaker_view(CC)` \n* `shared_screen_with_speaker_view` \n* `shared_screen_with_gallery_view` \n* `gallery_view` \n* `shared_screen` \n* `audio_only` \n* `audio_transcript` \n* `chat_file` \n* `active_speaker` \n* `host_video` \n* `audio_only_each_participant` \n* `cc_transcript` \n* `closed_caption` \n* `poll` \n* `timeline` \n* `thumbnail` \n* `audio_interpretation` \n* `summary` \n* `summary_next_steps` \n* `summary_smart_chapters` \n*`production_studio` \n\nFor more information, read our [Managing and sharing cloud recordings](https://support.zoom.us/hc/en-us/articles/205347605-Managing-and-sharing-cloud-recordings#h_9898497b-e736-4980-a749-d55608f10773) documentation.","enum":["shared_screen_with_speaker_view(CC)","shared_screen_with_speaker_view","shared_screen_with_gallery_view","gallery_view","shared_screen","audio_only","audio_transcript","chat_file","active_speaker","host_video","audio_only_each_participant","cc_transcript","closed_caption","poll","timeline","thumbnail","audio_interpretation","summary","summary_next_steps","summary_smart_chapters","production_sutdio"]}},"additionalProperties":false}},"participant_audio_files":{"type":"array","description":"Information about the trashed participant audio files.","items":{"required":["download_url","file_extension","file_name","file_size","file_type","id","recording_end","recording_start","status"],"type":"object","properties":{"id":{"type":"string","description":"The participant audio file's ID."},"recording_start":{"type":"string","description":"The participant audio file's start time.","format":"date-time"},"recording_end":{"type":"string","description":"The participant audio file's end time.","format":"date-time"},"file_type":{"type":"string","description":"The participant audio file's format."},"file_name":{"type":"string","description":"The participant audio file's name."},"file_size":{"type":"integer","description":"The participant audio file's size, in bytes."},"file_extension":{"type":"string","description":"The participant audio file's extension."},"play_url":{"type":"string","description":"The URL at which the participant audio file can be opened and played."},"download_url":{"type":"string","description":"The URL at which to download the the recording. \n\n **JWT apps** \n\n To access a private or password-protected cloud recording of a user in your account, use a [Zoom JWT app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-jwt-app). Use the generated JWT token as the value of the `access_token` query parameter and include this query parameter at the end of the URL. \n\n `https://{{base-domain}}/recording/download/{{path-to-file-download}}?access_token={{JWT-token}}` \n\n **OAuth apps** \n\n If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) to download the file. For example: \n\n`https://{{base-domain}}/rec/archive/download/xxx?access_token={{OAuth-access-token}}` \n\n **Note:** This field does **not** return for [Zoom On-Premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). Instead, this API will return the `file_path` field."},"file_path":{"type":"string","description":"The file path to the On-Premise account recording. \n\n **Note:** This API returns this field for [Zoom On-Premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). It does **not** return the `download_url` field."},"status":{"type":"string","description":"The participant audio file's processing status: \n* `completed` — The processing of the file is complete. \n* `processing` — The file is processing.","enum":["completed","processing"]}},"additionalProperties":false}}},"additionalProperties":false,"description":"Information about the webinar or meeting recording."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.summary_deletedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who hosted the meeting."},"operator":{"type":"string","description":"The email address of the user who permanently deleted the meeting summary."},"operator_id":{"type":"string","description":"The user ID of the user who permanently deleted the meeting summary."},"object":{"required":["meeting_end_time","meeting_host_email","meeting_host_id","meeting_id","meeting_start_time","meeting_topic","meeting_uuid","summary_created_time","summary_end_time","summary_last_modified_time","summary_start_time","summary_title"],"type":"object","properties":{"meeting_host_id":{"type":"string","description":"The ID of the user who is set as the meeting host."},"meeting_host_email":{"type":"string","description":"The meeting host's email address.","format":"email"},"meeting_uuid":{"type":"string","description":"Unique meeting ID. Each meeting instance generates its own meeting UUID - after a meeting ends, a new UUID is generated for the next instance of the meeting. Retrieve a list of UUIDs from past meeting instances using the [**List past meeting instances**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/pastMeetings) API. [Double encode](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#meeting-id-and-uuid) your UUID when using it for API calls if the UUID begins with a `/` or contains `//` in it.\n"},"meeting_id":{"type":"integer","description":"[Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-) - the meeting's unique identifier in **long** format, represented as int64 data type in JSON. Also known as the meeting number.","format":"int64"},"meeting_topic":{"type":"string","description":"Meeting topic."},"meeting_start_time":{"type":"string","description":"The meeting's start date and time.","format":"date-time"},"meeting_end_time":{"type":"string","description":"The meeting's end date and time.","format":"date-time","example":"2020-07-15T23:30:19Z"},"summary_start_time":{"type":"string","description":"The summary's start date and time.","format":"date-time"},"summary_end_time":{"type":"string","description":"The summary's end date and time.","format":"date-time"},"summary_created_time":{"type":"string","description":"The date and time when the meeting summary was created.","format":"date-time"},"summary_last_modified_time":{"type":"string","description":"The date and time when the meeting summary was last modified.","format":"date-time"},"summary_title":{"type":"string","description":"The summary title."}},"additionalProperties":true,"description":"Information about the meeting summary."}},"additionalProperties":true}},"additionalProperties":true},"Webinar.participant_bindEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the Webinar."},"object":{"required":["host_id","participant","type","uuid"],"type":"object","properties":{"id":{"type":"string","description":"The webinar ID."},"uuid":{"type":"string","description":"The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."},"host_id":{"type":"string","description":"The webinar host's user ID."},"topic":{"type":"string","description":"The webinar's topic."},"type":{"type":"integer","description":"The webinar type. \n* `0` - A prescheduled webinar. \n* `1` - An instant webinar. \n* `2` - A scheduled webinar. \n* `3` - A recurring webinar with no fixed time. \n* `4` - A [personal webinar room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` - A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-webinar) webinar. \n* `8` - A recurring webinar with a fixed time.","enum":[0,1,2,3,4,7,8]},"start_time":{"pattern":"(^\\s*$|^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$)","type":"string","description":"The webinar's start time."},"timezone":{"type":"string","description":"The webinar's [timezone](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones)."},"duration":{"type":"integer","description":"The scheduled webinar duration."},"participant":{"required":["bind_user_id","join_time","phone_number","user_id"],"type":"object","properties":{"user_id":{"type":"string","description":"The participant's webinar user ID. This value is assigned to a participant when they join a webinar, and is only valid for the duration of the webinar."},"bind_user_id":{"type":"string","description":"The particpant's webinar user ID of participant the phone user bind to. This value is assigned to a participant when they join a webinar, and is only valid for the duration of the webinar."},"user_name":{"type":"string","description":"The participant's display name."},"id":{"type":"string","description":"The participant's universally unique ID (UUID). \n* If the participant joins the webinar by logging into Zoom, this value is the `id` value in the [**Get a user**](https://developers.zoom.us/docs/api/rest/reference/user/methods/#operation/user) API response. \n* If the participant joins the webinar **without** logging into Zoom, this returns an empty string value. \n\n This value returns blank for external users.\n\n**Note:** Use the `participant_user_id` value instead of this value. We will remove this response in a future release."},"participant_uuid":{"type":"string","description":"The participant's UUID for this specific webinar and any breakout rooms created in this webinar. This value is assigned to a participant when they join a webinar, and is only valid for the duration of that webinar."},"bind_participant_uuid":{"type":"string","description":"The participant's UUID of the user which this phone user binds to."},"join_time":{"type":"string","description":"The time when the participant joined the webinar.","format":"date-time"},"registrant_id":{"type":"string","description":"The registrant ID of the participants this phone user binds to. A host or a user with administrative permissions can require [registration for Zoom webinars](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065026)."},"phone_number":{"type":"string","description":"Phone number of participants who joined via PSTN.","example":"8615250064084"}},"additionalProperties":false,"description":"Information about the webinar participant. If the participant is **not** part of the host's account, `email` returns an empty string value, with some exceptions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details."}},"additionalProperties":false,"description":"Information about the webinar."}},"additionalProperties":false}},"additionalProperties":false},"Webinar.updatedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"A timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object","old_object","operator","operator_id","time_stamp"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who updated the webinar."},"operator":{"type":"string","description":"The email address of the user who updated the webinar.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who updated the webinar."},"scope":{"type":"string","description":"The type of operation performed. \n* `all` - The change was applied to all webinars. \n* `single` - The change was applied only to a single webinar.","enum":["single","all"]},"object":{"required":["id"],"type":"object","properties":{"id":{"type":"integer","description":"The webinar ID.","format":"int64"},"uuid":{"type":"string","description":"The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."},"host_id":{"type":"string","description":"The webinar host's user ID."},"topic":{"type":"string","description":"The webinar's topic."},"type":{"type":"integer","description":"The webinar type. \n* `5` - A webinar. \n* `6` - A recurring webinar without a fixed time. \n* `9` - A recurring webinar with a fixed time.","enum":[5,6,9]},"start_time":{"pattern":"(^\\s*$|^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$)","type":"string","description":"The webinar's start time."},"duration":{"type":"integer","description":"The scheduled webinar duration."},"timezone":{"type":"string","description":"The webinar's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones)."},"password":{"type":"string","description":"The password required to join the webinar."},"agenda":{"type":"string","description":"The webinar's agenda."},"registration_url":{"type":"string","description":"The webinar's registration URL."},"occurrences":{"type":"array","description":"Information about recurring webinar with fixed times and their occurrences. This only returns when the webinar's `type` value is `9`.","items":{"anyOf":[{"required":["occurrence_id","start_time"],"type":"object","properties":{"occurrence_id":{"type":"string","description":"The webinar occurrence's ID."},"start_time":{"type":"string","description":"The webinar's start time.","format":"date-time"},"duration":{"type":"integer","description":"The scheduled webinar duration."},"status":{"type":"string","description":"The webinar occurrence status: \n* `available` \n* `deleted`","enum":["available","deleted"]}},"additionalProperties":true}]}},"settings":{"type":"object","properties":{"host_video":{"type":"boolean","description":"Whether to start the webinar with the host's video on."},"panelists_video":{"type":"boolean","description":"Whether to turn panelists' video on when they join the webinar."},"practice_session":{"type":"boolean","description":"Whether to enable the [**Enable Practice Session**](https://support.zoom.us/hc/en-us/articles/206316975-Webinar-Practice-Session) feature."},"approval_type":{"type":"integer","description":"The [approval type](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-webinar-with-registration) for webinar registrants. \n* `0` - Automatically approve registrants. \n* `1` - Manually approve registrants. \n* `2` - Webinar registration not required.","enum":[0,1,2]},"registration_type":{"type":"integer","description":"The webinar registration setting for recurring webinars: \n* `1` - Attendees register once and can attend any of the webinar occurrences. \n* `2` - Attendees must register for each occurrence to attend. \n* `3` - Attendees register once and can select one or more occurrences to attend.","enum":[1,2,3]},"audio":{"type":"string","description":"The available audio options for participants joining the webinar. \n* `telephony` - Telephony only. \n* `voip` - VoIP only. \n* `both` - Both Telephony and VoIP.","enum":["telephony","voip","both"]},"auto_recording":{"type":"string","description":"The [automatic recording](https://support.zoom.us/hc/en-us/articles/202921119-Automatic-Recording) settings for the webinar. \n* `local` - Record and save to the local device. \n* `cloud` - Record and save to the cloud. \n* `none` - Automatic recording disabled.","enum":["local","cloud","none"]},"enforce_login":{"type":"boolean","description":"Whether to only allow signed in users to join the webinar."},"meeting_authentication":{"type":"boolean","description":"Whether only authenticated users can join the webinar."},"authentication_option":{"type":"string","description":"The [authentication](https://support.zoom.us/hc/en-us/articles/4406604615693) option ID value."},"authentication_name":{"type":"string","description":"The authentication name set in the [authentication profile](https://support.zoom.us/hc/en-us/articles/360037117472)."},"authentication_domains":{"type":"string","description":"A list of the allowed authenticated domains."},"language_interpretation":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable [language interpretation](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064768) for the webinar."},"interpreters":{"type":"array","description":"Information about the webinar's language interpreters.","items":{"type":"object","properties":{"email":{"type":"string","description":"The interpreter's email address.","format":"email"},"interpreter_languages":{"type":"string","description":"A comma-separated list of the interpreter's languages. The string must contain exactly two languages.\n\nTo get this value, use the `language_interpretation` object's `languages` and `custom_languages` values in the [**Get user settings**](https://developers.zoom.us/docs/api/users/#tag/users/GET/users/{userId}/settings) API response.\n\n**languages**: System-supported languages include `English`, `Chinese`, `Japanese`, `German`, `French`, `Russian`, `Portuguese`, `Spanish`, and `Korean`.\n\n**custom_languages**: User-defined languages added by the user.\n\nFor example, an interpreter translating between English and French should use `English,French`."}}}}},"description":"The webinar's [language interpretation settings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064768). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** This feature is only available for certain Webinar add-on, Education, and Business and higher plans. If this feature is not enabled on the host's account, this setting will **not** be applied to the webinar. This is not supported for simulive webinars."},"sign_language_interpretation":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable [sign language interpretation](https://support.zoom.us/hc/en-us/articles/9644962487309-Using-sign-language-interpretation-in-a-meeting-or-webinar) for the webinar."},"interpreters":{"maximum":20,"type":"array","description":"Information about the webinar's sign language interpreters.","items":{"type":"object","properties":{"email":{"type":"string","description":"The interpreter's email address.","format":"email"},"sign_language":{"type":"string","description":"The interpreter's sign language. \n\n To get this value, use the `sign_language_interpretation` object's `languages` and `custom_languages` values in the [**Get user settings**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods#operation/userSettings) API response."}}}}},"description":"The webinar's [sign language interpretation settings](https://support.zoom.us/hc/en-us/articles/9644962487309-Using-sign-language-interpretation-in-a-meeting-or-webinar). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** If this feature is not enabled on the host's account, this setting will **not** be applied to the webinar."},"allow_host_control_participant_mute_state":{"type":"boolean","description":"Whether to allow host and co-hosts to fully control the mute state of participants."},"email_in_attendee_report":{"type":"boolean","description":"Whether to include guest's email addresses in webinars' attendee reports."}},"additionalProperties":true,"description":"Information about the updated webinar settings. This **only** returns updated webinar settings."},"recurrence":{"type":"object","properties":{"type":{"type":"integer","description":"The recurring webinar type. \n* `1` - Daily. \n* `2` - Weekly. \n* `3` - Monthly.","enum":[1,2,3]},"repeat_interval":{"type":"integer","description":"The webinar's repeat interval. \n* For daily intervals, a maximum of `90` days. \n* For a weekly interval, a maximum of `12` weeks. \n* For monthly intervals, a maximum of `3` months."},"weekly_days":{"type":"string","description":"A comma-separated list of the days of the week when the recurring weekly webinar occurs. \n* `1` - Sunday \n* `2` - Monday \n* `3` - Tuesday \n* `4` - Wednesday \n* `5` - Thursday \n* `6` - Friday \n* `7` - Saturday"},"monthly_day":{"maximum":31,"minimum":1,"type":"integer","description":"The day of the month when the recurring monthly webinar occurs. The value ranges from 1 to 31."},"monthly_week_day":{"type":"integer","description":"The day of the week when the recurring monthly webinar is scheduled. \n* `1` - Sunday \n* `2` - Monday \n* `3` - Tuesday \n* `4` - Wednesday \n* `5` - Thursday \n* `6` - Friday \n* `7` - Saturday","enum":[1,2,3,4,5,6,7]},"end_times":{"type":"integer","description":"The number of times the recurring webinar will occur before it is canceled.","default":1},"end_date_time":{"type":"string","description":"The recurring webinar's final ending date and time before it is canceled, in UTC format.","format":"date-time"},"monthly_week":{"type":"integer","description":"The week of the month when a recurring webinar occurs. \n* `-1` - The last week of the month. \n* `1` - The first week. \n* `2` - The second week. \n* `3` - The third week. \n* `4` - The fourth week.","enum":[-1,1,2,3,4]}},"additionalProperties":true,"description":"Information about [recurring webinars](https://marketplace.zoom.us/docs/api-reference/other-references/recurrence-object-definitions)."}},"additionalProperties":true,"description":"Information about the webinar."},"time_stamp":{"type":"integer","description":"The webinar's update timestamp, in milliseconds.","format":"int64"},"old_object":{"$ref":"#/properties/payload/properties/object"}},"additionalProperties":true}},"additionalProperties":true},"Recording.batch_recoveredEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user that completed the meeting or webinar recording."},"operator":{"type":"string","description":"The email address of the user who recovered the recording.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who recovered the recording."},"object":{"required":["meetings"],"type":"object","properties":{"meetings":{"type":"array","items":{"type":"object","properties":{"meeting_uuid":{"type":"string","description":"The universally unique identifier (UUID) of the recorded meeting or webinar instance."},"recording_file_ids":{"type":"array","description":"The recording file's unique ID. If the current field value is NULL, it means to recover the whole Meeting Recording files."}},"description":"Information about the meeting or webinar recording."}}},"additionalProperties":false,"description":"Information about the meeting or webinar recording."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.participant_room_system_callout_rejectedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the meeting host."},"object":{"required":["host_id","id","inviter_name","message_id","participant","uuid"],"type":"object","properties":{"id":{"type":"integer","description":"The meeting ID.","format":"int64"},"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"host_id":{"type":"string","description":"The user ID of the meeting host."},"message_id":{"type":"string","description":"The request unique identifier (UUID)."},"inviter_name":{"type":"string","description":"The user name of the event's trigger."},"participant":{"required":["call_type","device_ip"],"type":"object","properties":{"call_type":{"type":"string","description":"The type of call out. Use a value of `h323` or `sip`."},"device_ip":{"type":"string","description":"The user's device IP address."}},"additionalProperties":false,"description":"Information about the invited participant."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false}}},"tags":[{"name":"Meetings"},{"name":"Webinars"},{"name":"Cloud Recording"},{"name":"TSP"}],"servers":[{"url":"https://{your-endpoint-url}"}]}