{"openapi":"3.0.0","info":{"title":"Whiteboard Webhooks","description":"The Zoom Whiteboard webhooks allow developers to receive events for [Zoom Whiteboard](https://developers.zoom.us/docs/zoom-whiteboard/) features.","version":"1.0.0"},"paths":{"whiteboard.shared":{"post":{"tags":["webhook"],"summary":"whiteboard.shared","description":"\nThe **Whiteboard was shared** event is triggered every time a whiteboard is shared with a Zoom user or a team chat channel by one of your whiteboard collaborators.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Whiteboard was shared** subscription enabled under the **Whiteboard** event.\n\n","operationId":"Whiteboard.sharedWebhook","requestBody":{"description":"Webhook payload for the `whiteboard.shared` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Whiteboard.sharedEvent"},"examples":{"default":{"summary":"Example whiteboard.shared event","value":{"event":"whiteboard.shared","event_ts":1626230691572,"payload":{"operator_id":"z8yCxjabcdEFGHfp8uQ","operator_collaborator_id":"Cvftg6789087654443lkhk","object":{"whiteboard_id":"X4Hy02w3QUOdskKofgb9Jg","meeting_id":"1234567890","meeting_ uuid":"4444AAAiAAAAAiAiAiiAii==","collaborators":[{"collaborator_id":"x4g6hy789k0o878k","collaborator_name":"Jack","email":"user@example.com","user_id":"er54t67y8ui9o0p0","collaborator_type":0,"role":3},{"collaborator_id":"x4g6hy789k0o878k","collaborator_name":"ext***@exa***.com","collaborator_type":1,"role":3},{"collaborator_id":"df4g6hy789k0o878k","channel_id":"example@conference.xmpp.zoom.us","collaborator_name":"Channel A","collaborator_type":2,"role":3}]}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"whiteboard.sharing_updated":{"post":{"tags":["webhook"],"summary":"whiteboard.sharing_updated","description":"\nThe **Whiteboard collaborator's sharing settings were updated** event is triggered every time the of a whiteboard collaborator is updated or removed by one of your whiteboard owners.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Whiteboard collaborator's sharing settings were updated** subscription enabled under the **Whiteboard** event.\n\n","operationId":"Whiteboard.sharing_updatedWebhook","requestBody":{"description":"Webhook payload for the `whiteboard.sharing_updated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Whiteboard.sharing_updatedEvent"},"examples":{"default":{"summary":"Example whiteboard.sharing_updated event","value":{"event":"whiteboard.sharing_updated","event_ts":1626230691572,"payload":{"operator_id":"z8yCxjabcdEFGHfp8uQ","operation_type":1,"operator_collaborator_id":"Cvftg6789087654443lkhk","object":{"whiteboard_id":"X4Hy02w3QUOdskKofgb9Jg","collaborators":[{"collaborator_id":"as35hjnh89899fmkl0ou","collaborator_name":"Jack","user_id":"er54t67y8ui9o0p0","email":"user@example.com","collaborator_type":0,"role":2},{"collaborator_id":"x4g6hy789k0o878k","collaborator_name":"ext***@exa***.com","collaborator_type":1,"role":3},{"collaborator_id":"34g6hy789k0o878k","channel_id":"example@conference.xmpp.zoom.us","collaborator_name":"Channel A","collaborator_type":2,"role":2}]}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"whiteboard.share_settings_updated":{"post":{"tags":["webhook"],"summary":"whiteboard.share_settings_updated","description":"\nWhiteboard share settings can be updated by a whiteboard owner or co-owners.\n\nThe **Whiteboard's sharing setting were updated** event is triggered every time a whiteboard share setting is updated by whiteboard owner or co-owners.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Whiteboard's sharing setting were updated** subscription enabled under the **Whiteboard** event.\n\n","operationId":"Whiteboard.share_settings_updatedWebhook","requestBody":{"description":"Webhook payload for the `whiteboard.share_settings_updated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Whiteboard.share_settings_updatedEvent"},"examples":{"default":{"summary":"Example whiteboard.share_settings_updated event","value":{"event":"whiteboard.share_setting_updated","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"whiteboard_id":"BK0R3Lg-Toi92viKHhzUVQ","settings":{"share_link_setting":{"share_scope":0,"share_role":4},"advanced_share_setting":{"can_share":true,"share_to_external":true,"external_can_share":false}}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"whiteboard.archive_available":{"post":{"tags":["webhook"],"summary":"whiteboard.archive_available","description":"The **Whiteboard archive was available** event is emitted whenever a whiteboard archived sessions is successfully generated. This event can be used to notify subscribers when an archive is ready to be accessed.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Whiteboard archive was available** subscription enabled under the **Whiteboard** event.\n","operationId":"Whiteboard.archive_availableWebhook","requestBody":{"description":"Webhook payload for the `whiteboard.archive_available` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Whiteboard.archive_availableEvent"},"examples":{"default":{"summary":"Example whiteboard.archive_available event","value":{"event":"whiteboard.archive_available","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"session_id":"a2f19f96-9294-4f51-8134-6f0eea108eb2","start_time":"2021-03-11T05:41:36Z","end_time":"2021-03-11T05:41:36Z","whiteboard_id":"1234567890","whiteboard_name":"Q3 Plan","expire_time":"2021-03-26T06:41:36Z"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"whiteboard.opened":{"post":{"tags":["webhook"],"summary":"whiteboard.opened","description":"\nThe **Whiteboard was opened** event is triggered every time a whiteboard is opened.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Whiteboard was opened** subscription enabled under the **Whiteboard** event.\n\n","operationId":"Whiteboard.openedWebhook","requestBody":{"description":"Webhook payload for the `whiteboard.opened` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Whiteboard.openedEvent"},"examples":{"default":{"summary":"Example whiteboard.opened event","value":{"event":"whiteboard.opened","event_ts":1626230691572,"payload":{"operator_id":"z8yCxjabcdEFGHfp8uQ","operator_collaborator_id":"Cvftg6789087654443lkhk","object":{"whiteboard_id":"X4Hy02w3QUOdskKofgb9Jg","whiteboard_name":"Q3 Plan","meeting_id":"1234567890","meeting_uuid":"4444AAAiAAAAAiAiAiiAii=="}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"whiteboard.file_added":{"post":{"tags":["webhook"],"summary":"whiteboard.file_added","description":"The **Whiteboard file was added**  event is triggered when a file is successfully added to a whiteboard.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Whiteboard file was added** subscription enabled under the **Whiteboard** event.\n","operationId":"Whiteboard.file_addedWebhook","requestBody":{"description":"Webhook payload for the `whiteboard.file_added` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Whiteboard.file_addedEvent"},"examples":{"default":{"summary":"Example whiteboard.file_added event","value":{"event":"whiteboard.file_added","event_ts":1722238455000,"payload":{"operator_id":"user_789xyz","operator_collaborator_id":"collaborator_789xyz","operator_name":"Jane Doe","object":{"whiteboard_id":"wb_123456789","whiteboard_name":"Project Kickoff Board","whiteboard_owner_name":"Alice Smith","whiteboard_file":{"file_id":"file_abc123","file_name":"requirements.pdf","file_size":256000,"file_type":"application/pdf","uploaded_ts":1722238455000}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"whiteboard.created":{"post":{"tags":["webhook"],"summary":"whiteboard.created","description":"\nThe **Whiteboard was created** event is triggered every time a whiteboard is created by one of your app users or account users.\n\nZoom offers multiple methods for users to create a new whiteboard. Users can manually create whiteboards via the Zoom client or the [Zoom web portal](https://zoom.us/). Users can also programmatically create whiteboards via the [**Create a new whiteboard**] API.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Whiteboard was created** subscription enabled under the **Whiteboard** event.\n\n","operationId":"Whiteboard.createdWebhook","requestBody":{"description":"Webhook payload for the `whiteboard.created` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Whiteboard.createdEvent"},"examples":{"default":{"summary":"Example whiteboard.created event","value":{"event":"whiteboard.created","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"whiteboard_id":"1234567890","whiteboard_name":"Q3 Plan","whiteboard_type":0,"non_cloud":false,"meeting_id":"1234567890","meeting_uuid":"4444AAAiAAAAAiAiAiiAii=="}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"whiteboard.deleted":{"post":{"tags":["webhook"],"summary":"whiteboard.deleted","description":"\nThe **Whiteboard deleted** event is triggered every time a whiteboard is delete by one of your app users or account users.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Whiteboard deleted** subscription enabled under the **Whiteboard** event.\n\n","operationId":"Whiteboard.deletedWebhook","requestBody":{"description":"Webhook payload for the `whiteboard.deleted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Whiteboard.deletedEvent"},"examples":{"default":{"summary":"Example whiteboard.deleted event","value":{"event":"whiteboard.deleted","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"whiteboard_id":"1234567890","whiteboard_name":"Q3 Plan","whiteboard_type":0,"non_cloud":false}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}}},"components":{"schemas":{"Whiteboard.sharedEvent":{"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":["object","operator_collaborator_id"],"type":"object","properties":{"operator_id":{"type":"string","description":"`nullable` The Zoom user ID of the operator who added users or team chat channels to the whiteboard. It should be null for external user(the user is external to the whiteboard's organization)."},"operator_collaborator_id":{"type":"string","description":"`not nullable` The unique ID of the collaborator who added users or team chat channels to the whiteboard. Each collaborator will have a ID in a whiteboard."},"object":{"required":["collaborators","whiteboard_id"],"type":"object","properties":{"whiteboard_id":{"type":"string","description":"The whiteboard ID."},"meeting_id":{"type":"string","description":"The meeting ID. This response only returns the whiteboard is shared in a meeting."},"meeting_uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID. This response only returns the whiteboard is shared in a meeting."},"collaborators":{"type":"array","additionalProperties":false,"description":"Information about the whiteboard collaborators.","items":{"anyOf":[{"required":["collaborator_id","collaborator_type","role"],"type":"object","properties":{"collaborator_id":{"type":"string","description":"The collaborator's unique ID."},"collaborator_name":{"type":"string","description":"The collaborator's display name."},"user_id":{"type":"string","description":"The collaborator's user ID. This response only returns if the `collaborator_type` is `0`. If the `collaborator_type` is **not** `0`, this returns null value. "},"email":{"type":"string","description":"User email. This response only returns if the `collaborator_type` is `0`. If the `collaborator_type` is **not** `0`, this returns null value. See [Email address display rules](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#email-address) for details.","format":"email"},"channel_id":{"type":"string","description":"The team chat `channel ID` you want to share with. This response only returns if the `collaborator_type` is `2`. Otherwise it should be null."},"collaborator_type":{"type":"integer","description":"Collaborator type. \nEnum: \n*`0` - SAME_ACCOUNT_USER \n*`1` - EXTERNAL_USER \n*`2` - CHANNEL \n","enum":[0,1,2]},"role":{"type":"integer","description":"Collaborator permission. \nEnum: \n*`0` - OWNER \n*`1` - CO_OWNER \n*`2` - EDITOR \n*`3` - COMMENTER \n*`4` - VIEWER \n.","enum":[0,1,2,3,4]}},"additionalProperties":false}]}}},"additionalProperties":false,"description":"Information about the whiteboard."}},"additionalProperties":false}},"additionalProperties":false},"Whiteboard.sharing_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 at which the event occurred.","format":"int64"},"payload":{"required":["object","operation_type","operator_collaborator_id"],"type":"object","properties":{"operator_id":{"type":"string","description":"The Zoom user ID of the operator who changed the permission of collaborators of the whiteboard. It should be whiteboard owner user ID."},"operator_collaborator_id":{"type":"string","description":"`not nullable` The whiteboard collaborator's universally unique identifier. Each collaborator will have a ID in a whiteboard."},"operation_type":{"type":"integer","description":"Operation type. \nEnum: \n*`0` - REMOVE \n*`1` - UPDATE \n","enum":[0,1]},"object":{"required":["collaborators","whiteboard_id"],"type":"object","properties":{"whiteboard_id":{"type":"string","description":"The whiteboard ID."},"collaborators":{"type":"array","additionalProperties":false,"description":"Information about the effected whiteboard collaborators.","items":{"anyOf":[{"required":["collaborator_id","collaborator_type","role"],"type":"object","properties":{"collaborator_id":{"type":"string","description":"The collaborator's ID. \n* If `collaborator_type` set to `0`, this field refers to a `user ID`. If `collaborator_type` set to `2`, this field refers to a `team chat channel ID`. If `collaborator_type` set to `1`, this returns an empty value."},"collaborator_name":{"type":"string","description":"The collaborator's display name."},"user_id":{"type":"string","description":"The collaborator's user ID. This response only returns if the `collaborator_type` is `0`. If the `collaborator_type` is **not** `0`, this returns null value. "},"email":{"type":"string","description":"User email. This response only returns if the `collaborator_type` is `0`. If the `collaborator_type` is **not** `0`, this returns null value. See [Email address display rules](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#email-address) for details."},"channel_id":{"type":"string","description":"The team chat `channel ID` you want to share with. This response only returns if the `collaborator_type` is `2`. Otherwise it should be null."},"collaborator_type":{"type":"integer","description":"Collaborator type. \nEnum: \n*`0` - SAME_ACCOUNT_USER \n*`1` - EXTERNAL_USER \n*`2` - CHANNEL \n","enum":[0,1,2]},"role":{"type":"integer","description":"Collaborator permission. \nEnum: \n*`0` - OWNER \n*`1` - CO_OWNER \n*`2` - EDITOR \n*`3` - COMMENTER \n*`4` - VIEWER \n.","enum":[0,1,2,3,4]}},"additionalProperties":false}]}}},"additionalProperties":false,"description":"Information about the whiteboard collaborators."}},"additionalProperties":false}},"additionalProperties":false},"Whiteboard.share_settings_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 at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who updated the whiteboard share settings."},"operator":{"type":"string","description":"The email address of the user who updated the whiteboard share settings.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who updated the whiteboard share settings."},"object":{"required":["settings","whiteboard_id"],"type":"object","properties":{"whiteboard_id":{"type":"string","description":"The whiteboard ID."},"settings":{"type":"object","properties":{"share_link_setting":{"type":"object","properties":{"share_scope":{"type":"integer","description":"Who can access the share link","enum":[0,1,2]},"share_role":{"type":"integer","description":"Permission of the shared user.","enum":[1,2,3,4]}},"description":"Information about the whiteboard share link settings."},"advanced_share_setting":{"type":"object","properties":{"can_share":{"type":"boolean","description":"Indicate whether allow to share whiteboard or not."},"share_to_external":{"type":"boolean","description":"Indicate whether allowed to share with user who is in the external organization or not."},"external_can_share":{"type":"boolean","description":"Indicate whether the external user is allowed to share whiteboard or not."}},"description":"Information about the whiteboard advanced share settings"}},"description":"Information about the whiteboard share settings."}},"additionalProperties":true,"description":"Information about the whiteboard."}},"additionalProperties":true}},"additionalProperties":true},"Whiteboard.archive_availableEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who owns the session.","example":"AAAAAABBBB"},"object":{"required":["end_time","expire_time","session_id","start_time","whiteboard_id","whiteboard_name"],"type":"object","properties":{"session_id":{"type":"string","description":"The unique ID of the session. This ID can be used to retrieve all activities under the session via the [List whiteboard sessions activities](https://developers.zoom.us/docs/api/rest/reference/whiteboard/methods/#operation/Listwhiteboardsessionsarchivedfiles) API.","example":"a2f19f96-9294-4f51-8134-6f0eea108eb2"},"start_time":{"type":"string","description":"The session's start time in UTC/GMT, formatted as `yyyy-MM-dd'T'HH:mm:ssZ`.","format":"date-time","example":"2021-03-11T05:41:36Z"},"end_time":{"type":"string","description":"The session's end time in UTC/GMT, formatted as `yyyy-MM-dd'T'HH:mm:ssZ`.","format":"date-time","example":"2021-03-11T05:41:36Z"},"whiteboard_id":{"type":"string","description":"The ID of whiteboard.","example":"HY8-AC_HSou4SXY1S-OmOg"},"whiteboard_name":{"type":"string","description":"The name of whiteboard.","example":"example_whiteboard_name"},"expire_time":{"type":"string","description":"The expiration time of the archived content in UTC/GMT. After this time, the archived content will be permanently deleted. The value is formatted as `yyyy-MM-dd'T'HH:mm:ssZ`.","format":"date-time","example":"2021-03-26T06:41:36Z"}},"description":"Information about the whiteboard."}},"additionalProperties":true}},"additionalProperties":true},"Whiteboard.openedEvent":{"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":["object","operator_collaborator_id"],"type":"object","properties":{"operator_id":{"type":"string","description":"`nullable` The Zoom user ID of the operator who opened the whiteboard. It should be null for external user(the user is external to the whiteboard's organization)."},"operator_collaborator_id":{"type":"string","description":"`not nullable` The whiteboard collaborator's universally unique identifier of the operator who opened the whiteboard. Each collaborator will have a ID in a whiteboard."},"object":{"required":["whiteboard_id","whiteboard_name"],"type":"object","properties":{"whiteboard_id":{"type":"string","description":"The whiteboard ID."},"whiteboard_name":{"type":"string","description":"The whiteboard name."},"meeting_id":{"type":"string","description":"The meeting ID. This response only returns the whiteboard opened in a meeting."},"meeting_uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID. This response only returns the whiteboard opened in a meeting."}},"additionalProperties":false,"description":"Information about the whiteboard."}},"additionalProperties":false}},"additionalProperties":false},"Whiteboard.file_addedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event name."},"event_ts":{"type":"integer","description":"The timestamp when the event occurred.","format":"int64"},"payload":{"required":["object","operator_collaborator_id","operator_name"],"type":"object","properties":{"operator_id":{"type":"string","description":"The user ID of the uploader. `Null` if the user is external to the whiteboard owner's organization."},"operator_collaborator_id":{"type":"string","description":"`not nullable` The whiteboard collaborator's universally unique identifier of the operator who uploaded the file.. Each collaborator will have a ID in a whiteboard."},"operator_name":{"type":"string","description":"The name of the user who uploaded the file."},"object":{"required":["whiteboard_file","whiteboard_id","whiteboard_name","whiteboard_owner_name"],"type":"object","properties":{"whiteboard_id":{"type":"string","description":"The unique identifier of the whiteboard."},"whiteboard_name":{"type":"string","description":"The name of the whiteboard."},"whiteboard_owner_name":{"type":"string","description":"The name of the whiteboard owner."},"whiteboard_file":{"required":["file_id","file_name","file_size","file_type","uploaded_ts"],"type":"object","properties":{"file_id":{"type":"string","description":"The unique ID of the file in the whiteboard."},"file_name":{"type":"string","description":"The name of the uploaded file."},"file_size":{"type":"integer","description":"The size of the uploaded file, in bytes."},"file_type":{"type":"string","description":"The MIME type or format of the uploaded file."},"uploaded_ts":{"type":"integer","description":"The timestamp when the file was uploaded.","format":"int64"}},"description":"Metadata of the file uploaded to the whiteboard."}},"additionalProperties":false,"description":"Details of the whiteboard where the file was uploaded."}},"additionalProperties":false}},"additionalProperties":false},"Whiteboard.createdEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the whiteboard."},"operator":{"type":"string","description":"The email address of the user who created the whiteboard.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who created the whiteboard."},"object":{"required":["non_cloud","whiteboard_id","whiteboard_name","whiteboard_type"],"type":"object","properties":{"whiteboard_id":{"type":"string","description":"The whiteboard ID."},"whiteboard_name":{"type":"string","description":"The whiteboard name."},"whiteboard_type":{"type":"integer","description":"whiteboard type.","enum":[0]},"non_cloud":{"type":"boolean","description":"Whether the whiteboard allows to be saved to cloud or not."},"meeting_id":{"type":"string","description":"The meeting ID. This response only returns when the whiteboard created in a meeting."},"meeting_uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID. This response only returns when the whiteboard created in a meeting."}},"additionalProperties":false,"description":"Information about the whiteboard."}},"additionalProperties":false}},"additionalProperties":false},"Whiteboard.deletedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who deleted the whiteboard."},"operator":{"type":"string","description":"The email address of the user who deleted the whiteboard.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who deleted the whiteboard."},"object":{"required":["non_cloud","whiteboard_id","whiteboard_name","whiteboard_type"],"type":"object","properties":{"whiteboard_id":{"type":"string","description":"The whiteboard ID."},"whiteboard_name":{"type":"string","description":"The whiteboard name."},"whiteboard_type":{"type":"integer","description":"whiteboard type.","enum":[0]},"non_cloud":{"type":"boolean","description":"Whether the whiteboard allows to be saved to cloud or not."}},"additionalProperties":true,"description":"Information about the whiteboard."}},"additionalProperties":true}},"additionalProperties":true}}},"tags":[{"name":"webhook"}],"servers":[{"url":"https://{your-endpoint-url}"}]}