{"openapi":"3.0.0","info":{"title":"Quality Management Webhooks","description":"","version":"1.0.0"},"paths":{"quality_management.interaction_analysis_completed":{"post":{"tags":["Interactions"],"summary":"quality_management.interaction_analysis_completed","description":"Zoom triggers this event after the Quality Management users interaction analysis is completed.\n\n## Prerequisites\n\n* A Pro or higher plan.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\t* A valid **Event Notification Endpoint URL**\n\t* The **Quality Management interaction analysis completed** subscription must be enabled under the **Quality Management** event.","operationId":"Quality_management.interaction_analysis_completedWebhook","requestBody":{"description":"Webhook payload for the `quality_management.interaction_analysis_completed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Quality_management.interaction_analysis_completedEvent"},"examples":{"default":{"summary":"Example quality_management.interaction_analysis_completed event","value":{"event":"quality_management.interaction_analysis_completed","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"start_time":"2020-05-01T19:13:02Z","duration":5,"queue_id":"Je4zLPZ-SBiLCiebE35ALQ","queue_name":"Demo","interaction_info":{"from":"+16692520210","to":"+12364352078","interaction_id":"X51n17BZQTqKtxwF4mmTIw","agent_name":"Admin3","consumer_name":"+16692520210","channel_type":"AUDIO","associated_ids":["xxxx"]},"engagement_id":"PH6wferlTACAfBzYGAVOYg","direction":"inbound","disposition":"dev-disposition","silence_event_count":2,"crosstalk_event_count":2,"hold_event_count":3,"summary":{"evaluation_score":58.63,"sentiment_score":58.63,"engagement_score":58.63},"primary_language":"en"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"quality_management.evaluation_completed":{"post":{"tags":["Interactions"],"summary":"quality_management.evaluation_completed","description":"Zoom triggers this event after the Quality Management user evaluation is completed.\n\n## Prerequisites\n\n* A Pro or higher plan.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\t* A valid **Event Notification Endpoint URL**\n\t* The **Quality Management evaluation completed** subscription must be enabled under the **Quality Management** event.","operationId":"Quality_management.evaluation_completedWebhook","requestBody":{"description":"Webhook payload for the `quality_management.evaluation_completed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Quality_management.evaluation_completedEvent"},"examples":{"default":{"summary":"Example quality_management.evaluation_completed event","value":{"event":"quality_management.interaction_analysis_completed","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"interaction_id":"ldl3k52kdfl3hd3","agent_user_id":"ZWR1C1FB695C654A829FE56553A709E8EBB","evaluator_user_id":"ZWR1C1FB695C654A829FE56553A709E8EBB","evaluation_id":"0e73a69f8f104d24a589fa0c615abca8","agent_info":{"agent_user_id":"httgPnTgTxq0d65-alfYVw","display_name":"Ashlee York"},"evaluators_info":[{"evaluator_user_id":"b0_yDuNGSq65EF8i1f0PcQ","display_name":"Rick Arps"}],"scorecard_name":"Customer Care","scoring_format":"points","total_possible_score":50,"evaluation_score":10,"evaluation_score_ratio":0.2,"evaluation_type":"AUTOMATED"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}}},"components":{"schemas":{"Quality_management.interaction_analysis_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 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 interaction."},"object":{"required":["interaction_info"],"type":"object","properties":{"start_time":{"type":"string","description":"The start time of the interaction."},"duration":{"type":"integer","description":"The interaction duration in seconds."},"queue_id":{"type":"string","description":"The ID of the queue."},"queue_name":{"type":"string","description":"The name of the queue."},"engagement_id":{"type":"string","description":"The engagement ID."},"direction":{"type":"string","description":"The direction."},"disposition":{"type":"string","description":"The disposition."},"silence_event_count":{"type":"integer","description":"The count of silence events"},"crosstalk_event_count":{"type":"integer","description":"The count of crosstalk events."},"hold_event_count":{"type":"integer","description":"The count of hold events"},"primary_language":{"type":"string","description":"The primary language."},"interaction_info":{"required":["interaction_id"],"type":"object","properties":{"from":{"type":"string","description":"The caller's phone number in E.164 format."},"to":{"type":"string","description":"The recipient's phone number in E.164 format."},"interaction_id":{"type":"string","description":"The interaction ID."},"agent_name":{"type":"string","description":"The agent name."},"consumer_name":{"type":"string","description":"The consumer name."},"channel_type":{"type":"string","description":"The channel type.","enum":["VIDEO","MANUAL","SMS","AUDIO","WEB_CHAT"]},"associated_ids":{"type":"array","description":"The associated interaction IDs.","items":{"type":"string","description":"The associated interaction ID."}}},"description":"The interaction infomation."},"summary":{"type":"object","properties":{"evaluation_score":{"type":"number","description":"The evaluation score."},"sentiment_score":{"type":"number","description":"The sentiment score."},"engagement_score":{"type":"number","description":"The engagement score."}},"description":"The summary information."}},"additionalProperties":false,"description":"Information about the interaction."}},"additionalProperties":false}},"additionalProperties":false},"Quality_management.evaluation_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 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 interaction."},"object":{"required":["evaluation_id"],"type":"object","properties":{"interaction_id":{"type":"string","description":"The interaction's ID."},"agent_user_id":{"type":"string","description":"The agent's ID."},"evaluator_user_id":{"type":"string","description":"The evaluator's ID."},"evaluation_id":{"type":"string","description":"The evaluation's ID."},"agent_info":{"type":"object","properties":{"agent_user_id":{"type":"string","description":"The agent's user ID."},"display_name":{"type":"string","description":"The agent's name."}},"description":"The agent information."},"evaluators_info":{"type":"array","description":"The evaluators' information.","items":{"type":"object","properties":{"evaluator_user_id":{"type":"string","description":"The evaluator's ID."},"display_name":{"type":"string","description":"The evaluator's name."}},"description":"The evaluator's information."}},"scorecard_name":{"type":"string","description":"The scorecard's name."},"scoring_format":{"type":"string","description":"The scoring format of the scorecard."},"total_possible_score":{"type":"number","description":"the maximum possible score for this evaluation"},"evaluation_score":{"type":"number","description":"The overall score of the evaluation, calculated based on the scorecard and answers."},"evaluation_score_ratio":{"type":"number","description":"Score received by the agent, expressed as a ratio 0.00-1.00."},"evaluation_type":{"type":"string","description":"Distinguish between automatic scoring and manual scoring.","enum":["MANUAL","AUTOMATED"]}},"additionalProperties":false,"description":"Information about the interaction."}},"additionalProperties":false}},"additionalProperties":false}}},"tags":[{"name":"Interactions"}],"servers":[{"url":"https://{your-endpoint-url}"}]}