{"openapi":"3.0.0","info":{"title":"Revenue Accelerator Webhooks","description":"","version":"1.0.0"},"paths":{"revenue_accelerator.conversation_analysis_completed":{"post":{"tags":["Conversations"],"summary":"revenue_accelerator.conversation_analysis_completed","description":"Zoom triggers this event after the ZRA users conversation analysis is completed.\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\t* A valid **Event Notification Endpoint URL**\n\t* The **Revenue Accelerator conversations analysis completed** subscription must be enabled under the **Revenue Accelerator** event.","operationId":"Revenue_accelerator.conversation_analysis_completedWebhook","requestBody":{"description":"Webhook payload for the `revenue_accelerator.conversation_analysis_completed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Revenue_accelerator.conversation_analysis_completedEvent"},"examples":{"default":{"summary":"Example revenue_accelerator.conversation_analysis_completed event","value":{"event":"revenue_accelerator.conversation_analysis_completed ","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"conversation_id":"abcD3ojfdbjfg","source":"ZOOM_MEETING","host_id":"Gtl2Ra0ASfO5wIzYPYceiA"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"revenue_accelerator.playlist_remove_moment":{"post":{"tags":["Playlist"],"summary":"revenue_accelerator.playlist_remove_moment","description":"Zoom triggers this event when a ZRA user removes a moment from a playlist.\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\t* A valid **Event Notification Endpoint URL**\n\t* The **Remove Moment From Playlist** subscription must be enabled under the **Revenue Accelerator** event.","operationId":"Revenue_accelerator.playlist_remove_momentWebhook","requestBody":{"description":"Webhook payload for the `revenue_accelerator.playlist_remove_moment` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Revenue_accelerator.playlist_remove_momentEvent"},"examples":{"default":{"summary":"Example revenue_accelerator.playlist_remove_moment event","value":{"event":"revenue_accelerator.playlist_remove_moment","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator_id":"Gtl2Ra0ASfO5wIzYPYceiA","operator":"test@zoom.us","object":{"playlist_id":"AAAAAABBBB","playlist_name":"playlist name","playlist_detail_id":"323Tl2Ra0ASfO5wIzYPYceiA","moment_id":"ASfO5wIzYPYceiA","moment_name":"moment name","update_time":1755591952177}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"revenue_accelerator.playlist_add_moment":{"post":{"tags":["Playlist"],"summary":"revenue_accelerator.playlist_add_moment","description":"Zoom triggers this event when a ZRA user adds a moment to a playlist.\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\t* A valid **Event Notification Endpoint URL**\n\t* The **Add Moment To Playlist** subscription must be enabled under the **Revenue Accelerator** event.","operationId":"Revenue_accelerator.playlist_add_momentWebhook","requestBody":{"description":"Webhook payload for the `revenue_accelerator.playlist_add_moment` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Revenue_accelerator.playlist_add_momentEvent"},"examples":{"default":{"summary":"Example revenue_accelerator.playlist_add_moment event","value":{"event":"revenue_accelerator.playlist_add_moment","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator_id":"Gtl2Ra0ASfO5wIzYPYceiA","operator":"test@zoom.us","object":{"playlist_id":"AAAAAABBBB","playlist_name":"playlist name","playlist_detail_id":"323Tl2Ra0ASfO5wIzYPYceiA","moment_id":"ASfO5wIzYPYceiA","moment_name":"moment name","update_time":1755591952177}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"revenue_accelerator.playlist_create":{"post":{"tags":["Playlist"],"summary":"revenue_accelerator.playlist_create","description":"Zoom triggers this event when a ZRA user creates a playlist.\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\t* A valid **Event Notification Endpoint URL**\n\t* The **Playlist Created** subscription must be enabled under the **Revenue Accelerator** event.","operationId":"Revenue_accelerator.playlist_createWebhook","requestBody":{"description":"Webhook payload for the `revenue_accelerator.playlist_create` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Revenue_accelerator.playlist_createEvent"},"examples":{"default":{"summary":"Example revenue_accelerator.playlist_create event","value":{"event":"revenue_accelerator.playlist_create","event_ts":1626230691572,"payload":{"account_id":"account_id","operator_id":"Gtl2Ra0ASfO5wIzYPYceiA","operator":"test@zoom.us","object":{"playlist_id":"AAAAAABBBB","playlist_type":"SMART","playlist_name":"playlist name","create_time":1755591952177}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"revenue_accelerator.post_comment_completed":{"post":{"tags":["Conversations"],"summary":"revenue_accelerator.post_comment_completed","description":"Zoom triggers this event after a ZRA user comments on a conversation.\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\t* A valid **Event Notification Endpoint URL**\n\t* The **Post Comments On Conversation** subscription must be enabled under the **Revenue Accelerator** event.","operationId":"Revenue_accelerator.post_comment_completedWebhook","requestBody":{"description":"Webhook payload for the `revenue_accelerator.post_comment_completed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Revenue_accelerator.post_comment_completedEvent"},"examples":{"default":{"summary":"Example revenue_accelerator.post_comment_completed event","value":{"event":"revenue_accelerator.post_comment_completed","event_ts":1626230691572,"payload":{"account_id":"account_id","operator_id":"Gtl2Ra0ASfO5wIzYPYceiA","operator":"test.cheng@zoom.us","object":{"comment_id":"AAAAAABBBB","conversation_id":"abcD3ojfdbjfg","text":"test of this comment"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"revenue_accelerator.playlist_delete":{"post":{"tags":["Playlist"],"summary":"revenue_accelerator.playlist_delete","description":"Zoom triggers this event when a ZRA user deletes a playlist.\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\t* A valid **Event Notification Endpoint URL**\n\t* The **Playlist Deleted** subscription must be enabled under the **Revenue Accelerator** event.","operationId":"Revenue_accelerator.playlist_deleteWebhook","requestBody":{"description":"Webhook payload for the `revenue_accelerator.playlist_delete` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Revenue_accelerator.playlist_deleteEvent"},"examples":{"default":{"summary":"Example revenue_accelerator.playlist_delete event","value":{"event":"revenue_accelerator.playlist_delete","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator_id":"Gtl2Ra0ASfO5wIzYPYceiA","operator":"test@zoom.us","object":{"playlist_id":"AAAAAABBBB","playlist_name":"playlist name","delete_time":12132323232}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"revenue_accelerator.conversation_crm_associations_changed":{"post":{"tags":["Conversations"],"summary":"revenue_accelerator.conversation_crm_associations_changed","description":"This event is triggered when the ZRA conversation associations with CRM objects are changed.\n\n## Prerequisites\n\n* A Pro or higher plan.\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 **Revenue Accelerator conversation CRM objects changed** subscription must be enabled under the **Revenue Accelerator** event.","operationId":"Revenue_accelerator.conversation_crm_associations_changedWebhook","requestBody":{"description":"Webhook payload for the `revenue_accelerator.conversation_crm_associations_changed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Revenue_accelerator.conversation_crm_associations_changedEvent"},"examples":{"default":{"summary":"Example revenue_accelerator.conversation_crm_associations_changed event","value":{"event":"revenue_accelerator.deal_conversation_associations_changed","event_ts":1765788180122,"payload":{"account_id":"aCLhU8cQR4qfdTSvT4stxA","object":[{"conversation_id":"2wI0tytGQuKUoDvY7%2BUDZw==,1758246901000","old_associations":[],"new_associations":[{"deal_id":"006aa00000JkrXiAAR","account_id":"006aa00000JkrQiiAx","lead_id":null}]},{"conversation_id":"810a2556dc9f48a09d417e2f567c913b","old_associations":[{"deal_id":null,"account_id":null,"lead_id":"006aa00000LmrAxiRj"}],"new_associations":[{"deal_id":null,"account_id":"006aa00000JkrQiiAx","lead_id":null}]},{"conversation_id":"cdd31d3830fa47c1a7c62f8ad21b8b57","old_associations":[{"deal_id":"006aa00000JkrXiAAR","account_id":"006aa00000JkrQiiAx","lead_id":null}],"new_associations":[]}]}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}}},"components":{"schemas":{"Revenue_accelerator.conversation_analysis_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 at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who recorded the conversation."},"object":{"required":["conversation_id"],"type":"object","properties":{"conversation_id":{"type":"string","description":"The conversation's ID."},"source":{"type":"string","description":"The conversation's source.","enum":["ZOOM_MEETING","ZOOM_PHONE","ZOOM_CONTACT_CENTER","MICROSOFT_TEAMS","GOOGLE_MEET","OTHERS"]},"host_id":{"type":"string","description":"The conversation host's Zoom user ID."},"engagement_id":{"type":"string","description":"The ID of the engagement in Zoom Contact Center (ZCC) that this conversation is associated with. Present only when the conversation source is ZOOM_CONTACT_CENTER."}},"additionalProperties":false,"description":"Information about the conversation."}},"additionalProperties":false}},"additionalProperties":false},"Revenue_accelerator.playlist_remove_momentEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"The timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the user who removed the moment."},"operator_id":{"type":"string","description":"The ID of the user who added the moment to the playlist."},"operator":{"type":"string","description":"The identifier of the user who added the moment to the playlist, represented by email."},"object":{"required":["moment_id","playlist_id"],"type":"object","properties":{"playlist_id":{"type":"string","description":"The ID of the playlist from which the moment was removed."},"playlist_name":{"type":"string","description":"The name of the playlist from which the moment was removed."},"playlist_detail_id":{"type":"string","description":"The ID representing the relationship between the playlist and the moment."},"moment_id":{"type":"string","description":"The ID of the removed moment."},"moment_name":{"type":"string","description":"The name of the removed moment."},"update_time":{"type":"integer","description":"The timestamp (in milliseconds) when the moment was removed from the playlist."}},"additionalProperties":false,"description":"Details about the removed moment."}},"additionalProperties":false}},"additionalProperties":false},"Revenue_accelerator.playlist_add_momentEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"The timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who added the moment to the playlist."},"operator_id":{"type":"string","description":"The ID of the user who added the moment to the playlist."},"operator":{"type":"string","description":"The identifier of the user who added the moment to the playlist, represented by email."},"object":{"required":["moment_id","playlist_id"],"type":"object","properties":{"playlist_id":{"type":"string","description":"The ID of the playlist the moment was added to."},"playlist_name":{"type":"string","description":"The name of the playlist the moment was added to."},"playlist_detail_id":{"type":"string","description":"The ID representing the relationship between the playlist and the moment."},"moment_id":{"type":"string","description":"The ID of the moment that was added to the playlist."},"moment_name":{"type":"string","description":"The name of the moment that was added to the playlist."},"update_time":{"type":"integer","description":"The timestamp (in milliseconds) when the moment was added to the playlist."}},"additionalProperties":false,"description":"Details about adding the moment to the playlist."}},"additionalProperties":false}},"additionalProperties":false},"Revenue_accelerator.playlist_createEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"The timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who created the playlist."},"operator_id":{"type":"string","description":"The ID of the user who created the playlist."},"operator":{"type":"string","description":"The identifier of the user who created the playlist, represented by email."},"object":{"required":["playlist_id","playlist_name","playlist_type"],"type":"object","properties":{"playlist_id":{"type":"string","description":"The ID of the created playlist."},"playlist_type":{"type":"string","description":"The type of playlist created.","enum":["BASIC","SMART"]},"playlist_name":{"type":"string","description":"The name of the created playlist."},"create_time":{"type":"integer","description":"The creation timestamp, in milliseconds."}},"additionalProperties":false,"description":"Details about the created playlist."}},"additionalProperties":false}},"additionalProperties":false},"Revenue_accelerator.post_comment_completedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"The timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID under which the comment was created."},"operator_id":{"type":"string","description":"The unique identifier of the user who posted the comment."},"operator":{"type":"string","description":"The identifier of the user who posted the comment, represented by email."},"object":{"required":["comment_id","conversation_id"],"type":"object","properties":{"comment_id":{"type":"string","description":"The unique identifier of the comment."},"conversation_id":{"type":"string","description":"The unique identifier of the conversation being commented on."},"text":{"type":"string","description":"The content of the comment."}},"additionalProperties":false,"description":"Detailed information about the comment."}},"additionalProperties":false}},"additionalProperties":false},"Revenue_accelerator.playlist_deleteEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"The timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the user who deleted the playlist."},"operator_id":{"type":"string","description":"The ID of the user who deleted the playlist."},"operator":{"type":"string","description":"The identifier of the user who deleted the playlist, represented by email."},"object":{"required":["playlist_id"],"type":"object","properties":{"playlist_id":{"type":"string","description":"The ID of the deleted playlist."},"playlist_name":{"type":"string","description":"The name of the deleted playlist."},"delete_time":{"type":"integer","description":"The timestamp when the playlist was deleted, in milliseconds."}},"additionalProperties":false,"description":"Details about the deleted playlist."}},"additionalProperties":false}},"additionalProperties":false},"Revenue_accelerator.conversation_crm_associations_changedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"The timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Zoom account ID where the changes occurred."},"object":{"type":"array","description":"Incremental changes of conversation associations with CRM objects.","items":{"type":"object","properties":{"conversation_id":{"type":"string","description":"ZRA Conversation ID."},"old_associations":{"type":"array","description":"List of CRM object IDs whose associations with the conversation will be removed.","items":{"type":"object","properties":{"deal_id":{"type":"string","description":"CRM deal object ID.","example":"006aa00000JkrXiAAR"},"account_id":{"type":"string","description":"CRM account object ID.","example":"006aa00000JkrQiiAx"},"lead_id":{"type":"string","description":"CRM lead object ID.","example":"006aa00000LmrAxiRj"}}}},"new_associations":{"type":"array","description":"List of CRM object IDs to be associated with the conversation.","items":{"type":"object","properties":{"deal_id":{"type":"string","description":"CRM deal object ID.","example":"006aa00000JkrXiAAR"},"account_id":{"type":"string","description":"CRM account object ID.","example":"006aa00000JkrQiiAx"},"lead_id":{"type":"string","description":"CRM lead object ID.","example":"006aa00000LmrAxiRj"}}}}}}}}}}}}},"tags":[{"name":"Conversations"},{"name":"Playlist"}],"servers":[{"url":"https://{your-endpoint-url}"}]}