{"openapi":"3.0.0","info":{"title":"Tasks Webhooks","description":"","version":"1.0.0"},"paths":{"task.deleted":{"post":{"tags":["Tasks"],"summary":"task.deleted","description":"\nThe **Task deleted** event is triggered every time a task 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 **Task deleted** subscription enabled under the **Task** event.","operationId":"Task.deletedWebhook","requestBody":{"description":"Webhook payload for the `task.deleted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task.deletedEvent"},"examples":{"default":{"summary":"Example task.deleted event","value":{"event":"task.deleted","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"user@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"task_id":"12321312323","title":"Complete project documentation","description":"Write comprehensive documentation for the new API endpoints","status":"To do","priority":"Medium","is_public":true,"due_date":"2025-08-22"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"task.updated":{"post":{"tags":["Tasks"],"summary":"task.updated","description":"\nThe **Task was updated** event is triggered every time a task is updated.\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 **Task was updated** subscription enabled under the **Task** event.","operationId":"Task.updatedWebhook","requestBody":{"description":"Webhook payload for the `task.updated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task.updatedEvent"},"examples":{"default":{"summary":"Example task.updated event","value":{"event":"task.updated","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"user@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","task_id":"X4Hy02w3QUOdskKofgb9Jg","field_changes":[{"field_name":"title","old_value":"Test Plan","new_value":"New Test Plan","operation_type":"updated","changed_at":1758184629}],"file_changes":[{"file_id":"file_456789","file_name":"project_requirements.pdf","file_type":"application/pdf","file_size":2048576,"file_download_link":"https://api.zoom.us/v2/files/file_456789/download?token=temp_token_123","download_link_expire_time":1703209856789,"operation_type":"added","changed_at":1703123456789}]}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"task.comment_updated":{"post":{"tags":["Comment"],"summary":"task.comment_updated","description":"\nThe **Task comment was updated** event is triggered every time a task comment is updated to task.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Task comment was updated** subscription enabled under the **Task** event.","operationId":"Task.comment_updatedWebhook","requestBody":{"description":"Webhook payload for the `task.comment_updated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task.comment_updatedEvent"},"examples":{"default":{"summary":"Example task.comment_updated event","value":{"event":"task.comment_updated","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"user@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","operation_type":1,"object":{"task_id":"X4Hy02w3QUOdskKofgb9Jg","comment":{"comment_id":"472a9f05-d46d-44bb-bf5a-93e731d1f6d0","content_text":"Jack update comment"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"task.completed":{"post":{"tags":["Tasks"],"summary":"task.completed","description":"\nThe **task was completed** event is triggered every time a task status is done.\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 **Task was completed** subscription enabled under the **Task** event.","operationId":"Task.completedWebhook","requestBody":{"description":"Webhook payload for the `task.completed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task.completedEvent"},"examples":{"default":{"summary":"Example task.completed event","value":{"event":"task.completed","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"user@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"task_id":"X4Hy02w3QUOdskKofgb9Jg","status":"Done"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"task.collaborator_updated":{"post":{"tags":["Collaborator"],"summary":"task.collaborator_updated","description":"\nThe **Task collaborator were updated** event is triggered every time a task collaborator is added or deleted to share a task with a Zoom user\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 **Task collaborator were updated** subscription enabled under the **Task** event.","operationId":"Task.collaborator_updatedWebhook","requestBody":{"description":"Webhook payload for the `task.collaborator_updated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task.collaborator_updatedEvent"},"examples":{"default":{"summary":"Example task.collaborator_updated event","value":{"event":"task.collaborator_updated","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"user@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","operation_type":1,"object":{"task_id":"X4Hy02w3QUOdskKofgb9Jg","collaborators":[{"user_id":"CcrEGgmeQem1uyJsuIRKwA","display_name":"John Doe","email":"john.doe@example.com","avatar":"https://example.com/avatar.jpg"}]}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"task.created":{"post":{"tags":["Tasks"],"summary":"task.created","description":"\nThe **Task was created** event is triggered every time a task is created by one of your app users or account users.\n\nZoom offers multiple methods for users to create a new task. Users can manually create tasks in the Zoom client or the [Zoom web portal](https://zoom.us/). Users can also programmatically create tasks via the [**Create a new task**] API.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **Task was created** subscription enabled under the **Task** event.","operationId":"Task.createdWebhook","requestBody":{"description":"Webhook payload for the `task.created` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task.createdEvent"},"examples":{"default":{"summary":"Example task.created event","value":{"event":"task.created","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"user@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"task_id":"12321312323","title":"Complete project documentation","description":"Write comprehensive documentation for the new API endpoints","status":"To do","priority":"Medium","is_public":true,"due_date":"2025-08-22","source_type":"user","starred":false,"collaborators":[{"user_id":"w0RChiauQeqRlv5fgxYULQ","email":"userB@example.com"}],"create_time":"2025-03-25T07:29:29Z","friendly_task_id":"Task-1","link":"https://tasks.zoomdev.us/ws53iQgOOkOdzVTxZaVoRA/TASK-1","assignees":[{"user_id":"w0RChiauQeqRlv5fgxYULQ","email":"userB@example.com"}]}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"task.assignee_updated":{"post":{"tags":["Collaborator"],"summary":"task.assignee_updated","description":"\nThe **Task assignee were updated** event is triggered every time a task assignee is added or deleted to share a task with a Zoom user\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 **Task assignee were updated** subscription enabled under the **Task** event.","operationId":"Task.assignee_updatedWebhook","requestBody":{"description":"Webhook payload for the `task.assignee_updated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task.assignee_updatedEvent"},"examples":{"default":{"summary":"Example task.assignee_updated event","value":{"event":"task.assignee_updated","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"user@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","operation_type":1,"object":{"task_id":"X4Hy02w3QUOdskKofgb9Jg","assignees":[{"user_id":"CcrEGgmeQem1uyJsuIRKwA","display_name":"John Doe","email":"john.doe@example.com","avatar":"https://example.com/avatar.jpg"}]}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"task.reopened":{"post":{"tags":["Tasks"],"summary":"task.reopened","description":"\nThe **task was reopened** event is triggered every time a task 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 **Task was reopened** subscription enabled under the **Task** event.","operationId":"Task.reopenedWebhook","requestBody":{"description":"Webhook payload for the `task.reopened` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task.reopenedEvent"},"examples":{"default":{"summary":"Example task.reopened event","value":{"event":"task.reopened","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"user@example.com","operator_id":"z8yCxjabcdEFGHfp8uQ","object":{"task_id":"X4Hy02w3QUOdskKofgb9Jg"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}}},"components":{"schemas":{"Task.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 of 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 task."},"operator":{"type":"string","description":"The email of the user who deleted the task."},"operator_id":{"type":"string","description":"The user ID of the user who deleted the task."},"object":{"required":["task_id"],"type":"object","properties":{"task_id":{"type":"string","description":"The task ID."},"description":{"type":"string","description":"The detailed description of the task."},"title":{"type":"string","description":"The title of the task."},"priority":{"$ref":"#/components/schemas/PriorityId-Tasks"},"status":{"$ref":"#/components/schemas/StatusId-Tasks"},"is_public":{"$ref":"#/components/schemas/IsPublic-Tasks"},"due_date":{"$ref":"#/components/schemas/DueDate-Tasks"}},"additionalProperties":true,"description":"Information about the task"}},"additionalProperties":true}},"additionalProperties":true},"Task.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 of when the event occurred.","format":"int64"},"payload":{"required":["account_id","operator","operator_id","task_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who updated the task."},"operator":{"type":"string","description":"The email of the user who updated the task."},"operator_id":{"type":"string","description":" The Zoom user ID of the operator who closed the task. \n It should be null if the user is external to the task's organization."},"task_id":{"type":"string","description":"The task ID."},"field_changes":{"type":"array","description":"The list of field changes in this update.","items":{"required":["changed_at","field_name","operation_type"],"type":"object","properties":{"field_name":{"type":"string","description":"The name of the field that was changed.","enum":["title","status","priority","is_public","due_date","starred","description"]},"old_value":{"type":"string","description":"The previous value of the field."},"new_value":{"type":"string","description":"The new value of the field."},"operation_type":{"type":"string","description":"The operation performed on the field.","enum":["added","removed","updated"]},"changed_at":{"type":"integer","description":"The unix timestamp when the field was changed."}}}},"file_changes":{"type":"array","description":"The list of file changes in this update.","items":{"required":["changed_at","file_id","file_name","operation_type"],"type":"object","properties":{"file_id":{"type":"string","description":"The unique identifier of the file."},"file_name":{"type":"string","description":"The name of the file."},"file_type":{"type":"string","description":"The MIME type of the file."},"file_size":{"type":"integer","description":"The size of the file in bytes."},"file_download_link":{"type":"string","description":"The temporary download link for the file."},"download_link_expire_time":{"type":"integer","description":"The unix timestamp when the download link expires."},"operation_type":{"type":"string","description":"The operation performed on the attachment.","enum":["added","removed"]},"changed_at":{"type":"integer","description":"The unix timestamp when the attachment was changed."}}}}},"additionalProperties":false}},"additionalProperties":false},"Task.comment_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","operation_type","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who updated the comment with a task."},"operator":{"type":"string","description":"The email of the user who updated the comment with a task."},"operator_id":{"type":"string","description":"The user ID of the user who updated the comment with a task."},"operation_type":{"type":"integer","description":"Operation type. \n\n*`0` - REMOVE \n*`1` - ADD \n*`2` - UPDATED","enum":[0,1,2]},"object":{"required":["comment","task_id"],"type":"object","properties":{"task_id":{"type":"string","description":"The task ID."},"comment":{"required":["comment_id","content_text"],"type":"object","properties":{"content_text":{"type":"string","description":"The task comment content."},"comment_id":{"type":"string","description":"The task comment ID."}},"additionalProperties":false,"description":"The comments that had been added, removed, or updated."}},"additionalProperties":false,"description":"Information about the task."}},"additionalProperties":false}},"additionalProperties":false},"Task.completedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp of 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 completed the task."},"operator":{"type":"string","description":"The email of the user who completed the task."},"operator_id":{"type":"string","description":"The Zoom user ID of the operator who completed the task."},"object":{"required":["status","task_id"],"type":"object","properties":{"task_id":{"type":"string","description":"The task ID."},"status":{"$ref":"#/components/schemas/StatusId-Tasks"}},"additionalProperties":false,"description":"Information about the task."}},"additionalProperties":false}},"additionalProperties":false},"Task.collaborator_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 of when the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operation_type","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who updated the collaborators of the task."},"operator":{"type":"string","description":"The email of the user who updated the collaborators of the task."},"operator_id":{"type":"string","description":"The Zoom user ID of the operator who updated the collaborators of the task."},"operation_type":{"type":"integer","description":"Operation type. \nEnum: \n*`0` - REMOVE \n*`1` - ADD \n","enum":[0,1]},"object":{"required":["collaborators","task_id"],"type":"object","properties":{"task_id":{"type":"string","description":"The task ID."},"collaborators":{"type":"array","additionalProperties":false,"description":"Collaborators that has been added or removed.","items":{"anyOf":[{"required":["display_name","user_id"],"type":"object","properties":{"user_id":{"type":"string","description":"The Zoom user ID of the collaborator. "},"display_name":{"type":"string","description":"The display name of the collaborator."},"email":{"type":"string","description":"The email address of the collaborator.","format":"email"},"avatar":{"type":"string","description":"The avatar image URL of the collaborator.","format":"uri"}},"additionalProperties":false}]}}},"additionalProperties":false,"description":"Information about the task."}},"additionalProperties":false}},"additionalProperties":false},"Task.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 of when the event occurred.","format":"int64"},"payload":{"required":["account_id","account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the task."},"operator":{"type":"string","description":"The email of the user who created the task."},"operator_id":{"type":"string","description":"The user ID of the user who created the task."},"object":{"required":["create_time","is_public","priority","source_type","starred","status","task_id","title"],"type":"object","properties":{"task_id":{"type":"string","description":"The task ID."},"description":{"type":"string","description":"The task's detailed description."},"title":{"type":"string","description":"The task's title."},"priority":{"$ref":"#/components/schemas/PriorityId-Tasks"},"status":{"$ref":"#/components/schemas/StatusId-Tasks"},"is_public":{"$ref":"#/components/schemas/IsPublic-Tasks"},"due_date":{"$ref":"#/components/schemas/DueDate-Tasks"},"source_type":{"$ref":"#/components/schemas/source_type-Tasks"},"starred":{"type":"boolean","description":"Indicates whether the task is marked as starred."},"collaborators":{"type":"array","description":"A list of collaborators to invite to the task. Maximum user count is 20.","items":{"required":["email","user_id"],"type":"object","properties":{"user_id":{"type":"string","description":"The collaborator's user to invite. The invited user must belong to the same account as the requesting user."},"email":{"type":"string","description":"The collaborator's email address.","format":"email"}}}},"create_time":{"type":"string","description":"The creation date-time in UTC/GMT. ","format":"date-time","example":"2025-03-25T07:29:29Z"},"friendly_task_id":{"type":"string","description":"The task's human-readable identifier.","example":"Task-1"},"link":{"type":"string","description":"The direct URL link to the task.","example":"https://tasks.example.com/ws53iQgOOkOdzVTxZaVoRA/TASK-1"},"assignees":{"type":"array","description":"A list of assignees to add to the task.","items":{"required":["email","user_id"],"type":"object","properties":{"user_id":{"type":"string","description":"The assignee's Zoom user ID."},"email":{"type":"string","description":"The assignee's email address.","format":"email"}}}}},"additionalProperties":false,"description":"Information about the task."}},"additionalProperties":false}},"additionalProperties":false},"Task.assignee_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","operation_type","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who updated assignee to the task "},"operator":{"type":"string","description":"The email of the user who updated assignee to the task."},"operator_id":{"type":"string","description":"The Zoom user ID of the operator who updated assignee to the task."},"operation_type":{"type":"integer","description":"Operation type. \nEnum: \n*`0` - REMOVE \n*`1` - ADD \n","enum":[0,1]},"object":{"required":["assignees","task_id"],"type":"object","properties":{"task_id":{"type":"string","description":"The task ID."},"assignees":{"type":"array","additionalProperties":false,"description":"Assignees that has been added or removed","items":{"anyOf":[{"required":["display_name","user_id"],"type":"object","properties":{"user_id":{"type":"string","description":"The Zoom user ID of the collaborator. "},"display_name":{"type":"string","description":"The display name of the collaborator."},"email":{"type":"string","description":"The email address of the collaborator.","format":"email"},"avatar":{"type":"string","description":"The avatar image URL of the collaborator.","format":"uri"}},"additionalProperties":false}]}}},"additionalProperties":false,"description":"Information about the task."}},"additionalProperties":false}},"additionalProperties":false},"Task.reopenedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp of 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 opened the task."},"operator":{"type":"string","description":"The email of the user who opened the task."},"operator_id":{"type":"string","description":"The Zoom user ID of the operator who opened the task."},"object":{"required":["task_id"],"type":"object","properties":{"task_id":{"type":"string","description":"The task ID."}},"additionalProperties":false,"description":"Information about the task."}},"additionalProperties":false}},"additionalProperties":false}}},"tags":[{"name":"Tasks"},{"name":"Comment"},{"name":"Collaborator"}],"servers":[{"url":"https://{your-endpoint-url}"}]}