{"openapi":"3.0.0","info":{"title":"Rooms Webhooks","description":"The Zoom Rooms webhooks allow developers to receive events for [Zoom Rooms](https://developers.zoom.us/docs/zoom-rooms/) features.","version":"1.0.0"},"paths":{"visitor_management.checked_out":{"post":{"tags":["Visitor Management"],"summary":"visitor_management.checked_out","description":"The **Visitor Management Checked Out** event is triggered when a visitor checks out.\n\n## Prerequisites\n \n* The [**Visitor Management**](https://support.zoom.com/hc/en?id=zm_kb&sysparm_article=KB0057564) feature enabled by your organization.\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 **Visitor Management Checked Out** subscription enabled under the **Visitor Management** event.\n\n","operationId":"Visitor_management.checked_outWebhook","requestBody":{"description":"Webhook payload for the `visitor_management.checked_out` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Visitor_management.checked_outEvent"},"examples":{"default":{"summary":"Example visitor_management.checked_out event","value":{"event":"visitor_management.checked_out","event_ts":"290112312321","payload":{"account_id":"ajdkd-qBPgsxg","operator":"admin@example.com","operator_id":"I7zp-pYbTl22Z29H796Ixg","object":{"visitor_email":"visitor@example.com","visitor_name":"visitor","start_time":1710153000000,"end_time":1710172799999,"invite_location_id":"wnFFoWRwTLeww81UuAeW4g","host_id":"I7zp-pYbTl22Z29H796Ixg","host_name":"admin","host_email":"admin@example.com"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"workspace.user_unassigned":{"post":{"tags":["Workspaces"],"summary":"workspace.user_unassigned","description":"The **Workspace User Unassigned** event is triggered every time a user is unassigned from a Workspace in your account. Admins and account owners can unassign a user from Workspace in you account. The Workspace can be unassign users using the [Delete a desk assignment API](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/Deleteadeskassignment) or by deleting the Workspace' assignment using the Zoom Web Portal itself.\n\n## Prerequisites\n\n* The **Workspace Reservation** feature enabled by your organization through a Zoom Rooms license, Zoom Phone Common Area Phone license or Workspace Reservation 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 **Workspace User Unassigned** subscription enabled under the **Workspace** event.\n","operationId":"Workspace.user_unassignedWebhook","requestBody":{"description":"Webhook payload for the `workspace.user_unassigned` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace.user_unassignedEvent"},"examples":{"default":{"summary":"Example workspace.user_unassigned event","value":{"event":"workspace.user_unassigned","event_ts":1707848572310,"payload":{"account_id":"VQYZ9ytmTbaXK9Zr2LvIrg","operator_id":"rZXNXVlVSTaSZDTJvLcBew","operator":"vic-devint@zoom.us","object":{"workspace_id":"fqtckjhjhee89ruidvc2h6lc4g","workspace_name":"test change date - Desk1","account_id":"bhmIXpdYRcCK6BB3VhMq6w","user_id":"oyLyxW48QeC3uBBFY2CF3A","assign_type":"permanent"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"workspace.reservation_questionnaire_response_created":{"post":{"tags":["Workspaces"],"summary":"workspace.reservation_questionnaire_response_created","description":"The **Workspace reservation questionnaire created** event is triggered every time when a questionnaire is submitted as a part of workspace reservation. Admin and Users can create a workspace reservation and submit a questionnaire during the reservation creation process.\n\n## Prerequisites\n\n* The **Workspace Reservation** feature enabled by your organization through a Zoom Rooms license, Zoom Phone Common Area Phone license or Workspace Reservation 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 **Workspace reservation questionnaire created** subscription enabled under the **Workspace** event.","operationId":"Workspace.reservation_questionnaire_response_createdWebhook","requestBody":{"description":"Webhook payload for the `workspace.reservation_questionnaire_response_created` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace.reservation_questionnaire_response_createdEvent"},"examples":{"default":{"summary":"Example workspace.reservation_questionnaire_response_created event","value":{"event":"workspace.reservation_questionnaire_response_created","payload":{"account_id":"VQYZ9ytmTbaXK9Zr2LvIrg","operator":"yuki-devint@zoom.us","operator_id":"rZXNXVlVSTaSZDTJvLcBew","object":{"start_time":"2024-02-14T03:50:00Z","event_id":"dxpwbc2fi8tzz7d012rwx9u8c0","user_name":"Simash pokh","desk_id":"SJjU1CcGSs2L7odn6PanQw","workspace_name":"test change date - Desk1","location_id":"wnFFoWRwTLeww81UuAeW4g","questionnaire_response":[{"id":"Fl75C43YTmS_IpMzYLipJw","title":"Simash Reservation Questionnaire","list":[{"question_id":"0ds1NFeDQ1WfWlgVK-7OMQ","title":"do you like AI ?","type":"single","options":[{"option_id":"UClQqM1qT_q-bZQ0Xti7Vw","text":"Yes"},{"option_id":"1S1hZzFGTwW9Llxdr2vzyw","text":"No"}],"reply_id":"UClQqM1qT_q-bZQ0Xti7Vw"},{"question_id":"2XMaJFwNSr-BJpTfo6rRAQ","title":"what is your fav food ? ","type":"multiple","options":[{"option_id":"iPkq2UDOSLOLHNq_Ac1WsQ","text":"momo"},{"option_id":"dpv4EZ7QQUqRhBmYj4_b7w","text":"sea food"},{"option_id":"__DjlrV7TeyCSZVmCWAnng","text":"rice"}],"reply_id":"iPkq2UDOSLOLHNq_Ac1WsQ,dpv4EZ7QQUqRhBmYj4_b7w"}],"subject":"reservation"}]}},"event_ts":1707848572310}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"zoomroom.sensor_data":{"post":{"tags":["Zoom Rooms"],"summary":"zoomroom.sensor_data","description":"\nThe **Zoom Room Sensor Data** event triggers every five minutes when a Zoom Room device sensor reports data.\n\n## Prerequisites\n \n* A Business or Enterprise plan.\n* The ability to detect the room air conditions, a feature available with Zoom Rooms version 5.5.0 or later. Not supported for Mac and Windows Zoom Rooms or Windows Controller.\n* Count the number of people in room: available on Zoom Rooms clients versions 5.5.0 (Windows), 5.5.0 (Mac), 5.6.6 (Android), 5.5.0 (iOS Controller), 5.5.0 (Android Controller) or later.\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 **Zoom Room Sensor Data** subscription enabled under the **Zoom Room** event.\n\n","operationId":"Zoomroom.sensor_dataWebhook","requestBody":{"description":"Webhook payload for the `zoomroom.sensor_data` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Zoomroom.sensor_dataEvent"},"examples":{"default":{"summary":"Example zoomroom.sensor_data event","value":{"event":"zoomroom.sensor_data","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"abcD3ojfdbjfg","room_name":"My Zoom Room","device_id":"NiVvY1NWpE2nulNrhVjgU4jD0swziVrXBbaFZyC3u+o=","sensor_data":[{"date_time":"2022-06-19T00:00:00Z","sensor_type":"REAL_TIME_PEOPLE_COUNT","sensor_value":"20"}]}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"visitor_management.invitation_deleted":{"post":{"tags":["Visitor Management"],"summary":"visitor_management.invitation_deleted","description":"\nThe **Visitor Management Invitation Deleted** event is triggered when an [invitation is deleted](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0073629#mcetoc_1hi1ubsr1fh).\n\n## Prerequisites\n \n* The [**Visitor Management**](https://support.zoom.com/hc/en?id=zm_kb&sysparm_article=KB0057564) feature enabled by your organization.\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 **Visitor Management Invitation Deleted** subscription enabled under the **Visitor Management** event.\n\n","operationId":"Visitor_management.invitation_deletedWebhook","requestBody":{"description":"Webhook payload for the `visitor_management.invitation_deleted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Visitor_management.invitation_deletedEvent"},"examples":{"default":{"summary":"Example visitor_management.invitation_deleted event","value":{"event":"visitor_management.invitation_deleted","event_ts":"290112312321","payload":{"account_id":"ajdkd-qBPgsxg","operator":"admin@example.com","operator_id":"I7zp-pYbTl22Z29H796Ixg","object":{"visitor_email":"visitor@example.com","visitor_name":"visitor","invite_location_id":"wnFFoWRwTLeww81UuAeW4g","host_id":"I7zp-pYbTl22Z29H796Ixg","host_name":"admin","host_email":"admin@example.com"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"zoomroom.alert":{"post":{"tags":["Zoom Rooms"],"summary":"zoomroom.alert","description":"\nThe **Zoom Room Alert** event is triggered when there is an issue with a Zoom Room on a Zoom account that has installed your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app. Some of the issues that can trigger this event are:\n\n* High CPU usage.\n* Low battery, charging, and/or connection issues in a Zoom Room device.\n* Room controller, camera, or speaker disconnections or reconnections.\n* Missing camera or microphone.\n \nIt is recommended that you **only** subscribe to either the **Zoom Room Alert** event or the **Zoom Room Delayed Alert** event to avoid receiving duplicate event notifications.\n\n## Prerequisites\n\n* A Business or Enterprise plan.\n* The administrator or account owner must enable the [**Zoom Room Alert**](https://support.zoom.us/hc/en-us/articles/205394099-Zoom-Room-Alerts) feature with the selected alerts in the [Zoom Web Portal](https://zoom.us/location).\n* The Zoom Room version must be 3.5.24524.0821 and higher.\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 **Zoom Room Alert** subscription enabled under the **Zoom Room** event.\n\n","operationId":"Zoomroom.alertWebhook","requestBody":{"description":"Webhook payload for the `zoomroom.alert` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Zoomroom.alertEvent"},"examples":{"default":{"summary":"Example zoomroom.alert event","value":{"event":"zoomroom.alert","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"abcD3ojfdbjfg","room_name":"My Zoom Room","calendar_name":"mycalendar@example.com","email":"jchill@example.com","issue":"Room Controller disconnected","alert_type":1,"component":2,"alert_kind":1}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"workspace.reservation_questionnaire_response_updated":{"post":{"tags":["Workspaces"],"summary":"workspace.reservation_questionnaire_response_updated","description":"The **Workspace reservation questionnaire updated** event is triggered every time a questionnaire is updated. Users or Admins can update the questionnaire by updating the existing reservation.\n## Prerequisites\n\n* The **Workspace Reservation** feature enabled by your organization through a Zoom Rooms license, Zoom Phone Common Area Phone license or Workspace Reservation 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 **Workspace reservation questionnaire updated** subscription enabled under the **Workspace** event.","operationId":"Workspace.reservation_questionnaire_response_updatedWebhook","requestBody":{"description":"Webhook payload for the `workspace.reservation_questionnaire_response_updated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace.reservation_questionnaire_response_updatedEvent"},"examples":{"default":{"summary":"Example workspace.reservation_questionnaire_response_updated event","value":{"event":"workspace.reservation_questionnaire_response_updated","payload":{"account_id":"VQYZ9ytmTbaXK9Zr2LvIrg","operator":"yuki-devint@zoom.us","operator_id":"rZXNXVlVSTaSZDTJvLcBew","object":{"start_time":"2024-02-14T03:50:00Z","event_id":"dxpwbc2fi8tzz7d012rwx9u8c0","user_name":"Simash pokh","desk_id":"SJjU1CcGSs2L7odn6PanQw","workspace_name":"test change date - Desk1","location_id":"wnFFoWRwTLeww81UuAeW4g","questionnaire_response":[{"id":"Fl75C43YTmS_IpMzYLipJw","title":"Simash Reservation Questionnaire","list":[{"question_id":"0ds1NFeDQ1WfWlgVK-7OMQ","title":"do you like AI ?","type":"single","options":[{"option_id":"UClQqM1qT_q-bZQ0Xti7Vw","text":"Yes"},{"option_id":"1S1hZzFGTwW9Llxdr2vzyw","text":"No"}],"reply_id":"UClQqM1qT_q-bZQ0Xti7Vw"},{"question_id":"2XMaJFwNSr-BJpTfo6rRAQ","title":"what is your fav food ? ","type":"multiple","options":[{"option_id":"iPkq2UDOSLOLHNq_Ac1WsQ","text":"momo"},{"option_id":"dpv4EZ7QQUqRhBmYj4_b7w","text":"sea food"},{"option_id":"__DjlrV7TeyCSZVmCWAnng","text":"rice"}],"reply_id":"iPkq2UDOSLOLHNq_Ac1WsQ,dpv4EZ7QQUqRhBmYj4_b7w"}],"subject":"reservation"}]}},"event_ts":1707848572310}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"workspace.reservation_update":{"post":{"tags":["Workspaces"],"summary":"workspace.reservation_update","description":"\nThe **Workspace Reservation Updated** event is triggered when a user updates their [Workspace reservation](https://support.zoom.us/hc/en-us/articles/4417951085965-Using-Workspace-Reservation-Beta-for-Zoom-Rooms).\n\n## Prerequisites\n\n* The **Workspace Reservation** feature enabled by your organization through a [Zoom Rooms license](https://support.zoom.us/hc/en-us/articles/207483343#h_60837516-ccdd-448c-8874-5e82a4f8c906).\n* The Zoom mobile app. This is required for QR code scanning:\n  * Android version 5.9.0.3502 or higher\n  * iOS version 5.9.0 or higher\n* [Zoom Rooms for Touch devices](https://support.zoom.us/hc/en-us/articles/115004773103), version 5.9.0 or higher (*Optional*).\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 **Workspace Reservation Updated** subscription enabled under the **Workspace Reservation** event.\n\n","operationId":"Workspace.reservation_updateWebhook","requestBody":{"description":"Webhook payload for the `workspace.reservation_update` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace.reservation_updateEvent"},"examples":{"default":{"summary":"Example workspace.reservation_update event","value":{"event":"workspace.reservation_updated","event_ts":"290112312321","payload":{"account_id":"G3NQs8u1Qni4Pc-qBPgsxg","operator":"admin@example.com","operator_id":"I7zp-pYbTl22Z29H796Ixg","object":{"id":"fqtckjhjhee89ruidvc2h6lc4g","workspace_id":"qwNQb8u1Qbi3Pc-qBPgshy","topic":"Reserve Zoom Room-01","start_time":"2022-01-19T02:10:00Z","end_time":"2022-01-19T03:55:00Z","reserve_for":"I7zp-pYbTl22Z29H796Ixg"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"workspace.user_assigned":{"post":{"tags":["Workspaces"],"summary":"workspace.user_assigned","description":"The **Workspace User Assigned** event is triggered every time a user is assigned to a Workspace in your account. Admins and account owners can assign a user to Workspace in you account. The Workspace can be assign users using the [Set a desk assignment API](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/setADeskAssignment) or by set the Workspace' assignment using the Zoom Web Portal itself.\n\n## Prerequisites\n\n* The **Workspace Reservation** feature enabled by your organization through a Zoom Rooms license, Zoom Phone Common Area Phone license or Workspace Reservation 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 **Workspace User Assigned** subscription enabled under the **Workspace** event.\n","operationId":"Workspace.user_assignedWebhook","requestBody":{"description":"Webhook payload for the `workspace.user_assigned` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace.user_assignedEvent"},"examples":{"default":{"summary":"Example workspace.user_assigned event","value":{"event":"workspace.user_assigned","event_ts":1707848572310,"payload":{"account_id":"VQYZ9ytmTbaXK9Zr2LvIrg","operator_id":"rZXNXVlVSTaSZDTJvLcBew","operator":"vic-devint@zoom.us","object":{"workspace_id":"fqtckjhjhee89ruidvc2h6lc4g","workspace_name":"test change date - Desk1","assign_type":"permanent","account_id":"bhmIXpdYRcCK6BB3VhMq6w","user_id":"oyLyxW48QeC3uBBFY2CF3A","user_email":"vic-01-devint@zoom.us"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"zoomroom.digital_signage_app_ended":{"post":{"tags":["Zoom Rooms"],"summary":"zoomroom.digital_signage_app_ended","description":"\nThe **[Zoom Room digital signage](https://support.zoom.us/hc/en-us/articles/360000030683-Zoom-Rooms-digital-signage) play ended** event triggers when the digital signage finishes playing or showing.\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 **Zoom Room digital signage app ended** subscription enabled under the **Zoom Room** event.\n\n","operationId":"Zoomroom.digital_signage_app_endedWebhook","requestBody":{"description":"Webhook payload for the `zoomroom.digital_signage_app_ended` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Zoomroom.digital_signage_app_endedEvent"},"examples":{"default":{"summary":"Example zoomroom.digital_signage_app_ended event","value":{"event":"zoomroom.digital_signage_app_ended","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"room_id":"abcD3ojfdbjfg","app_name":"My Zoom Room","app_id":"NiVvY1NWpE2nulNrhVjgU4jD0swziVrXBbaFZyC3u+o=","start_time":"2022-06-19T00:00:00Z","end_time":"2022-06-19T01:01:00Z"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"zoomroom.checked_in":{"post":{"tags":["Zoom Rooms"],"summary":"zoomroom.checked_in","description":"\nThe **Zoom Room Checked In** event is triggered when a user checks in to confirm that they will be using the Zoom Room for a certain period of time.\n\nUsers can check in manually via the Zoom Room controller or they can check in programmatically using the [**Check-in or check-out of a Zoom Room**](https://developers.zoom.us/docs/api/rooms/#tag/zoom-rooms/patch/rooms/{id}/events) API. Users can also check in to the Zoom Room by starting a scheduled meeting, using the whiteboard feature or making a phone call from the Zoom Room.\n\n**Note** Only scheduled meetings will trigger a webhook.\n\n\n## Prerequisites\n\n* The administrator or account owner must enable the [**Room Check-In and Check-Out**](https://developers.zoom.us/docs/api/rooms/#tag/zoom-rooms/patch/rooms/{id}/events) feature.\n* The Zoom Room version must be 4.1.27694.0702 or higher.\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 **Zoom Room Checked In** subscription enabled under the **Zoom Room** event.","operationId":"Zoomroom.checked_inWebhook","requestBody":{"description":"Webhook payload for the `zoomroom.checked_in` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Zoomroom.checked_inEvent"},"examples":{"default":{"summary":"Example zoomroom.checked_in event","value":{"event":"zoomroom.checked_in","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"abcD3ojfdbjfg","room_name":"My Zoom Room","calendar_name":"mycalendar@example.com","email":"jchill@example.com","event_id":"AbbbbbGYxLTc3OTVkMzFmZDc0MwBGAAAAAAD48FI58voYSqDgJePOSZblBwBQ/N0JvB/FRqv5UT2rFfkVAAAAAAENAABQ/N0JvB/FRqv5UT2rFfkVAAE2YC8DAAA=","change_key":"DwAAABYAAABQ/N0JvB/FRqv5UT2rFfkVAAE2XqVw","resource_email":"it@example.com","calendar_id":"mycalendar@example.com","calendar_type":"2","api_type":"0"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"workspace.reservation_checked_in":{"post":{"tags":["Workspaces"],"summary":"workspace.reservation_checked_in","description":"\nThe **Workspace Reservation Checked In** event is triggered when a user checks in their [Workspace reservation](https://support.zoom.us/hc/en-us/articles/4417951085965-Using-Workspace-Reservation-Beta-for-Zoom-Rooms) to confirm that they will be using a Zoom Room or Zoom device-enabled desk.\n\n## Prerequisites\n\n* The **Workspace Reservation** feature enabled by your organization through a [Zoom Rooms license](https://support.zoom.us/hc/en-us/articles/207483343#h_60837516-ccdd-448c-8874-5e82a4f8c906).\n* The Zoom mobile app. This is required for QR code scanning:\n  * Android version 5.9.0.3502 or higher\n  * iOS version 5.9.0 or higher\n* [Zoom Rooms for Touch devices](https://support.zoom.us/hc/en-us/articles/115004773103), version 5.9.0 or higher (*Optional*).\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 **Workspace Reservation Checked In** subscription enabled under the **Workspace Reservation** event.\n\n","operationId":"Workspace.reservation_checked_inWebhook","requestBody":{"description":"Webhook payload for the `workspace.reservation_checked_in` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace.reservation_checked_inEvent"},"examples":{"default":{"summary":"Example workspace.reservation_checked_in event","value":{"event":"workspace.reservation_checked_in","event_ts":"290112312321","payload":{"account_id":"G3NQs8u1Qni4Pc-qBPgsxg","operator":"admin@example.com","operator_id":"I7zp-pYbTl22Z29H796Ixg","object":{"id":"fqtckjhjhee89ruidvc2h6lc4g","workspace_id":"qwNQb8u1Qbi3Pc-qBPgshy","topic":"Reserve Zoom Room-01","start_time":"2022-01-19T02:10:00Z","end_time":"2022-01-19T03:55:00Z","reserve_for":"I7zp-pYbTl22Z29H796Ixg"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"zoomroom.updated":{"post":{"tags":["Zoom Rooms"],"summary":"zoomroom.updated","description":"\nThe **Zoom Room Updated** event is triggered when a user updates a [**Zoom Room**](https://support.zoom.us/hc/en-us/categories/200108436)\n\n## Prerequisites\n\n* The **Zoom Room** feature enabled by your organization through a [Zoom Rooms license](https://support.zoom.us/hc/en-us/articles/207483343#h_60837516-ccdd-448c-8874-5e82a4f8c906).\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 **Zoom Room Updated** subscription enabled under the **Zoom Room** event.\n\n","operationId":"Zoomroom.updatedWebhook","requestBody":{"description":"Webhook payload for the `zoomroom.updated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Zoomroom.updatedEvent"},"examples":{"default":{"summary":"Example zoomroom.updated event","value":{"event":"zoomroom.updated","event_ts":1626230691572,"payload":{"account_id":"G3NQs8u1Qni4Pc-qBPgsxg","object":{"id":"2muAb65FTZCGjj6ginHIbQ","room_name":"My Zoom Room"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"zoomroom.location_updated":{"post":{"tags":["Zoom Rooms"],"summary":"zoomroom.location_updated","description":"The **Zoom Rooms Location has been updated** event is triggered every time you update a Zoom Room Location in your account. Admins and account owners can update a Zoom Room Location to an account. Update the location using the [Update a Zoom Rooms Location API](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/updateZRLocationProfile) or by updating the Zoom Room Location using the Zoom Web Portal itself.\n\n## Prerequisites\n\n* Enable The **Zoom Rooms** feature by your organization through a Zoom Rooms license or Workspace Reservation feature enabled by your organization through a Zoom Rooms license, Zoom Phone Common Area Phone license or **Workspace Reservation** 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 **Zoom Rooms Location Updated** subscription enabled under the **Zoom Rooms** event.","operationId":"Zoomroom.location_updatedWebhook","requestBody":{"description":"Webhook payload for the `zoomroom.location_updated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Zoomroom.location_updatedEvent"},"examples":{"default":{"summary":"Example zoomroom.location_updated event","value":{"event":"zoomroom.location_updated","event_ts":"290112312321","payload":{"account_id":"ajdkd-qBPgsxg","operator":"admin@example.com","operator_id":"I7zp-pYbTl22Z29H796Ixg","object":{"id":"fqtckjhjhee89ruidvc2h6lc4g","name":"My new Zoom Room Location","parent_location_id":"aldjflajsd-fasj","type":"floor"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"workspace.pre_check_in_questionnaire_response_created ":{"post":{"tags":["Workspaces"],"summary":"workspace.pre_check_in_questionnaire_response_created ","description":"The **Workspace pre-check-in questionnaire created** event is triggered every time a pre-check-in questionnaire is submitted. Users can submit the questionnaire by clicking the workspace questionnarie link in the email. \n\n## Prerequisites\n\n* The **Workspace Reservation** feature enabled by your organization through a Zoom Rooms license, Zoom Phone Common Area Phone license or Workspace Reservation 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 **Pre-check-in questionnaire created** subscription enabled under the **Workspace** event.","operationId":"Workspace.pre_check_in_questionnaire_response_createdWebhook","requestBody":{"description":"Webhook payload for the `workspace.pre_check_in_questionnaire_response_created ` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace.pre_check_in_questionnaire_response_createdEvent"},"examples":{"default":{"summary":"Example workspace.pre_check_in_questionnaire_response_created  event","value":{"event":"workspace.pre_check_in_questionnaire_response_created","payload":{"account_id":"VQYZ9ytmTbaXK9Zr2LvIrg","operator":"yuki-devint@zoom.us","operator_id":"rZXNXVlVSTaSZDTJvLcBew","object":{"start_time":"2024-02-14T03:50:00Z","event_id":"dxpwbc2fi8tzz7d012rwx9u8c0","user_name":"Simash pokh","desk_id":"SJjU1CcGSs2L7odn6PanQw","workspace_name":"test change date - Desk1","location_id":"wnFFoWRwTLeww81UuAeW4g","questionnaire_respnse":[{"id":"Fl75C43YTmS_IpMzYLipJw","title":"Simash Reservation Questionnaire","list":[{"question_id":"0ds1NFeDQ1WfWlgVK-7OMQ","title":"do you like AI ?","type":"single","options":[{"option_id":"UClQqM1qT_q-bZQ0Xti7Vw","text":"Yes"},{"option_id":"1S1hZzFGTwW9Llxdr2vzyw","text":"No"}],"reply_id":"UClQqM1qT_q-bZQ0Xti7Vw"},{"question_id":"2XMaJFwNSr-BJpTfo6rRAQ","title":"what is your fav food ? ","type":"multiple","options":[{"option_id":"iPkq2UDOSLOLHNq_Ac1WsQ","text":"momo"},{"option_id":"dpv4EZ7QQUqRhBmYj4_b7w","text":"sea food"},{"option_id":"__DjlrV7TeyCSZVmCWAnng","text":"rice"}],"reply_id":"iPkq2UDOSLOLHNq_Ac1WsQ,dpv4EZ7QQUqRhBmYj4_b7w"}],"subject":"reservation"}]}},"event_ts":1707848572310}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"workspace.reservation_checked_out":{"post":{"tags":["Workspaces"],"summary":"workspace.reservation_checked_out","description":"\nThe **Workspace Reservation Checked Out** event is triggered when a user checks out of their [Workspace reservation](https://support.zoom.us/hc/en-us/articles/4417951085965-Using-Workspace-Reservation-Beta-for-Zoom-Rooms) to confirm that they are releasing the Zoom Room or Zoom device-enabled desk.\n\n## Prerequisites\n\n* The **Workspace Reservation** feature enabled by your organization through a [Zoom Rooms license](https://support.zoom.us/hc/en-us/articles/207483343#h_60837516-ccdd-448c-8874-5e82a4f8c906).\n* The Zoom mobile app. This is required for QR code scanning:\n  * Android version 5.9.0.3502 or higher\n  * iOS version 5.9.0 or higher\n* [Zoom Rooms for Touch devices](https://support.zoom.us/hc/en-us/articles/115004773103), version 5.9.0 or higher (*Optional*).\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 **Workspace Reservation Checked Out** subscription enabled under the **Workspace Reservation** event.\n\n","operationId":"Workspace.reservation_checked_outWebhook","requestBody":{"description":"Webhook payload for the `workspace.reservation_checked_out` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace.reservation_checked_outEvent"},"examples":{"default":{"summary":"Example workspace.reservation_checked_out event","value":{"event":"workspace.reservation_checked_out","event_ts":"290112312321","payload":{"account_id":"G3NQs8u1Qni4Pc-qBPgsxg","operator":"admin@example.com","operator_id":"I7zp-pYbTl22Z29H796Ixg","object":{"id":"fqtckjhjhee89ruidvc2h6lc4g","workspace_id":"qwNQb8u1Qbi3Pc-qBPgshy","topic":"Reserve Zoom Room-01","start_time":"2022-01-19T02:10:00Z","end_time":"2022-01-19T03:55:00Z","reserve_for":"I7zp-pYbTl22Z29H796Ixg"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"visitor_management.checked_in":{"post":{"tags":["Visitor Management"],"summary":"visitor_management.checked_in","description":"The **Visitor Management Checked In** event is triggered when a [visitor checks in](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0073629#h_63082000168761703023137137).\n\n## Prerequisites\n \n* The [**Visitor Management**](https://support.zoom.com/hc/en?id=zm_kb&sysparm_article=KB0057564) feature enabled by your organization.\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 **Visitor Management Checked In** subscription enabled under the **Visitor Management** event.\n\n","operationId":"Visitor_management.checked_inWebhook","requestBody":{"description":"Webhook payload for the `visitor_management.checked_in` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Visitor_management.checked_inEvent"},"examples":{"default":{"summary":"Example visitor_management.checked_in event","value":{"event":"visitor_management.checked_in","event_ts":"290112312321","payload":{"account_id":"ajdkd-qBPgsxg","operator":"admin@example.com","operator_id":"I7zp-pYbTl22Z29H796Ixg","object":{"visitor_email":"visitor@example.com","visitor_name":"visitor","start_time":1710153000000,"end_time":1710172799999,"invite_location_id":"wnFFoWRwTLeww81UuAeW4g","host_id":"I7zp-pYbTl22Z29H796Ixg","host_name":"admin","host_email":"admin@example.com"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"workspace.reservation_deleted":{"post":{"tags":["Workspaces"],"summary":"workspace.reservation_deleted","description":"\nThe **Workspace Reservation Deleted** event is triggered when a user deletes their [Workspace reservation](https://support.zoom.us/hc/en-us/articles/4417951085965-Using-Workspace-Reservation-Beta-for-Zoom-Rooms).\n\n## Prerequisites\n\n* The **Workspace Reservation** feature enabled by your organization through a [Zoom Rooms license](https://support.zoom.us/hc/en-us/articles/207483343#h_60837516-ccdd-448c-8874-5e82a4f8c906).\n* The Zoom mobile app. This is required for QR code scanning:\n  * Android version 5.9.0.3502 or higher\n  * iOS version 5.9.0 or higher\n* [Zoom Rooms for Touch devices](https://support.zoom.us/hc/en-us/articles/115004773103), version 5.9.0 or higher (*Optional*).\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 **Workspace Reservation Deleted** subscription enabled under the **Workspace Reservation** event.\n\n","operationId":"Workspace.reservation_deletedWebhook","requestBody":{"description":"Webhook payload for the `workspace.reservation_deleted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace.reservation_deletedEvent"},"examples":{"default":{"summary":"Example workspace.reservation_deleted event","value":{"event":"workspace.reservation_deleted","event_ts":"290112312321","payload":{"account_id":"G3NQs8u1Qni4Pc-qBPgsxg","operator":"admin@example.com","operator_id":"I7zp-pYbTl22Z29H796Ixg","object":{"id":"fqtckjhjhee89ruidvc2h6lc4g","workspace_id":"qwNQb8u1Qbi3Pc-qBPgshy","topic":"Reserve Zoom Room-01","start_time":"2022-01-19T02:10:00Z","end_time":"2022-01-19T03:55:00Z","reserve_for":"I7zp-pYbTl22Z29H796Ixg"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"visitor_management.invitation_created":{"post":{"tags":["Visitor Management"],"summary":"visitor_management.invitation_created","description":"\nThe **Visitor Management Invitation Created** event is triggered when an [invitation is created](https://support.zoom.com/hc/en?id=zm_kb&sysparm_article=KB0073629#mcetoc_1hi1ubsr1fb).\n\n## Prerequisites\n \n* The [**Visitor Management**](https://support.zoom.com/hc/en?id=zm_kb&sysparm_article=KB0057564) feature enabled by your organization.\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 **Visitor Management Invitation Created** subscription enabled under the **Visitor Management** event.\n\n","operationId":"Visitor_management.invitation_createdWebhook","requestBody":{"description":"Webhook payload for the `visitor_management.invitation_created` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Visitor_management.invitation_createdEvent"},"examples":{"default":{"summary":"Example visitor_management.invitation_created event","value":{"event":"visitor_management.invitation_created","event_ts":"290112312321","payload":{"account_id":"ajdkd-qBPgsxg","operator":"admin@example.com","operator_id":"I7zp-pYbTl22Z29H796Ixg","object":{"invitation_id":"fqtckjhjhee89ruidvc2h6lc4g","visitor_email":"visitor@example.com","visitor_name":"visitor","start_time":1710153000000,"end_time":1710172799999,"invite_location_id":"wnFFoWRwTLeww81UuAeW4g","host_id":"I7zp-pYbTl22Z29H796Ixg","host_name":"admin","host_email":"admin@example.com"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"zoomroom.location_deleted":{"post":{"tags":["Zoom Rooms"],"summary":"zoomroom.location_deleted","description":"The **Zoom Rooms location has been deleted** event is triggered every time a Zoom Room location is deleted in your account. Admins and account owners can delete Zoom Rooms locations in a Zoom account.  Deleting Zoom Rooms locations permanently removes them and their data from the Zoom system.  To delete a Zoom Rooms location, delete the Zoom Rooms location from the Zoom Web Portal itself.\n\n## Prerequisites\n\n* Have your organization enable the **Zoom Rooms** feature through a Zoom Rooms license, or Workspace Reservation feature enabled by your organization through a Zoom Rooms license, Zoom Phone Common Area Phone license or **Workspace Reservation** 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 **Zoom Rooms Location Deleted** subscription enabled under the **Zoom Rooms** event.","operationId":"Zoomroom.location_deletedWebhook","requestBody":{"description":"Webhook payload for the `zoomroom.location_deleted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Zoomroom.location_deletedEvent"},"examples":{"default":{"summary":"Example zoomroom.location_deleted event","value":{"event":"zoomroom.location_deleted","event_ts":"290112312321","payload":{"account_id":"ajdkd-qBPgsxg","operator":"admin@example.com","operator_id":"I7zp-pYbTl22Z29H796Ixg","object":{"id":"fqtckjhjhee89ruidvc2h6lc4g","name":"My Deleted Zoom Room Location","parent_location_id":"aldjflajsd-fasj","type":"floor"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"workspace.reservation_created":{"post":{"tags":["Workspaces"],"summary":"workspace.reservation_created","description":"\nThe **Workspace Reservation Created** event is triggered when a user [reserves](https://support.zoom.us/hc/en-us/articles/4417951085965-Using-Workspace-Reservation-Beta-for-Zoom-Rooms) a Zoom Room or Zoom device-enabled desk.\n\n## Prerequisites\n \n* The **Workspace Reservation** feature enabled by your organization through a [Zoom Rooms license](https://support.zoom.us/hc/en-us/articles/207483343#h_60837516-ccdd-448c-8874-5e82a4f8c906).\n* The Zoom mobile app. This is required for QR code scanning:\n  * Android version 5.9.0.3502 or higher\n  * iOS version 5.9.0 or higher\n* [Zoom Rooms for Touch devices](https://support.zoom.us/hc/en-us/articles/115004773103), version 5.9.0 or higher (*Optional*).\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 **Workspace Reservation Created** subscription enabled under the **Workspace Reservation** event.\n\n","operationId":"Workspace.reservation_createdWebhook","requestBody":{"description":"Webhook payload for the `workspace.reservation_created` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace.reservation_createdEvent"},"examples":{"default":{"summary":"Example workspace.reservation_created event","value":{"event":"workspace.reservation_created","event_ts":290112312321,"payload":{"account_id":"G3NQs8u1Qni4Pc-qBPgsxg","operator":"admin@example.com","operator_id":"I7zp-pYbTl22Z29H796Ixg","object":{"id":"fqtckjhjhee89ruidvc2h6lc4g","workspace_id":"qwNQb8u1Qbi3Pc-qBPgshy","topic":"Reserve Zoom Room-01","start_time":"2022-01-19T02:10:00Z","end_time":"2022-01-19T03:55:00Z","reserve_for":"I7zp-pYbTl22Z29H796Ixg","assignment_checkin":true}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"zoomroom.checked_out":{"post":{"tags":["Zoom Rooms"],"summary":"zoomroom.checked_out","description":"\nThe **Zoom Room Checked Out** event is triggered when a user checks out of the Zoom Room to confirm that they are releasing the room for other users to use.\n\nUsers can check out manually via the Zoom Room controller, or they can check out programmatically using the [**Check-in or check-out of a Zoom Room**](https://developers.zoom.us/docs/api/rooms/#tag/zoom-rooms/patch/rooms/{id}/events) API.\n\n## Prerequisites\n\n* The administrator or account owner must enable the [**Room Check-In and Check-Out**](https://developers.zoom.us/docs/api/rooms/#tag/zoom-rooms/patch/rooms/{id}/events) feature.\n* The Zoom Room version must be 4.7.0 or higher.\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 **Zoom Room Checked Out** subscription enabled under the **Zoom Room** event.","operationId":"Zoomroom.checked_outWebhook","requestBody":{"description":"Webhook payload for the `zoomroom.checked_out` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Zoomroom.checked_outEvent"},"examples":{"default":{"summary":"Example zoomroom.checked_out event","value":{"event":"zoomroom.checked_out","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"abcD3ojfdbjfg","room_name":"My Zoom Room","calendar_name":"mycalendar@example.com","email":"jchill@example.com","event_id":"AbbbbbGYxLTc3OTVkMzFmZDc0MwBGAAAAAAD48FI58voYSqDgJePOSZblBwBQ/N0JvB/FRqv5UT2rFfkVAAAAAAENAABQ/N0JvB/FRqv5UT2rFfkVAAE2YC8DAAA=","change_key":"DwAAABYAAABQ/N0JvB/FRqv5UT2rFfkVAAE2XqVw","resource_email":"zroom1@example.com","calendar_id":"mycalendar@example.com","calendar_type":"2","api_type":"0"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"zoomroom.delayed_alert":{"post":{"tags":["Zoom Rooms"],"summary":"zoomroom.delayed_alert","description":"\nThe **Zoom Room Delayed Alert** event is triggered when there is an issue with a Zoom Room on a Zoom account that has installed your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app. Some of the issues that can trigger this event are:\n\n* High CPU usage.\n* Low battery, charging, and/or connection issues in a Zoom Room device.\n* Room controller, camera, or speaker disconnections or reconnections.\n* Missing camera or microphone.\n\nThis event notification is the same as the **Zoom Room Alert** event notification. However, instead of receiving the event in near real-time, you will receive this event notification **five minutes after an issue occurs in the Zoom Room**.\n \nIt is recommended that you **only** subscribe to either the **Zoom Room Alert** event or the **Zoom Room Delayed Alert** event to avoid receiving duplicate event notifications.\n\n## Prerequisites\n\n* A Business or Enterprise plan.\n* The administrator or account owner must enable the [**Zoom Room Alert**](https://support.zoom.us/hc/en-us/articles/205394099-Zoom-Room-Alerts) feature with the selected alerts in the [Zoom Web Portal](https://zoom.us/location).\n* The Zoom Room version must be 3.5.24524.0821 and higher.\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 **Zoom Room Delayed Alert** subscription enabled under the **Zoom Room** event.\n\n","operationId":"Zoomroom.delayed_alertWebhook","requestBody":{"description":"Webhook payload for the `zoomroom.delayed_alert` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Zoomroom.delayed_alertEvent"},"examples":{"default":{"summary":"Example zoomroom.delayed_alert event","value":{"event":"zoomroom.delayed_alert","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"id":"abcD3ojfdbjfg","room_name":"My Zoom Room","calendar_name":"mycalendar@example.com","email":"jchill@example.com","issue":"Room Controller disconnected","alert_type":1,"component":2,"alert_kind":1}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"workspace.deleted":{"post":{"tags":["Workspaces"],"summary":"workspace.deleted","description":"The **Workspace Deleted** event is triggered every time a Workspace is deleted in your account. Admins and account owners can delete a Workspaces to an account. The Workspace can be deleted using the [Delete a Workspace API](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/deleteWorkspace) or by deleting the Workspace using the Zoom Web Portal itself.\n\n## Prerequisites\n\n* The **Workspace Reservation** feature enabled by your organization through a Zoom Rooms license, Zoom Phone Common Area Phone license or Workspace Reservation 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 **Workspace Deleted** subscription enabled under the **Workspace** event.","operationId":"Workspace.deletedWebhook","requestBody":{"description":"Webhook payload for the `workspace.deleted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace.deletedEvent"},"examples":{"default":{"summary":"Example workspace.deleted event","value":{"event":"workspace.deleted","event_ts":"290112312321","payload":{"account_id":"ajdkd-qBPgsxg","operator":"admin@example.com","operator_id":"I7zp-pYbTl22Z29H796Ixg","object":{"id":"fqtckjhjhee89ruidvc2h6lc4g","workspace_name":"Workspace Name"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"workspace.issue_reported":{"post":{"tags":["Workspaces"],"summary":"workspace.issue_reported","description":"The **Workspace issue reported** event is triggered every time a issue is reported. \n\n## Prerequisites\n\n* The **Workspace Reservation** feature enabled by your organization through a Zoom Rooms license, Zoom Phone Common Area Phone license or Workspace Reservation 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 **Workspace Issue Reported** subscription enabled under the **Workspace** event.","operationId":"Workspace.issue_reportedWebhook","requestBody":{"description":"Webhook payload for the `workspace.issue_reported` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace.issue_reportedEvent"},"examples":{"default":{"summary":"Example workspace.issue_reported event","value":{"event":"workspace.issue_reported","event_ts":1779847200000,"payload":{"account_id":"VQYZ9ytmTbaXK9Zr2LvIrg","operator_id":"rZXNXVlVSTaSZDTJvLcBew","operator":"reporter@example.com","object":{"report_id":"8f0b7df8-4d4c-4e58-bf6d-2e9a5d0f8d11","workspace_id":"fqtckjhjhee89ruidvc2h6lc4g","workspace_name":"Desk A-101","location_path":"Test Floor 1, Testing Building 1, Campus 1, City1, State 1","category_name":"Facilities","issue_types":["Projector","Whiteboard"],"description":"Projector does not turn on.","file_ids":["file_abc123"]}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"zoomroom.deleted":{"post":{"tags":["Zoom Rooms"],"summary":"zoomroom.deleted","description":"\nThe **Zoom Room Deleted** event is triggered when a user deletes a [**Zoom Room**](https://support.zoom.us/hc/en-us/categories/200108436).\n\n## Prerequisites\n\n* The **Zoom Room** feature enabled by your organization through a [Zoom Rooms license](https://support.zoom.us/hc/en-us/articles/207483343#h_60837516-ccdd-448c-8874-5e82a4f8c906).\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 **Zoom Room Deleted** subscription enabled under the **Zoom Room** event.\n\n","operationId":"Zoomroom.deletedWebhook","requestBody":{"description":"Webhook payload for the `zoomroom.deleted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Zoomroom.deletedEvent"},"examples":{"default":{"summary":"Example zoomroom.deleted event","value":{"event":"zoomroom.deleted","event_ts":1626230691572,"payload":{"account_id":"G3NQs8u1Qni4Pc-qBPgsxg","object":{"id":"2muAb65FTZCGjj6ginHIbQ","room_name":"My Zoom Room"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"visitor_management.invitation_updated":{"post":{"tags":["Visitor Management"],"summary":"visitor_management.invitation_updated","description":"\nThe **Visitor Management Invitation Updated** event is triggered when the [invitation is updated](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0073629#mcetoc_1hi1ubsr1ff).\n\n## Prerequisites\n \n* The [**Visitor Management**](https://support.zoom.com/hc/en?id=zm_kb&sysparm_article=KB0057564) feature enabled by your organization.\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 **Visitor Management Invitation Updated** subscription enabled under the **Visitor Management** event.\n\n","operationId":"Visitor_management.invitation_updatedWebhook","requestBody":{"description":"Webhook payload for the `visitor_management.invitation_updated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Visitor_management.invitation_updatedEvent"},"examples":{"default":{"summary":"Example visitor_management.invitation_updated event","value":{"event":"visitor_management.invitation_updated","event_ts":"290112312321","payload":{"account_id":"ajdkd-qBPgsxg","operator":"admin@example.com","operator_id":"I7zp-pYbTl22Z29H796Ixg","object":{"invitation_id":"fqtckjhjhee89ruidvc2h6lc4g","visitor_email":"visitor@example.com","visitor_name":"visitor","start_time":1710153000000,"end_time":1710172799999,"invite_location_id":"wnFFoWRwTLeww81UuAeW4g","host_id":"I7zp-pYbTl22Z29H796Ixg","host_name":"admin","host_email":"admin@example.com"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"zoomroom.location_created":{"post":{"tags":["Zoom Rooms"],"summary":"zoomroom.location_created","description":"The **Zoom Rooms location has been created** event is triggered every time a new Zoom Room location is created in your account. Admins and account owners can add new Zoom Room Location to an account. The Location can be added using the [Add a Zoom Rooms Location API](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/addAZRLocation) or by adding the Zoom Room Location using the Zoom Web Portal itself.\n\n## Prerequisites\n\n* Have your organization enable the **Zoom Rooms** feature through a Zoom Rooms license, or Workspace Reservation feature enabled by your organization through a Zoom Rooms license, Zoom Phone Common Area Phone license or **Workspace Reservation** 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 **Zoom Rooms Location Created** subscription enabled under the **Zoom Rooms** event.","operationId":"Zoomroom.location_createdWebhook","requestBody":{"description":"Webhook payload for the `zoomroom.location_created` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Zoomroom.location_createdEvent"},"examples":{"default":{"summary":"Example zoomroom.location_created event","value":{"event":"zoomroom.location_created","event_ts":"290112312321","payload":{"account_id":"ajdkd-qBPgsxg","operator":"admin@example.com","operator_id":"I7zp-pYbTl22Z29H796Ixg","object":{"id":"fqtckjhjhee89ruidvc2h6lc4g","name":"My new Zoom Room Location","parent_location_id":"aldjflajsd-fasj","type":"floor"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"zoomroom.created":{"post":{"tags":["Zoom Rooms"],"summary":"zoomroom.created","description":"\nThe **Zoom Room Created** event is triggered when a user creates a [**Zoom Room**](https://support.zoom.us/hc/en-us/categories/200108436)\n\n## Prerequisites\n\n* The **Zoom Room** feature enabled by your organization through a [Zoom Rooms license](https://support.zoom.us/hc/en-us/articles/207483343#h_60837516-ccdd-448c-8874-5e82a4f8c906).\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 **Zoom Room Created** subscription enabled under the **Zoom Room** event.\n\n","operationId":"Zoomroom.createdWebhook","requestBody":{"description":"Webhook payload for the `zoomroom.created` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Zoomroom.createdEvent"},"examples":{"default":{"summary":"Example zoomroom.created event","value":{"event":"zoomroom.created","event_ts":1626230691572,"payload":{"account_id":"G3NQs8u1Qni4Pc-qBPgsxg","object":{"id":"2muAb65FTZCGjj6ginHIbQ","room_name":"My Zoom Room"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"workspace.created":{"post":{"tags":["Workspaces"],"summary":"workspace.created","description":"The **Workspace created** event is triggered every time a Workspace is created in your account. Admins and account owners can add new Workspaces to an account. The Workspace can be added using the [Create a Workspace API](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/createWorkspace) or by adding the Workspace using the Zoom Web Portal itself.\n\n## Prerequisites\n\n* The **Workspace Reservation** feature enabled by your organization through a Zoom Rooms license, Zoom Phone Common Area Phone license or Workspace Reservation 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 **Workspace Created** subscription enabled under the **Workspace** event.","operationId":"Workspace.createdWebhook","requestBody":{"description":"Webhook payload for the `workspace.created` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace.createdEvent"},"examples":{"default":{"summary":"Example workspace.created event","value":{"event":"workspace.created","event_ts":"290112312321","payload":{"account_id":"ajdkd-qBPgsxg","operator":"admin@example.com","operator_id":"I7zp-pYbTl22Z29H796Ixg","object":{"id":"fqtckjhjhee89ruidvc2h6lc4g","workspace_name":"My new workspace"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"workspace.updated":{"post":{"tags":["Workspaces"],"summary":"workspace.updated","description":"The **Workspace Updated** event is triggered every time a Workspace is updated in your account. Admins and account owners can update a Workspaces to an account. The Workspace can be updated using the [Update a Workspace API](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/updateWorkspace) or by updating the Workspace using the Zoom Web Portal itself.\n\n## Prerequisites\n\n* The **Workspace Reservation** feature enabled by your organization through a Zoom Rooms license, Zoom Phone Common Area Phone license or Workspace Reservation 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 **Workspace Updated** subscription enabled under the **Workspace** event.","operationId":"Workspace.updatedWebhook","requestBody":{"description":"Webhook payload for the `workspace.updated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace.updatedEvent"},"examples":{"default":{"summary":"Example workspace.updated event","value":{"event":"workspace.updated","event_ts":"290112312321","payload":{"account_id":"ajdkd-qBPgsxg","operator":"admin@example.com","operator_id":"I7zp-pYbTl22Z29H796Ixg","object":{"id":"fqtckjhjhee89ruidvc2h6lc4g","workspace_name":"My updated workspace"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"zoomroom.thirdparty_meeting_attempted":{"post":{"tags":["Zoom Rooms"],"summary":"zoomroom.thirdparty_meeting_attempted","description":"\nThe **Zoom Room third party meeting attempted** event triggers when a Zoom Room is invited or actively joins a third party meeting.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n* A valid **Event Notification Endpoint URL**.\n* Enable the **Zoom Room third party meeting attempted** subscription under the **Zoom Room** event.\n\n","operationId":"Zoomroom.thirdparty_meeting_attemptedWebhook","requestBody":{"description":"Webhook payload for the `zoomroom.thirdparty_meeting_attempted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Zoomroom.thirdparty_meeting_attemptedEvent"},"examples":{"default":{"summary":"Example zoomroom.thirdparty_meeting_attempted event","value":{"event":"zoomroom.thirdparty_meeting_attempted","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"room_id":"abcD3ojfdbjfg","join_time":"2022-07-27T16:56:34Z","meeting_source_type":"ZOOM","join_url":"url","sip_address":"sip address","third_party_meeting_id":"12121313123","passcode":"123"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"zoomroom.digital_signage_app_started":{"post":{"tags":["Zoom Rooms"],"summary":"zoomroom.digital_signage_app_started","description":"\nThe **[Zoom Room digital signage](https://support.zoom.us/hc/en-us/articles/360000030683-Zoom-Rooms-digital-signage) play started** event triggers when the digital signage starts playing or showing.\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 **Zoom Room digital signage app started** subscription enabled under the **Zoom Room** event.\n\n","operationId":"Zoomroom.digital_signage_app_startedWebhook","requestBody":{"description":"Webhook payload for the `zoomroom.digital_signage_app_started` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Zoomroom.digital_signage_app_startedEvent"},"examples":{"default":{"summary":"Example zoomroom.digital_signage_app_started event","value":{"event":"zoomroom.digital_signage_play_started","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"room_id":"abcD3ojfdbjfg","app_name":"My Zoom Room","app_id":"NiVvY1NWpE2nulNrhVjgU4jD0swziVrXBbaFZyC3u+o=","start_time":"2022-06-19T00:00:00Z","end_time":"2022-06-19T01:01:00Z"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}}},"components":{"schemas":{"Visitor_management.checked_outEvent":{"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 host user account ID."},"operator":{"type":"string","description":"The email address of the host.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the host."},"object":{"required":["end_time","host_email","host_id","host_name","invite_location_id","start_time","visitor_email","visitor_name"],"type":"object","properties":{"visitor_email":{"type":"string","description":"The email address of the invited visitor."},"visitor_name":{"type":"string","description":"The name of the invited visitor."},"start_time":{"type":"long","description":"The epoch timestamp representing the start time of the invitation."},"end_time":{"type":"long","description":"The epoch timestamp representing end time of the invitation."},"invite_location_id":{"type":"string","description":"The location ID of the location to which the visitor is invited to."},"host_id":{"type":"string","description":"The user ID of the invitation host."},"host_name":{"type":"string","description":"The name of the invitation host."},"host_email":{"type":"string","description":"The email address of the invitation host."}},"description":"Information about the checked out invitation."}}}}},"Workspace.user_unassignedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"string","description":"A timestamp when the event occurred.","format":"date-time"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The workspace account ID."},"operator":{"type":"string","description":"The email address of the user that updated the assignment.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that updated the assignment."},"object":{"required":["account_id","assign_type","user_id","workspace_id","workspace_name"],"type":"object","properties":{"workspace_id":{"type":"string","description":"The workspace's ID."},"workspace_name":{"type":"string","description":"The workspace's name."},"account_id":{"type":"string","description":"The belong's account id of assigned user."},"user_id":{"type":"string","description":"The id of assigned user."},"assign_type":{"type":"string","description":"The type of assign before unassign. ","enum":["permanent"]}},"description":"Information about the user unassigned when unassign a user from a workspace."}}}}},"Workspace.reservation_questionnaire_response_createdEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"string","description":"A timestamp when the event occurred.","format":"date-time"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The workspace account ID."},"operator":{"type":"string","description":"The email address of the user that completed the questionnaire.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that completed the questionnaire."},"object":{"required":["desk_id","event_id","location_id","questionnaire_response","start_time","user_name","workspace_name"],"type":"object","properties":{"start_time":{"type":"string","description":"The start time of the workspace reservation.","format":"date-time"},"event_id":{"type":"string","description":"The event ID."},"user_name":{"type":"string","description":"The user name."},"desk_id":{"type":"string","description":"The desk ID."},"workspace_name":{"type":"string","description":"The name of the workspace."},"location_id":{"type":"string","description":"The location ID."},"questionnaire_response":{"type":"array","description":"List of questionnaires.","items":{"required":["id","list","subject","title"],"type":"object","properties":{"id":{"type":"string","description":"The view ID."},"title":{"type":"string","description":"The title of the questionnaire."},"subject":{"type":"string","description":"The subject of the questionnaire."},"list":{"type":"array","description":"List of questions in the questionnaire.","items":{"required":["options","question_id","reply_id","title","type"],"type":"object","properties":{"question_id":{"type":"string","description":"The question ID."},"title":{"type":"string","description":"The title of the question."},"type":{"type":"string","description":"The type of the question (single-choice, multiple-choice, open-text)."},"reply_id":{"type":"string","description":"The reply ID."},"options":{"type":"array","description":"List of options for multiple-choice questions.","items":{"required":["option_id","text"],"type":"object","properties":{"option_id":{"type":"string","description":"The option ID."},"text":{"type":"string","description":"The text of the option."}}}}}}}}}}},"description":"Information about the questionnaire when creating a reservation for a workspace."}}}}},"Zoomroom.sensor_dataEvent":{"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 Zoom Room account ID."},"object":{"required":["device_id","id","room_name","sensor_data"],"type":"object","properties":{"id":{"type":"string","description":"The Zoom Room ID."},"room_name":{"type":"string","description":"The Zoom Room name."},"device_id":{"type":"string","description":"The device ID."},"sensor_data":{"type":"array","description":"Information about the sensor data.","items":{"required":["date_time","sensor_type","sensor_value"],"type":"object","properties":{"date_time":{"type":"string","description":"The time when the sensor data was reported.","format":"datetime","example":"2022-06-19T00:00:00Z"},"sensor_type":{"type":"string","description":"The sensor type.","enum":["CO2","TEMPERATURE","REAL_TIME_PEOPLE_COUNT","HUMIDITY","VOC","AQI","PM25","PM10","AIR_PRESSURE"]},"sensor_value":{"type":"string","description":"The sensor value."}}}}},"additionalProperties":false,"description":"Information about the Zoom Room."}},"additionalProperties":false}},"additionalProperties":false},"Visitor_management.invitation_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 user account ID."},"operator":{"type":"string","description":"The email address of the user that deleted the invitation.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that deleted the invitation."},"object":{"required":["host_email","host_id","host_name","invite_location_id","visitor_email","visitor_name"],"type":"object","properties":{"visitor_email":{"type":"string","description":"The email address of the invited visitor."},"visitor_name":{"type":"string","description":"The name of the invited visitor."},"invite_location_id":{"type":"string","description":"The location ID of the location to which the visitor is invited to."},"host_id":{"type":"string","description":"The user ID of the invitation host."},"host_name":{"type":"string","description":"The name of the invitation host."},"host_email":{"type":"string","description":"The email address of the invitation host."}},"description":"Information about the deleted invitation."}}}}},"Zoomroom.alertEvent":{"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 Zoom Room account ID."},"object":{"required":["alert_kind","alert_time","alert_type","calendar_name","component","email","id","issue","room_name"],"type":"object","properties":{"id":{"type":"string","description":"The Zoom Room's unique ID."},"room_name":{"type":"string","description":"The Zoom Room's name."},"calendar_name":{"type":"string","description":"The calendar's name."},"email":{"type":"string","description":"The Zoom Room's associated email address.","format":"email"},"issue":{"type":"string","description":"The issues that occurred during the meeting: \n* `Room Controller disconnected` \n* `Room Controller connected` \n* `Selected camera has disconnected` \n* `Selected camera is reconnected` \n* `Selected microphone has disconnected` \n* `Selected microphone is reconnected` \n* `Selected speaker has disconnected` \n* `Selected speaker is reconnected` \n* `Zoom room is offline` \n* `Zoom room is online` \n* `High CPU usage is detected` \n* `Low bandwidth network is detected` \n* `{name} battery is low` \n* `{name} battery is normal` \n* `{name} disconnected` \n* `{name} connected` \n `Incorrect Room Passcode Entry Detected` \n\nThe possible values for `{name}` are: \n* Zoom Rooms Computer \n* Controller \n* Scheduling Display \n*."},"alert_type":{"type":"integer","description":"The type of alert sent: \n* `1` — The controller or scheduling display disconnected. \n* `2` — The selected microphone, speaker, or camera has disconnected \n* `3` — The Zoom Room is offline. \n* `4` — High CPU usage detected. \n* `5` — Low network bandwidth detected. \n* `6` — The controller or scheduling display battery is low. \n* `7` — The Zoom Rooms display is disconnected. \n* `8` — The audio device has quality issues \n* `9` — Failed SIP registration \n* `10` — Incorrect room passcode entry detected \n* `0` — Other alert.","enum":[1,2,3,4,5,6,7,8,9,10,0]},"component":{"type":"integer","description":"The affected component: \n* `1` — Zoom Rooms Computer \n* `2` — Controller \n* `3` — Scheduling Display \n* `4` — Microphone \n* `5` — Camera \n* `6` — Speaker \n* `0` - Other.","enum":[1,2,3,4,5,6,0]},"alert_time":{"type":"integer","description":"The timestamp when the alert occurred.","format":"int64"},"alert_kind":{"type":"integer","description":"The kind of alert: \n* `1` — Triggered. There was an encountered problem. When the problem is resolved, a follow-up response will contain this field with the `2` (Cleared) value. \n* `2` — Cleared. The problem is resolved. \n* `3` — Observed. There is a potential issue-causing condition. If the issue is cleared (`2`), there will **not** be a follow-up response. \n* `4` - Other`.","enum":[1,2,3,4]}},"additionalProperties":false,"description":"Information about the Zoom Room."}},"additionalProperties":false}},"additionalProperties":false},"Workspace.reservation_questionnaire_response_updatedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"string","description":"A timestamp when the event occurred.","format":"date-time"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The workspace account ID."},"operator":{"type":"string","description":"The email address of the user that completed the questionnaire.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that completed the questionnaire."},"object":{"required":["desk_id","event_id","location_id","questionnaire_response","start_time","user_name","workspace_name"],"type":"object","properties":{"start_time":{"type":"string","description":"The start time of the workspace reservation.","format":"date-time"},"event_id":{"type":"string","description":"The event ID."},"user_name":{"type":"string","description":"The user name."},"desk_id":{"type":"string","description":"The desk ID."},"workspace_name":{"type":"string","description":"The name of the workspace."},"location_id":{"type":"string","description":"The location ID."},"questionnaire_response":{"type":"array","description":"List of questionnaires.","items":{"required":["id","list","subject","title"],"type":"object","properties":{"id":{"type":"string","description":"The view ID."},"title":{"type":"string","description":"The title of the questionnaire."},"subject":{"type":"string","description":"The subject of the questionnaire."},"list":{"type":"array","description":"List of questions in the questionnaire.","items":{"required":["options","question_id","reply_id","title","type"],"type":"object","properties":{"question_id":{"type":"string","description":"The question ID."},"title":{"type":"string","description":"The title of the question."},"type":{"type":"string","description":"The type of the question (single-choice, multiple-choice, open-text)."},"reply_id":{"type":"string","description":"The reply ID."},"options":{"type":"array","description":"List of options for multiple-choice questions.","items":{"required":["option_id","text"],"type":"object","properties":{"option_id":{"type":"string","description":"The option ID."},"text":{"type":"string","description":"The text of the option."}}}}}}}}}}},"description":"Information about the questionnaire when creating a reservation for a workspace."}}}}},"Workspace.reservation_updateEvent":{"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 workspace account ID."},"operator":{"type":"string","description":"The email address of the user that updated the reservation.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that updated the reservation."},"object":{"required":["end_time","id","start_time","topic","workspace_id"],"type":"object","properties":{"id":{"type":"string","description":"The reservation ID."},"workspace_id":{"type":"string","description":"The workspace ID."},"end_time":{"type":"string","description":"The reservation's end time.","format":"date-time"},"start_time":{"type":"string","description":"The reservation's start time.","format":"date-time"},"topic":{"type":"string","description":"The reservation's description."},"reserve_for":{"type":"string","description":"The ID of the user for whom to create a workspace reservation.","example":"KDcuGIm1QgePTO8WbOqwIQ"}},"additionalProperties":false,"description":"Information about the workspace reservation."}},"additionalProperties":false}},"additionalProperties":false},"Workspace.user_assignedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"string","description":"A timestamp when the event occurred.","format":"date-time"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The workspace account ID."},"operator":{"type":"string","description":"The email address of the user that updated the assignment.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that updated the assignment."},"object":{"required":["account_id","assign_type","user_email","user_id","workspace_id","workspace_name"],"type":"object","properties":{"workspace_id":{"type":"string","description":"The workspace's ID."},"workspace_name":{"type":"string","description":"The workspace's name."},"assign_type":{"type":"string","description":"The type of assignment. ","enum":["permanent"]},"account_id":{"type":"string","description":"The belong's account id of assigned user."},"user_id":{"type":"string","description":"The id of assigned user."},"user_email":{"type":"string","description":"The email of assigned user."}},"description":"Information about the assignment when updating assignment of a workspace."}}}}},"Zoomroom.digital_signage_app_endedEvent":{"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 Zoom Room account ID."},"object":{"required":["app_id","app_name","end_time","room_id","start_time"],"type":"object","properties":{"room_id":{"type":"string","description":"The Zoom Room ID."},"app_name":{"type":"string","description":"The app name."},"app_id":{"type":"string","description":"The app ID."},"start_time":{"type":"string","description":"The playback start time of the digital signage.","format":"datetime","example":"2022-06-19T00:00:00Z"},"end_time":{"type":"string","description":"The playback end time of the digital signage.","format":"datetime","example":"2022-06-19T00:00:00Z"}},"additionalProperties":false,"description":"The information on the digital signage played in a Zoom Room."}},"additionalProperties":false}},"additionalProperties":false},"Zoomroom.checked_inEvent":{"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 Zoom Room account ID."},"object":{"required":["api_type","calendar_id","calendar_name","calendar_type","change_key","email","event_id","id","resource_email","room_name"],"type":"object","properties":{"id":{"type":"string","description":"The Zoom Room's unique ID."},"room_name":{"type":"string","description":"The Zoom Room's name."},"calendar_name":{"type":"string","description":"The calendar's name."},"email":{"type":"string","description":"The Zoom Room's associated email address.","format":"email"},"event_id":{"type":"string","description":"The unique ID of the Zoom Room's associated calendar event:\n\n* For Microsoft Exchange calendar integration, use Microsoft's [`FindItem` operation](https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/finditem-operation). The `event_id` value is the `Id` value in the `ItemId` element of the `FindItem` operation's response. \n* For Google Calendar integration, use Google's [`Events: list` API](https://developers.google.com/calendar/api/v3/reference/events/list). The `event_id` value is the `id` field in the [events resource](https://developers.google.com/calendar/api/v3/reference/events#resource)."},"change_key":{"type":"string","description":"The specific version of the calendar item. You can get this value using Microsoft's [`FindItem` operation](https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/finditem-operation). Refer to the `ChangeKey` field of the `ItemId` element in the operation's response.\n\nThis field is only returned for Microsoft Exchange or Office 365 calendars."},"resource_email":{"type":"string","description":"The calendar's associated [resource mailbox](https://support.microsoft.com/en-us/help/10063/creating-and-managing-resource-mailboxes-in-office-365).\n\nThis field is only returned for Microsoft Exchange or Office 365 calendars."},"calendar_id":{"type":"string","description":"The calendar's unique ID."},"calendar_type":{"type":"string","description":"The calendar's type: \n* `0` — Google Calendar. \n* `1` — Office 365 Calendar. \n* `2` — Microsoft Exchange Calendar.","enum":["0","1","2"]},"api_type":{"type":"string","description":"The API type: \n* `0` — [Exchange Web Services (EWS) API](https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/ews-managed-api-reference-for-exchange) \n* `1` — [Microsoft Graph API](https://docs.microsoft.com/en-us/azure/active-directory/develop/microsoft-graph-intro) \n* An empty string — The API returns this value when the `calendar_type` value is `0` (Google Calendar).","enum":["0","1",""]}},"additionalProperties":false,"description":"Information about the Zoom Room."}},"additionalProperties":false}},"additionalProperties":false},"Workspace.reservation_checked_inEvent":{"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 workspace account ID."},"operator":{"type":"string","description":"The email address of the user that checked in the reservation.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that checked in the reservation."},"object":{"required":["end_time","id","start_time","topic","workspace_id"],"type":"object","properties":{"id":{"type":"string","description":"The reservation ID."},"workspace_id":{"type":"string","description":"The workspace ID."},"end_time":{"type":"string","description":"The reservation's end time.","format":"date-time"},"start_time":{"type":"string","description":"The reservation's start time.","format":"date-time"},"topic":{"type":"string","description":"The reservation's description."},"reserve_for":{"type":"string","description":"The ID of the user for whom to create a workspace reservation.","example":"KDcuGIm1QgePTO8WbOqwIQ"}},"additionalProperties":false,"description":"Information about the workspace reservation."}},"additionalProperties":false}},"additionalProperties":false},"Zoomroom.updatedEvent":{"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 Zoom Room account ID."},"object":{"required":["id","room_name"],"type":"object","properties":{"id":{"type":"string","description":"The Zoom Room's unique ID."},"room_name":{"type":"string","description":"The Zoom Room's name."}},"additionalProperties":false,"description":"Information about the Zoom Room."}},"additionalProperties":false}},"additionalProperties":false},"Zoomroom.location_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","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who updated the Zoom Rooms Location."},"operator":{"type":"string","description":"The email address of the user that updated the Zoom Rooms Location.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that updated the Zoom Rooms Location."},"object":{"required":["id","name","parent_location_id","type"],"type":"object","properties":{"id":{"type":"string","description":"The Zoom Rooms location's ID."},"name":{"type":"string","description":"The name of the updated Zoom Rooms location."},"parent_location_id":{"type":"string","description":"This location's parent Zoom Rooms location ID."},"type":{"type":"enum, country┃states┃city┃campus┃building┃floor","description":"The type of location."}},"description":"Information about the updated Location."}}}}},"Workspace.pre_check_in_questionnaire_response_createdEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"string","description":"A timestamp when the event occurred.","format":"date-time"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The workspace account ID."},"operator":{"type":"string","description":"The email address of the user that completed the questionnaire.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that completed the questionnaire."},"object":{"required":["desk_id","event_id","location_id","questionnaire_response","start_time","user_name","workspace_name"],"type":"object","properties":{"start_time":{"type":"string","description":"The start time of the workspace reservation.","format":"date-time"},"event_id":{"type":"string","description":"The event ID."},"user_name":{"type":"string","description":"The user name."},"desk_id":{"type":"string","description":"The desk ID."},"workspace_name":{"type":"string","description":"The name of the workspace."},"location_id":{"type":"string","description":"The location ID."},"questionnaire_response":{"type":"array","description":"List of questionnaires.","items":{"required":["id","list","subject","title"],"type":"object","properties":{"id":{"type":"string","description":"The view ID."},"title":{"type":"string","description":"The title of the questionnaire."},"subject":{"type":"string","description":"The subject of the questionnaire."},"list":{"type":"array","description":"List of questions in the questionnaire.","items":{"required":["options","question_id","reply_id","title","type"],"type":"object","properties":{"question_id":{"type":"string","description":"The question ID."},"title":{"type":"string","description":"The title of the question."},"type":{"type":"string","description":"The type of the question (single-choice, multiple-choice, open-text)."},"reply_id":{"type":"string","description":"The reply ID."},"options":{"type":"array","description":"List of options for multiple-choice questions.","items":{"required":["option_id","text"],"type":"object","properties":{"option_id":{"type":"string","description":"The option ID."},"text":{"type":"string","description":"The text of the option."}}}}}}}}}}},"description":"Information about the questionnaire when creating a reservation for a workspace."}}}}},"Workspace.reservation_checked_outEvent":{"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 workspace account ID."},"operator":{"type":"string","description":"The email address of the user that checked out the reservation.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that checked out the reservation."},"object":{"required":["end_time","id","start_time","topic","workspace_id"],"type":"object","properties":{"id":{"type":"string","description":"The reservation ID."},"workspace_id":{"type":"string","description":"The workspace ID."},"end_time":{"type":"string","description":"The reservation's end time.","format":"date-time"},"start_time":{"type":"string","description":"The reservation's start time.","format":"date-time"},"topic":{"type":"string","description":"The reservation's description."},"reserve_for":{"type":"string","description":"The ID of the user for whom to create a workspace reservation.","example":"KDcuGIm1QgePTO8WbOqwIQ"}},"additionalProperties":false,"description":"Information about the workspace reservation."}},"additionalProperties":false}},"additionalProperties":false},"Visitor_management.checked_inEvent":{"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 host user account ID."},"operator":{"type":"string","description":"The email address of the host.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the host."},"object":{"required":["end_time","host_email","host_id","host_name","invite_location_id","start_time","visitor_email","visitor_name"],"type":"object","properties":{"visitor_email":{"type":"string","description":"The email address of the invited visitor."},"visitor_name":{"type":"string","description":"The name of the invited visitor."},"start_time":{"type":"long","description":"The epoch timestamp representing the start time of the invitation."},"end_time":{"type":"long","description":"The epoch timestamp representing end time of the invitation."},"invite_location_id":{"type":"string","description":"The location ID of the location to which the visitor is invited to."},"host_id":{"type":"string","description":"The user ID of the invitation host."},"host_name":{"type":"string","description":"The name of the invitation host."},"host_email":{"type":"string","description":"The email address of the invitation host."}},"description":"Information about the checked in invitation."}}}}},"Workspace.reservation_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 workspace account ID."},"operator":{"type":"string","description":"The email address of the user that deleted the reservation.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that deleted the reservation."},"object":{"required":["end_time","id","start_time","topic","workspace_id"],"type":"object","properties":{"id":{"type":"string","description":"The reservation ID."},"workspace_id":{"type":"string","description":"The workspace ID."},"end_time":{"type":"string","description":"The reservation's end time.","format":"date-time"},"start_time":{"type":"string","description":"The reservation's start time.","format":"date-time"},"topic":{"type":"string","description":"The reservation's description."},"reserve_for":{"type":"string","description":"The ID of the user for whom to create a workspace reservation.","example":"KDcuGIm1QgePTO8WbOqwIQ"}},"additionalProperties":false,"description":"Information about the workspace reservation."}},"additionalProperties":false}},"additionalProperties":false},"Visitor_management.invitation_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 user account ID."},"operator":{"type":"string","description":"The email address of the user that created the invitation.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that created the invitation."},"object":{"required":["end_time","host_email","host_id","host_name","invitation_id","invite_location_id","start_time","visitor_email","visitor_name"],"type":"object","properties":{"invitation_id":{"type":"string","description":"The invitation ID."},"visitor_email":{"type":"string","description":"The email address of the invited visitor."},"visitor_name":{"type":"string","description":"The name of the invited visitor."},"start_time":{"type":"long","description":"The epoch timestamp representing the start time of the invitation."},"end_time":{"type":"long","description":"The epoch timestamp representing end time of the invitation."},"invite_location_id":{"type":"string","description":"The location ID of the location to which the visitor is invited to."},"host_id":{"type":"string","description":"The user ID of the invitation host."},"host_name":{"type":"string","description":"The name of the invitation host."},"host_email":{"type":"string","description":"The email address of the invitation host."}},"description":"Information about the created invitation."}}}}},"Zoomroom.location_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 deleted the Zoom Rooms location."},"operator":{"type":"string","description":"The email address of the user that deleted the Zoom Rooms location.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that deleted the Zoom Rooms location."},"object":{"required":["id","name","parent_location_id","type"],"type":"object","properties":{"id":{"type":"string","description":"The Zoom Rooms location's ID."},"name":{"type":"string","description":"The name of the deleted Zoom Rooms location."},"parent_location_id":{"type":"string","description":"This location's parent Zoom Rooms location ID."},"type":{"type":"enum, country┃states┃city┃campus┃building┃floor","description":"The location type."}},"description":"Information about the deleted location."}}}}},"Workspace.reservation_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 workspace account ID."},"operator":{"type":"string","description":"The email address of the user that created the reservation.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that created the reservation."},"object":{"required":["end_time","id","start_time","topic","workspace_id"],"type":"object","properties":{"id":{"type":"string","description":"The reservation ID."},"workspace_id":{"type":"string","description":"The workspace ID."},"end_time":{"type":"string","description":"The reservation's end time.","format":"date-time"},"start_time":{"type":"string","description":"The reservation's start time.","format":"date-time"},"topic":{"type":"string","description":"The reservation's description."},"reserve_for":{"type":"string","description":"The ID of the user for whom to create a workspace reservation."},"assignment_checkin":{"type":"boolean","description":"Whether the assigned workspace is checked in."}},"additionalProperties":false,"description":"Information about the workspace reservation."}},"additionalProperties":false}},"additionalProperties":false},"Zoomroom.checked_outEvent":{"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 Zoom Room account ID."},"object":{"required":["api_type","calendar_id","calendar_name","calendar_type","change_key","email","event_id","id","resource_email","room_name"],"type":"object","properties":{"id":{"type":"string","description":"The Zoom Room's unique ID."},"room_name":{"type":"string","description":"The Zoom Room's name."},"calendar_name":{"type":"string","description":"The calendar's name."},"email":{"type":"string","description":"The Zoom Room's associated email address.","format":"email"},"event_id":{"type":"string","description":"The unique ID of the Zoom Room's associated calendar event:\n\n* For Microsoft Exchange calendar integration, use Microsoft's [`FindItem` operation](https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/finditem-operation). The `event_id` value is the `Id` value in the `ItemId` element of the `FindItem` operation's response. \n* For Google Calendar integration, use Google's [`Events: list` API](https://developers.google.com/calendar/api/v3/reference/events/list). The `event_id` value is the `id` field in the [events resource](https://developers.google.com/calendar/api/v3/reference/events#resource)."},"change_key":{"type":"string","description":"The specific version of the calendar item. You can get this value using Microsoft's [`FindItem` operation](https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/finditem-operation). Refer to the `ChangeKey` field of the `ItemId` element in the operation's response.\n\nThis field is only returned for Microsoft Exchange or Office 365 calendars."},"resource_email":{"type":"string","description":"The calendar's associated [resource mailbox](https://support.microsoft.com/en-us/help/10063/creating-and-managing-resource-mailboxes-in-office-365).\n\nThis field is only returned for Microsoft Exchange or Office 365 calendars."},"calendar_id":{"type":"string","description":"The calendar's unique ID."},"calendar_type":{"type":"string","description":"The calendar's type: \n* `0` — Google Calendar. \n* `1` — Office 365 Calendar. \n* `2` — Microsoft Exchange Calendar.","enum":["0","1","2"]},"api_type":{"type":"string","description":"The API type: \n* `0` — [Exchange Web Services (EWS) API](https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/ews-managed-api-reference-for-exchange) \n* `1` — [Microsoft Graph API](https://docs.microsoft.com/en-us/azure/active-directory/develop/microsoft-graph-intro) \n* An empty string — The API returns this value when the `calendar_type` value is `0` (Google Calendar).","enum":["0","1",""]}},"additionalProperties":false,"description":"Information about the Zoom Room."}},"additionalProperties":false}},"additionalProperties":false},"Zoomroom.delayed_alertEvent":{"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 Zoom Room account ID."},"object":{"required":["alert_kind","alert_time","alert_type","calendar_name","component","email","id","issue","room_name"],"type":"object","properties":{"id":{"type":"string","description":"The Zoom Room's unique ID."},"room_name":{"type":"string","description":"The Zoom Room's name."},"calendar_name":{"type":"string","description":"The calendar's name."},"email":{"type":"string","description":"The Zoom Room's associated email address.","format":"email"},"issue":{"type":"string","description":"The issues that occurred during the meeting: \n* `Room controller is disconnected.` \n* `Room controller connected.` \n* `Selected camera is disconnected.` \n* `Selected camera is reconnected.` \n* `Selected microphone is disconnected.` \n* `Selected microphone is reconnected.` \n* `Selected speaker is disconnected.` \n* `Selected speaker is reconnected.` \n* `Zoom room is offline.` \n* `Zoom room is online.` \n* `High CPU usage detected.` \n* `Low bandwidth network is detected.` \n* `{name} battery is low.` \n* `{name} battery is normal.` \n* `{name} disconnected.` \n* `{name} is connected.`\n* `Incorrect Room Passcode Entry Detected.` \n* `The possible values for `{name}` are:` \n* `Zoom Rooms Computer.` \n* `Controller.` \n* `Scheduling Display.` \n*"},"alert_type":{"type":"integer","description":"The type of alert sent: \n* `1` — The controller or scheduling display disconnected. \n* `2` — The selected microphone, speaker, or camera has disconnected. \n* `3` — The Zoom Room is offline. \n* `4` — High CPU usage detected. \n* `5` — Low network bandwidth detected. \n* `6` — The controller or scheduling display battery is low. \n* `7` — The Zoom Rooms display is disconnected. \n* `8` — The audio device has quality issues. \n* `9` — Failed SIP registration.\n* `10` — Incorrect room passcode entry detected.\n* `0` — Other alert.","enum":[1,2,3,4,5,6,7,8,9,10,0]},"component":{"type":"integer","description":"The affected component: \n* `1` — Zoom Rooms computer \n* `2` — Controller \n* `3` — Scheduling display \n* `4` — Microphone \n* `5` — Camera \n* `6` — Speaker \n* `0` — Other","enum":[1,2,3,4,5,6,0]},"alert_time":{"type":"integer","description":"The timestamp when the alert occurred.","format":"int64"},"alert_kind":{"type":"integer","description":"The kind of alert: \n* `1` — Triggered. There was an encountered problem. When the problem is resolved, a follow-up response will contain this field with the `2` (Cleared) value. \n* `2` — Cleared. The problem is resolved. \n* `3` — Observed. There is a potential issue-causing condition. If the issue is cleared (`2`), there will **not** be a follow-up response. \n* `4` — Other.","enum":[1,2,3,4]}},"additionalProperties":false,"description":"Information about the Zoom Room."}},"additionalProperties":false}},"additionalProperties":false},"Workspace.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 deleted the Workspace."},"operator":{"type":"string","description":"The email address of the user who deleted the Workspace.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that deleted the Workspace."},"object":{"required":["id","workspace_name"],"type":"object","properties":{"id":{"type":"string","description":"The Workspace ID."},"workspace_name":{"type":"string","description":"The name of the Workspace."}},"description":"Information about the deleted Workspace."}}}}},"Workspace.issue_reportedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event.","enum":["workspace.issue_reported"]},"event_ts":{"type":"integer","description":"The 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 workspace account ID."},"operator":{"type":"string","description":"The email address of the user who reported the issue.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who reported the issue."},"object":{"required":["category_name","issue_types","location_path","report_id","workspace_id","workspace_name"],"type":"object","properties":{"report_id":{"type":"string","description":"The unique ID of the issue report."},"workspace_id":{"type":"string","description":"The workspace's ID."},"workspace_name":{"type":"string","description":"The workspace's name."},"location_path":{"type":"string","description":"The location path of the workspace."},"category_name":{"type":"string","description":"The selected issue category name."},"issue_types":{"type":"array","description":"The selected issue types under the category.","items":{"type":"string"}},"description":{"type":"string","description":"The description entered by the reporting user. This field may be omitted when no description is provided."},"file_ids":{"type":"array","description":"The uploaded file IDs attached to the issue report. This field may be omitted when no files are attached.","items":{"type":"string"}}},"description":"Information about the reported workspace issue."}}}}},"Zoomroom.deletedEvent":{"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 Zoom Room account ID."},"object":{"required":["id","room_name"],"type":"object","properties":{"id":{"type":"string","description":"The Zoom Room's unique ID."},"room_name":{"type":"string","description":"The Zoom Room's name."}},"additionalProperties":false,"description":"Information about the Zoom Room."}},"additionalProperties":false}},"additionalProperties":false},"Visitor_management.invitation_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","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The user account ID."},"operator":{"type":"string","description":"The email address of the user that updated the invitation.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that updated the invitation."},"object":{"required":["end_time","host_email","host_id","host_name","invitation_id","invite_location_id","start_time","visitor_email","visitor_name"],"type":"object","properties":{"invitation_id":{"type":"string","description":"The invitation ID."},"visitor_email":{"type":"string","description":"The email address of the invited visitor."},"visitor_name":{"type":"string","description":"The name of the invited visitor."},"start_time":{"type":"long","description":"The epoch timestamp representing the start time of the invitation."},"end_time":{"type":"long","description":"The epoch timestamp representing end time of the invitation."},"invite_location_id":{"type":"string","description":"The location ID of the location to which the visitor is invited to."},"host_id":{"type":"string","description":"The user ID of the invitation host."},"host_name":{"type":"string","description":"The name of the invitation host."},"host_email":{"type":"string","description":"The email address of the invitation host."}},"description":"Information about the updated invitation."}}}}},"Zoomroom.location_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 new Zoom Rooms location."},"operator":{"type":"string","description":"The email address of the user that created the new Zoom Rooms location.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that created the new Zoom Rooms location."},"object":{"required":["id","name","parent_location_id","type"],"type":"object","properties":{"id":{"type":"string","description":"The Zoom Rooms location's ID."},"name":{"type":"string","description":"The name of the new Zoom Rooms location."},"parent_location_id":{"type":"string","description":"This location's parent Zoom Rooms location ID."},"type":{"type":"enum, country┃states┃city┃campus┃building┃floor","description":"The location's type."}},"description":"Information about the created location."}}}}},"Zoomroom.createdEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"The timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Zoom Room account ID."},"object":{"required":["id","room_name"],"type":"object","properties":{"id":{"type":"string","description":"The Zoom Room's unique ID."},"room_name":{"type":"string","description":"The Zoom Room's name."}},"additionalProperties":false,"description":"Information about the Zoom Room."}},"additionalProperties":false}},"additionalProperties":false},"Workspace.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 workspace account ID."},"operator":{"type":"string","description":"The email address of the user that created the workspace.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that created the workspace."},"object":{"required":["id","workspace_name"],"type":"object","properties":{"id":{"type":"string","description":"The Workspace ID."},"workspace_name":{"type":"string","description":"The name of the workspace"}},"description":"Information about the created workspace."}}}}},"Workspace.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","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The Workspace account ID."},"operator":{"type":"string","description":"The email address of the user that updated the Workspace.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user that updated the Workspace."},"object":{"required":["id","workspace_name"],"type":"object","properties":{"id":{"type":"string","description":"The Workspace ID."},"workspace_name":{"type":"string","description":"The name of the Workspace"}},"description":"Information about the updated Workspace."}}}}},"Zoomroom.thirdparty_meeting_attemptedEvent":{"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 Zoom Room account ID."},"object":{"required":["room_id"],"type":"object","properties":{"room_id":{"type":"string","description":"The Zoom Room ID."},"join_url":{"type":"string","description":"The URL for joining a meeting."},"meeting_source_type":{"type":"string","description":"The meeting type.","enum":["MS_TEAMS","GOOGLE_MEET","WEBEX","BLUEJEANS","FUZE","UNKNOWN"]},"join_time":{"type":"string","description":"The time to execute the command to join a meeting.","format":"datetime","example":"2022-06-19T00:00:00Z"},"sip_address":{"type":"string","description":"The full SIP address to join the third-party meeting."},"third_party_meeting_id":{"type":"string","description":"The of the third-party meeting's meeting ID."},"passcode":{"type":"string","description":"The passcode for joining a third-party meeting."}},"additionalProperties":false,"description":"A Zoom Room is about to join a meeting."}},"additionalProperties":false}},"additionalProperties":false},"Zoomroom.digital_signage_app_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 Zoom Room account ID."},"object":{"required":["app_id","app_name","room_id","start_time"],"type":"object","properties":{"room_id":{"type":"string","description":"The Zoom Room ID."},"app_name":{"type":"string","description":"The app name."},"app_id":{"type":"string","description":"The app ID."},"start_time":{"type":"string","description":"The playback start time of the digital signage.","format":"datetime","example":"2022-06-19T00:00:00Z"}},"additionalProperties":false,"description":"The information on the digital signage played in a Zoom Room."}},"additionalProperties":false}},"additionalProperties":false}}},"tags":[{"name":"Visitor Management"},{"name":"Workspaces"},{"name":"Zoom Rooms"}],"servers":[{"url":"https://{your-endpoint-url}"}]}