diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml index 35dbd316..a1c026aa 100644 --- a/descriptions/0/api.intercom.io.yaml +++ b/descriptions/0/api.intercom.io.yaml @@ -13524,6 +13524,7 @@ paths: handoff: type: zendesk_ticket success: true + data: {} app_package_code: null total_count: 7 email conversation with history found: @@ -39684,23 +39685,42 @@ components: standalone_platform_handoff: title: Part type - standalone_platform_handoff type: object - description: Contains the escalation target Fin handed the conversation off to, for conversation part type standalone_platform_handoff. Only present for handoffs to Zendesk; for any other handoff target event_details is an empty object. + description: Contains the handoff Fin attempted to an external platform, for conversation part type standalone_platform_handoff. properties: handoff: type: object - description: The escalation Fin attempted. Omitted when the handoff target is not Zendesk. + description: The handoff Fin attempted. properties: type: type: string - description: Where Fin handed the conversation off to. zendesk_ticket means a Zendesk ticket was created, and zendesk_agent means the conversation was handed over to a Zendesk agent for live chat. - enum: - - zendesk_ticket - - zendesk_agent - example: zendesk_ticket + description: The handoff type. One of zendesk_ticket, zendesk_agent, salesforce_case, salesforce_in_app_messaging, salesforce_team, external_agent or external_ticket. Older parts can also return salesforce_chat. + example: salesforce_case success: type: boolean - description: Whether the handoff completed. A handoff that did not complete falls back to a live agent, which is reported in a separate successful part. + nullable: true + description: true when the handoff completed and false when it failed. null means no outcome was recorded on this part, for example a Salesforce in-app messaging handoff that was only initiated. example: true + data: + type: object + description: Details of the handoff. Always present. For a successful salesforce_case handoff it holds the created Case's case_id and case_number; otherwise it is an empty object. + properties: + case_id: + type: string + description: The ID of the Salesforce Case created by the handoff. + example: '500XX0000001' + case_number: + type: string + description: The number of the Salesforce Case created by the handoff. + example: '00001234' + example: + case_id: '500XX0000001' + case_number: '00001234' + example: + type: salesforce_case + success: true + data: + case_id: '500XX0000001' + case_number: '00001234' event_details: title: Event details of Workflow & actions type: object