{"openapi":"3.0.0","info":{"title":"Canvas Webhooks","description":"","version":"1.0.0"},"paths":{"docs.file_created":{"post":{"tags":["File Metadata"],"summary":"docs.file_created","description":"The **File created** event is triggered every time a docs file is created for your account.\n\nZoom offers multiple methods for users to create a new docs file. Users can manually create docs files via the Zoom client or the Zoom Docs web site. Users can also programmatically create docs files via the APIs like [**Create a new file**](https://developers.zoom.us/docs/api/zoom-docs/#tag/file-management/post/docs/files) and [**Create a new file by import**](https://developers.zoom.us/docs/api/zoom-docs/#tag/import/post/docs/imports).\n\nThe event is delivered to the operator, the file owner, and all co-owners associated with the file account. If the operator is outside of the file account, the event message will not display the `operator_id` and `account_id`, and the operator will not receive the event.\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 **File created** subscription enabled under the **Docs** event.","operationId":"Docs.file_createdWebhook","requestBody":{"description":"Webhook payload for the `docs.file_created` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Docs.file_createdEvent"},"examples":{"default":{"summary":"Example docs.file_created event","value":{"event":"docs.file_created","event_ts":1768208518514,"payload":{"operator_id":"MGYn043XRneGT-TrEWTRrQ","account_id":"ce1MKr9tTwy46FHL9XZCVA","object":{"file_id":"14y1KS-eRVGycyJQ3glqVQ","file_name":"2026 Roadmap","file_type":"doc"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"docs.data_table_user_mentioned":{"post":{"tags":["DataTable Content"],"summary":"docs.data_table_user_mentioned","description":"The **Data Table User Mentioned** event is triggered every time when new users are mentioned for your account. There may be multiple users mentioned.\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 **Data Table User Mentioned** subscription enabled under the **Docs** event","operationId":"Docs.data_table_user_mentionedWebhook","requestBody":{"description":"Webhook payload for the `docs.data_table_user_mentioned` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Docs.data_table_user_mentionedEvent"},"examples":{"default":{"summary":"Example docs.data_table_user_mentioned event","value":{"event":"docs.data_table_user_mentioned","event_ts":1626230691572,"payload":{"account_id":"L6dDmGTLSrOHEQxSS0havg","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"file_id":"igZ72fTKRIWUUnhB5cNL1w","data_table_id":"a4fcf1c04173476cbfa28ce616b2a82a","row_id":"f26c6910b1b4481bb9c6f6d7de795c21","primary_key_value":"Apartment","row_link":"https://docs.zoom.us/database/ALrG-jw0REyjW0K2xLZMww?forceAIChatPage=true&view=66b07486eaec484d85a3707cf66074cb&row=b0681547742a4dccbc068a9dab9f91d4","mentioned_users":[{"user_id":"uVYdmOGQRs65mfPqPe2YOg","email":"user@example.com"}],"file_name":"Project Tracker","data_table_name":"Project Tracker"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"docs.data_table_row_created":{"post":{"tags":["DataTable Content"],"summary":"docs.data_table_row_created","description":"The **Data Table Row Created** event is triggered every time a new data table row is created for your account.\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 **Data Table Row Created** subscription enabled under the **Docs** event","operationId":"Docs.data_table_row_createdWebhook","requestBody":{"description":"Webhook payload for the `docs.data_table_row_created` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Docs.data_table_row_createdEvent"},"examples":{"default":{"summary":"Example docs.data_table_row_created event","value":{"event":"docs.data_table_row_created","event_ts":1626230691572,"payload":{"account_id":"L6dDmGTLSrOHEQxSS0havg","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"file_id":"igZ72fTKRIWUUnhB5cNL1w","data_table_id":"a4fcf1c04173476cbfa28ce616b2a82a","row_id":"f26c6910b1b4481bb9c6f6d7de795c21","primary_key_value":"Apartment","row_link":"https://docs.zoom.us/database/ALrG-jw0REyjW0K2xLZMww?forceAIChatPage=true&view=66b07486eaec484d85a3707cf66074cb&row=b0681547742a4dccbc068a9dab9f91d4","file_name":"Project Tracker","data_table_name":"Project Tracker"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"canvas.file_edited":{"post":{"tags":["File Content"],"summary":"canvas.file_edited","description":"The **File edited** event is triggered when a file is edited in your account.\n\nThis webhook employs an aggregation strategy. The **File edited** event is sent no later than one minute after the edit.\n\nThe event is delivered to the operator, the file owner, and all co-owners associated with the file account. If the operator is outside of the file account, the event message will not display the `operator_id`,`operator`,and `account_id`, and the operator will not receive the event.\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 **File edited** subscription enabled under the **Docs** event.","operationId":"Canvas.file_editedWebhook","requestBody":{"description":"Webhook payload for the `canvas.file_edited` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Canvas.file_editedEvent"},"examples":{"default":{"summary":"Example canvas.file_edited event","value":{"event":"canvas.file_edited","event_ts":1768208518514,"payload":{"operator_id":"MGYn043XRneGT-TrEWTRrQ","operator":"admin@example.com","account_id":"ce1MKr9tTwy46FHL9XZCVA","object":{"file_id":"14y1KS-eRVGycyJQ3glqVQ","file_name":"2026 Roadmap","file_type":"doc"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"docs.data_table_row_updated":{"post":{"tags":["DataTable Content"],"summary":"docs.data_table_row_updated","description":"The **Data Table Row Updated** event is triggered every time a data table row is updated for your account.\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 **Data Table Row Updated** subscription enabled under the **Docs** event","operationId":"Docs.data_table_row_updatedWebhook","requestBody":{"description":"Webhook payload for the `docs.data_table_row_updated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Docs.data_table_row_updatedEvent"},"examples":{"default":{"summary":"Example docs.data_table_row_updated event","value":{"event":"docs.data_table_row_updated","event_ts":1626230691572,"payload":{"account_id":"L6dDmGTLSrOHEQxSS0havg","operator":"admin@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"file_id":"igZ72fTKRIWUUnhB5cNL1w","data_table_id":"a4fcf1c04173476cbfa28ce616b2a82a","row_id":"f26c6910b1b4481bb9c6f6d7de795c21","primary_key_value":"Apartment","row_link":"https://docs.zoom.us/database/ALrG-jw0REyjW0K2xLZMww?forceAIChatPage=true&view=66b07486eaec484d85a3707cf66074cb&row=b0681547742a4dccbc068a9dab9f91d4","column_ids":["uVYdmOGQRs65mfPqPe2YOg"],"file_name":"Project Tracker","data_table_name":"Project Tracker"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}}},"components":{"schemas":{"Docs.file_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_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the file."},"operator_id":{"type":"string","description":"The user ID of the user who created the file."},"object":{"required":["file_id","file_name","file_type"],"type":"object","properties":{"file_id":{"type":"string","description":"The file ID."},"file_name":{"type":"string","description":"The file name."},"file_type":{"type":"string","description":"The file type.","enum":["doc","folder","data_table"]}},"additionalProperties":false,"description":"Information about the file."}},"additionalProperties":false}},"additionalProperties":false},"Docs.data_table_user_mentionedEvent":{"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 mentioned others."},"operator":{"type":"string","description":"The email address of the user who mentioned others.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who mentioned others."},"object":{"required":["data_table_id","data_table_name","file_id","file_name","mentioned_users","primary_key_value","row_link"],"type":"object","properties":{"file_id":{"type":"string","description":"File ID."},"data_table_id":{"type":"string","description":"Data Table ID."},"row_id":{"type":"string","description":"The row ID."},"primary_key_value":{"type":"string","description":"The row primary key value."},"row_link":{"type":"string","description":"Link to the current row."},"mentioned_users":{"type":"array","description":"Mention user list.","items":{"required":["email","user_id"],"type":"object","properties":{"user_id":{"type":"string","description":"User ID."},"email":{"type":"string","description":"User Email."}},"description":"Mentioned user info."}},"file_name":{"type":"string","description":"File Name."},"data_table_name":{"type":"string","description":"Data Table Name."}},"additionalProperties":false,"description":"Information about the mentioned users."}},"additionalProperties":false}},"additionalProperties":false},"Docs.data_table_row_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 row."},"operator":{"type":"string","description":"The email address of the user who created the new row.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who created the new row."},"object":{"required":["data_table_id","data_table_name","file_id","file_name","primary_key_value","row_id","row_link"],"type":"object","properties":{"file_id":{"type":"string","description":"File ID."},"data_table_id":{"type":"string","description":"Data Table ID."},"row_id":{"type":"string","description":"The created row ID."},"primary_key_value":{"type":"string","description":"The created row primary key value."},"row_link":{"type":"string","description":"Link to the created row."},"file_name":{"type":"string","description":"File Name."},"data_table_name":{"type":"string","description":"Data Table Name."}},"additionalProperties":false,"description":"Information about the created row."}},"additionalProperties":false}},"additionalProperties":false},"Canvas.file_editedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"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 account ID of the user who edited the file."},"operator":{"type":"string","description":"The email address of the user who edited the file.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who edited the file."},"object":{"required":["file_id","file_name","file_type"],"type":"object","properties":{"file_id":{"type":"string","description":"The file ID."},"file_name":{"type":"string","description":"The file name."},"file_type":{"type":"string","description":"The file type.","enum":["doc","data_table"]}},"additionalProperties":false,"description":"Information about the edited file."}},"additionalProperties":false}},"additionalProperties":false},"Docs.data_table_row_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 row."},"operator":{"type":"string","description":"The email address of the user who updated the row.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who updated the row."},"object":{"required":["column_ids","data_table_id","data_table_name","file_id","file_name","primary_key_value","row_id","row_link"],"type":"object","properties":{"file_id":{"type":"string","description":"File ID."},"data_table_id":{"type":"string","description":"Data Table ID."},"row_id":{"type":"string","description":"The updated row ID."},"primary_key_value":{"type":"string","description":"The updated row primary key value."},"row_link":{"type":"string","description":"Link to the updated row."},"column_ids":{"type":"array","description":"The ID list of the updated column.","items":{"type":"string","description":"The ID of the updated column."}},"file_name":{"type":"string","description":"File Name."},"data_table_name":{"type":"string","description":"Data Table Name."}},"additionalProperties":false,"description":"Information about the updated row."}},"additionalProperties":false}},"additionalProperties":false}}},"tags":[{"name":"File Metadata"},{"name":"DataTable Content"},{"name":"File Content"}],"servers":[{"url":"https://{your-endpoint-url}"}]}