{"openapi":"3.0.0","info":{"title":"Cobrowse SDK Webhooks","description":"","version":"1.0.0"},"paths":{"cobrowse.session_started":{"post":{"tags":["Sessions"],"summary":"cobrowse.session_started","description":"The Session Start event is triggered when the first user joins.\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 **Start session** subscription enabled under the **Cobrowse SDK** event.\n","operationId":"Cobrowse.session_startedWebhook","requestBody":{"description":"Webhook payload for the `cobrowse.session_started` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cobrowse.session_startedEvent"},"examples":{"default":{"summary":"Example cobrowse.session_started event","value":{"event":"cobrowse.session_started","event_ts":1743483350000,"payload":{"account_id":"TEODL21kRmehjRceRnyYqw","object":{"session_id":"4567UVWxYZABCdEfGhiJkl==","start_url":"https://sample.zoom.us","user_id":"YZ8uRj9zRf2yY5cshmzrTA","user_name":"exampleuser","role_type":"customer","start_time":"2025-04-01T12:22:26Z"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"cobrowse.session_user_left":{"post":{"tags":["Sessions"],"summary":"cobrowse.session_user_left","description":"The Session User Left event is triggered every time a user leaves a session.\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 **User left** subscription enabled under the **Cobrowse SDK** event.","operationId":"Cobrowse.session_user_leftWebhook","requestBody":{"description":"Webhook payload for the `cobrowse.session_user_left` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cobrowse.session_user_leftEvent"},"examples":{"default":{"summary":"Example cobrowse.session_user_left event","value":{"event":"cobrowse.session_user_left","event_ts":1743483350000,"payload":{"account_id":"TEODL21kRmehjRceRnyYqw","object":{"session_id":"4567UVWxYZABCdEfGhiJkl==","user_connection_id":"Nlg8wgA0TFe3jT87CjQZqg","user_id":"YZ8uRj9zRf2yY5cshmzrTA","user_name":"exampleuser","role_type":"customer","leave_time":"2025-04-01T12:22:26Z","leave_reason":"Left the session"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"cobrowse.session_user_joined":{"post":{"tags":["Sessions"],"summary":"cobrowse.session_user_joined","description":"The Session User Joined event is triggered every time a user joins a session.\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 **User joined** subscription enabled under the **Cobrowse SDK** event.\n","operationId":"Cobrowse.session_user_joinedWebhook","requestBody":{"description":"Webhook payload for the `cobrowse.session_user_joined` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cobrowse.session_user_joinedEvent"},"examples":{"default":{"summary":"Example cobrowse.session_user_joined event","value":{"event":"cobrowse.session_user_joined","event_ts":1743483350000,"payload":{"account_id":"TEODL21kRmehjRceRnyYqw","object":{"session_id":"4567UVWxYZABCdEfGhiJkl==","user_connection_id":"Nlg8wgA0TFe3jT87CjQZqg","user_id":"YZ8uRj9zRf2yY5cshmzrTA","user_name":"exampleuser","role_type":"customer","join_time":"2025-04-01T12:22:26Z"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"cobrowse.session_ended":{"post":{"tags":["Sessions"],"summary":"cobrowse.session_ended","description":"The Session End event is triggered when someone ends the session, or when all users have left the session.\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 **End session** subscription enabled under the **Cobrowse SDK** event.","operationId":"Cobrowse.session_endedWebhook","requestBody":{"description":"Webhook payload for the `cobrowse.session_ended` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cobrowse.session_endedEvent"},"examples":{"default":{"summary":"Example cobrowse.session_ended event","value":{"event":"cobrowse.session_ended","event_ts":1743483350000,"payload":{"account_id":"TEODL21kRmehjRceRnyYqw","object":{"session_id":"4567UVWxYZABCdEfGhiJkl==","session_pin":"987536","user_id":"YZ8uRj9zRf2yY5cshmzrTA","user_name":"exampleuser","role_type":"customer","start_time":"2025-04-01T12:22:26Z","end_time":"2025-04-01T12:32:26Z","end_reason":"The session ended"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}}},"components":{"schemas":{"Cobrowse.session_startedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event.","enum":["cobrowse.session_started"]},"event_ts":{"type":"integer","description":"Timestamp (in milliseconds since epoch) when 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."},"object":{"required":["session_id","start_time"],"type":"object","properties":{"session_id":{"type":"string","description":"The Cobrowse session's ID."},"start_url":{"type":"string","description":"The URL the session started from."},"user_id":{"type":"string","description":"The ID of the user who started the session. This is a unique ID assigned to the user joining a session and is valid for only that session."},"user_name":{"type":"string","description":"The user's display name."},"role_type":{"type":"string","description":"The joining user's role type.","enum":["customer","agent"]},"start_time":{"type":"string","description":"The session's start time.","format":"date-time"}},"additionalProperties":false,"description":"The session's information"}},"additionalProperties":false}},"additionalProperties":false},"Cobrowse.session_user_leftEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event.","enum":["cobrowse.session_user_left"]},"event_ts":{"type":"integer","description":"Timestamp (in milliseconds since epoch) when 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."},"object":{"required":["leave_time","session_id","user_connection_id","user_id"],"type":"object","properties":{"session_id":{"type":"string","description":"The Cobrowse session's ID."},"user_connection_id":{"type":"string","description":"The connection's ID for each time the user joined the session."},"user_id":{"type":"string","description":"The user's ID. This is a unique ID assigned to the user joining a session and is valid for only that session."},"user_name":{"type":"string","description":"The user's display name."},"role_type":{"type":"string","description":"The joining user's role type.","enum":["customer","agent"]},"leave_time":{"type":"string","description":"The time when the user left the session.","format":"date-time"},"leave_reason":{"type":"string","description":"The reason why the user left the session.","default":"Left the session","enum":["Left the session","Got disconnected from the session","The session end","Network connection error","Unknown reason"]}},"additionalProperties":false,"description":"The session's information."}},"additionalProperties":false}},"additionalProperties":false},"Cobrowse.session_user_joinedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event.","enum":["cobrowse.session_user_joined"]},"event_ts":{"type":"integer","description":"Timestamp (in milliseconds since epoch) when 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."},"object":{"required":["join_time","session_id","user_connection_id","user_id"],"type":"object","properties":{"session_id":{"type":"string","description":"The Cobrowse session's ID."},"user_connection_id":{"type":"string","description":"The connection's ID for each time the user joined the session."},"user_id":{"type":"string","description":"The user's ID. This is a unique ID assigned to the user joining a session and is valid for only that session."},"user_name":{"type":"string","description":"The user's display name."},"role_type":{"type":"string","description":"The joining user's role type.","enum":["customer","agent"]},"join_time":{"type":"string","description":"The time when the user joined the session.","format":"date-time"}},"additionalProperties":false,"description":"The session's information."}},"additionalProperties":false}},"additionalProperties":false},"Cobrowse.session_endedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event.","enum":["cobrowse.session_ended"]},"event_ts":{"type":"integer","description":"Timestamp (in milliseconds since epoch) when 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."},"object":{"required":["end_time","session_id"],"type":"object","properties":{"session_id":{"type":"string","description":"The Cobrowse session's ID."},"session_pin":{"type":"string","description":"The Cobrowse session's pin code that can be used to join the session."},"user_id":{"type":"string","description":"The ID of the user who ended the session. This is a unique ID assigned to the user joining a session and is valid for only that session."},"user_name":{"type":"string","description":"The user's display name."},"role_type":{"type":"string","description":"The joining user's role type.","enum":["customer","agent"]},"start_time":{"type":"string","description":"The Cobrowse session's start time.","format":"date-time"},"end_time":{"type":"string","description":"The Cobrowse session's end time.","format":"date-time"},"end_reason":{"type":"string","description":"The reason why the user left the session.","enum":["The session ended","Network connection error","Unknown reason"]}},"additionalProperties":false,"description":"The session's information"}},"additionalProperties":false}},"additionalProperties":false}}},"tags":[{"name":"Sessions"}],"servers":[{"url":"https://{your-endpoint-url}"}]}