{"openapi":"3.0.0","info":{"title":"My Notes Webhooks","description":"","version":"1.0.0"},"paths":{"my_notes.transcript_generated":{"post":{"tags":["webhook"],"summary":"my_notes.transcript_generated","description":"The **Transcript generated** event is triggered when a note transcript is generated.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Transcript generated** subscription enabled under the **My Notes** event.","operationId":"My_notes.transcript_generatedWebhook","requestBody":{"description":"Webhook payload for the `my_notes.transcript_generated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/My_notes.transcript_generatedEvent"},"examples":{"default":{"summary":"Example my_notes.transcript_generated event","value":{"event":"my_notes.transcript_generated","event_ts":1747008000000,"payload":{"account_id":"LCzJ3qB4QHwB754Sab_2Vn","operator_id":"cb_ypuG9EPVCeweCTYPobA","object":{"note_id":"unXTLuGN8my_-4A8A","note_link":"https://docs.zoom.us/doc/unXTLuGN8my_-4A8A","meeting_id":"TvC-TbvRRS-rYfehr2M1RA=="}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"my_notes.note_completed":{"post":{"tags":["webhook"],"summary":"my_notes.note_completed","description":"The **Note completed** event is triggered when a note is completed.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Note completed** subscription enabled under the **My Notes** event.","operationId":"My_notes.note_completedWebhook","requestBody":{"description":"Webhook payload for the `my_notes.note_completed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/My_notes.note_completedEvent"},"examples":{"default":{"summary":"Example my_notes.note_completed event","value":{"event":"my_notes.note_completed","event_ts":1747008000000,"payload":{"account_id":"LCzJ3qB4QHwB754Sab_2Vn","operator_id":"cb_ypuG9EPVCeweCTYPobA","object":{"note_id":"unXTLuGN8my_-4A8A","note_link":"https://docs.zoom.us/doc/unXTLuGN8my_-4A8A","meeting_id":"TvC-TbvRRS-rYfehr2M1RA=="}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"my_notes.note_generated":{"post":{"tags":["webhook"],"summary":"my_notes.note_generated","description":"The **Note generated** event is triggered every time one of your app users or account users generate note.\n## Prerequisites\n* A Pro or higher plan.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n  * A valid **Event Notification Endpoint URL**\n  * The **Note generated** subscription enabled under the **My Notes** event.","operationId":"My_notes.note_generatedWebhook","requestBody":{"description":"Webhook payload for the `my_notes.note_generated` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/My_notes.note_generatedEvent"},"examples":{"default":{"summary":"Example my_notes.note_generated event","value":{"event":"my_notes.note_generated","event_ts":1747008000000,"payload":{"account_id":"LCzJ3qB4QHwB754Sab_2Vn","operator":"bob.james@zoom.us","operator_id":"cb_ypuG9EPVCeweCTYPobA","object":{"note_id":"unXTLuGN8my_-4A8A","note_link":"https://zoom.us/docs/unXTLuGN8my_-4A8A","note_name":"Agent Skill","created_time":"2025-10-29T05:54:58.346Z","updated_time":"2026-07-01T07:07:37.898Z","meeting_id":"toSK28KDRxywRjp5xv7Pdw=="}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}}},"components":{"schemas":{"My_notes.transcript_generatedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event.","enum":["my_notes.transcript_generated"]},"event_ts":{"type":"integer","description":"The event's timestamp.","format":"int64"},"payload":{"required":["account_id","object","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the note owner."},"operator_id":{"type":"string","description":"The user ID of the user who triggered the event."},"object":{"required":["note_id","note_link"],"type":"object","properties":{"note_id":{"type":"string","description":"The note ID."},"note_link":{"type":"string","description":"The link to the note.","format":"uri"},"meeting_id":{"type":"string","description":"The Zoom meeting ID. Returned only when the note is associated with a Zoom meeting."}},"additionalProperties":false,"description":"Information about the note."}},"additionalProperties":false}},"additionalProperties":false},"My_notes.note_completedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event.","enum":["my_notes.note_completed"]},"event_ts":{"type":"integer","description":"The 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 note owner."},"operator_id":{"type":"string","description":"The user ID of the user who triggered the event."},"object":{"required":["note_id","note_link"],"type":"object","properties":{"note_id":{"type":"string","description":"The note ID."},"note_link":{"type":"string","description":"The link to the note.","format":"uri"},"meeting_id":{"type":"string","description":"The Zoom meeting ID. Returned only when the note is associated with a Zoom meeting."}},"additionalProperties":false,"description":"Information about the note."}},"additionalProperties":false}},"additionalProperties":false},"My_notes.note_generatedEvent":{"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 generated the note."},"operator":{"type":"string","description":"The email address of the user who generated the note.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who generated the note."},"object":{"required":["created_time","note_id","note_link","note_name","updated_time"],"type":"object","properties":{"note_id":{"type":"string","description":"The note ID."},"note_link":{"type":"string","description":"The link to the note."},"note_name":{"type":"string","description":"The name of the note."},"created_time":{"type":"string","description":"The creation time of the note in RFC 3339 format.","format":"date-time"},"updated_time":{"type":"string","description":"The last updated time of the note in RFC 3339 format.","format":"date-time"},"meeting_id":{"type":"string","description":"The meeting ID associated with the note. This field is only returned when the note is linked to a Zoom Meeting. Otherwise, it is an empty string."}},"additionalProperties":false,"description":"Information about the note."}},"additionalProperties":false}},"additionalProperties":false}}},"tags":[{"name":"webhook"}],"servers":[{"url":"https://{your-endpoint-url}"}]}