{"openapi":"3.0.0","info":{"title":"Healthcare Webhooks","description":"","version":"1.0.0"},"paths":{"clinical_notes.note_created":{"post":{"tags":["clinicalnotes"],"summary":"clinical_notes.note_created","description":"The **Clinical Note Created** event is triggered every time the clinical note of the meeting is made available for one of your account users after the meeting's clinical note streaming session ends.\n\n## Prerequisites\n\n* Host user must be Pro or higher plan.\n* Enable the Clinical Note feature in the host's account.\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 **Clinical Note have created** subscription must be enabled under the **Healthcare** event.","operationId":"Clinical_notes.note_createdWebhook","requestBody":{"description":"Webhook payload for the `clinical_notes.note_created` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Clinical_notes.note_createdEvent"},"examples":{"default":{"summary":"Example clinical_notes.note_created event","value":{"event":"clinical_notes.note_created","event_ts":1626230691572,"payload":{"account_id":"lm5YQGvrQkufX4Z87vVZyQ","object":{"meeting_id":"I3pHE/RnRbmm+ex2g07sxw==","meeting_number":"94564522297","meeting_topic":"Provider John's Zoom Meeting","meeting_host_id":"dqV7XEpnS5G3rGsvqylmjQ","note_id":"ArfRXokSTiGTCSYFVtxNa","note_owner_user_id":"dqV7XEpnS5G3rGsvqylmjQ","note_start_time":"2025-05-15T03:01:08.608Z","note_end_time":"2025-05-15T03:25:59.608Z","note_created_time":"2025-05-15T03:26:08.608Z","note_title":"Monica, F, 25","ehr_context_available":false}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}}},"components":{"schemas":{"Clinical_notes.note_createdEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who started the clinical notes session in the meeting and owns the note document."},"object":{"required":["ehr_context_available","meeting_host_id","meeting_id","meeting_number","meeting_topic","note_created_time","note_end_time","note_id","note_owner_user_id","note_start_time","note_title"],"type":"object","properties":{"meeting_id":{"type":"string","description":"Unique meeting ID. Each meeting instance generates its own meeting UUID. After a meeting ends, a new UUID is generated for the next instance of the meeting. Retrieve a list of UUIDs from past meeting instances using the [**List past meeting instances**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/pastMeetings) API. [Double encode](https://developers.zoom.us/docs/api/using-zoom-apis/#double-encoding) your UUID when using it for API calls if the UUID begins with a `/` or contains `//` in it.\n"},"meeting_number":{"type":"string","description":"The meeting's number."},"meeting_topic":{"type":"string","description":"Meeting topic."},"meeting_host_id":{"type":"string","description":"The ID of the user who is set as the meeting host."},"note_id":{"type":"string","description":"Unique identifier of the note.","example":"ArfRXokSTiGTCSYFVtxNa"},"note_owner_user_id":{"type":"string","description":"The user ID of the user who started the clinical notes session and owns the note document.","example":"dqV7XEpnS5G3rGsvqylmjQ"},"note_start_time":{"type":"string","description":"The clinical note's start date and time in yyyy-MM-dd'T'HH:mm:ss'Z' UTC format.","format":"date-time"},"note_end_time":{"type":"string","description":"The clinical note's end date and time in yyyy-MM-dd'T'HH:mm:ss'Z' UTC format.","format":"date-time"},"note_created_time":{"type":"string","description":"The date and time when the clinical note was created.","format":"date-time"},"note_title":{"type":"string","description":"The clinical note title."},"ehr_context_available":{"type":"boolean","description":"Indicates whether the EHR context data (such as appointment, patient, and provider identifiers) is available for this clinical note."}},"additionalProperties":true,"description":"Information about the meeting clinical note."}},"additionalProperties":true}},"additionalProperties":true}}},"tags":[{"name":"clinicalnotes"}],"servers":[{"url":"https://{your-endpoint-url}"}]}