You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: descriptions/0/api.intercom.io.yaml
+14-17Lines changed: 14 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -25667,14 +25667,16 @@ paths:
25667
25667
- `conversation_id` — escalate an existing agent conversation, including one started
25668
25668
with `/fin/ask`. On the Intercom Helpdesk, Fin by default summarises the conversation
25669
25669
and opens a new Helpdesk conversation that carries the summary as an internal note;
25670
-
the original agent conversation is not reassigned. Configure an escalation Operator
25671
-
Workflow to change this default.
25670
+
the original agent conversation is not reassigned or closed. Configure an escalation
25671
+
Operator Workflow to change this default.
25672
25672
- `user` — escalate on behalf of a user with no prior agent conversation. On the Intercom
25673
-
Helpdesk, a new Helpdesk conversation is created for the teammate. Include an optional
25674
-
`message` for its first message. Not supported on Fin for Platforms — see below.
25673
+
Helpdesk, a new Helpdesk conversation is created for the teammate. Not supported on Fin
25674
+
for Platforms — see below.
25675
25675
25676
-
In both cases the optional `context` is attached as an internal note (supplied by your
25677
-
orchestrating agent, not generated by Fin) alongside any summary.
25676
+
In both cases, pass the optional `context` to give the receiving teammate background your
25677
+
orchestrating agent has and Fin does not. On the Intercom Helpdesk, it appears above the
25678
+
summary in the internal note of the new conversation the teammate picks up. It is never
25679
+
shown to the end user.
25678
25680
25679
25681
Escalating an existing conversation also sets its AI Agent resolution state to
25680
25682
`escalated`, readable as `ai_agent.resolution_state` on the Conversations API. This is a
@@ -25683,13 +25685,13 @@ paths:
25683
25685
On Fin for Platforms, `conversation_id` is required — `user` is not supported and is
25684
25686
rejected, because there is no Intercom Helpdesk in which to create a conversation. There
25685
25687
is no Intercom inbox either, so an escalation that no workflow handles does not open a
25686
-
Helpdesk conversation for a teammate. You are notified with the `escalated` status and
25687
-
hand the conversation to a human on your own platform.
25688
+
Helpdesk conversation for a teammate. `context` is not surfaced, and the conversation is
25689
+
left open for your platform to hand off and continue driving.
25688
25690
25689
25691
You are notified over the existing webhook or SSE channel with an `escalated` status
25690
25692
followed by `complete`. The `complete` status signals that Fin is done; it does not close
25691
-
the conversation. On the Intercom Helpdesk it remains open in the human inbox; on Fin for
25692
-
Platforms it remains open for whoever handles it on your own platform.
25693
+
the conversation. On the Intercom Helpdesk, the new human conversation remains open; on
25694
+
Fin for Platforms, the conversation remains open for whoever handles it on your platform.
25693
25695
responses:
25694
25696
'200':
25695
25697
description: Conversation escalated successfully
@@ -25777,15 +25779,10 @@ paths:
25777
25779
allOf:
25778
25780
- "$ref": "#/components/schemas/fin_agent_user"
25779
25781
- description: The user to escalate on behalf of, creating a new conversation. Provide this or `conversation_id`. Not supported on Fin for Platforms.
25780
-
message:
25781
-
type: string
25782
-
maxLength: 10000
25783
-
description: Optional first message for the new conversation, used only when escalating on behalf of a `user`. Shown to the end-user (unlike `context`, which is an internal note), so don't include sensitive orchestration data. Defaults to "Requesting human support".
25784
-
example: I'd like to speak to a human about my refund.
25785
25782
context:
25786
25783
type: string
25787
25784
maxLength: 10000
25788
-
description: Optional context for the receiving teammate explaining why the conversation is being escalated. Attached as an internal note, never shown to the user. Avoid including credentials or unnecessary personal data — the note is visible to any teammate with access to the conversation.
25785
+
description: Optional background for the receiving teammate, valid with either `conversation_id` or `user`. On the Intercom Helpdesk, it appears above the summary in the internal note of the new conversation the teammate picks up, and is never shown to the end user. Not surfaced on Fin for Platforms. Avoid including credentials or unnecessary personal data — it is visible to any teammate with access to the conversation.
25789
25786
example: Customer is requesting a refund and is frustrated.
0 commit comments