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/2.16/api.intercom.io.yaml
+13-5Lines changed: 13 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -3971,7 +3971,7 @@ paths:
3971
3971
Please reach out to your accounts team to discuss access.
3972
3972
{% /admonition %}
3973
3973
3974
-
Once Fin is initialized, it progresses through a series of statuses such as *thinking*, *awaiting_user_reply*, or *resolved* before ending with a status of *complete*.
3974
+
Once Fin is initialized, it progresses through a series of statuses such as *thinking*, *replying*, *awaiting_user_reply*, or *resolved* before ending with a status of *complete*.
3975
3975
3976
3976
During this workflow, the client should allow Fin to continue uninterrupted until a final *complete* status is returned via webhook, at which point control of the conversation passes back to the client.
3977
3977
responses:
@@ -4016,6 +4016,7 @@ paths:
4016
4016
type: string
4017
4017
enum:
4018
4018
- thinking
4019
+
- replying
4019
4020
- awaiting_user_reply
4020
4021
- escalated
4021
4022
- resolved
@@ -4203,6 +4204,7 @@ paths:
4203
4204
type: string
4204
4205
enum:
4205
4206
- thinking
4207
+
- replying
4206
4208
- awaiting_user_reply
4207
4209
- escalated
4208
4210
- resolved
@@ -31316,11 +31318,13 @@ components:
31316
31318
status:
31317
31319
type: string
31318
31320
enum:
31321
+
- awaiting_user_reply
31319
31322
- escalated
31320
31323
- resolved
31321
31324
- complete
31322
31325
description: |
31323
31326
Fin's current status.
31327
+
- awaiting_user_reply: Fin has finished replying and is waiting for the user to respond
31324
31328
- escalated: The conversation has been escalated to a human
31325
31329
- resolved: The user's query has been resolved
31326
31330
- complete: Fin has completed its workflow
@@ -31354,7 +31358,7 @@ components:
31354
31358
description: |
31355
31359
Event fired when Fin replies to a user.
31356
31360
Delivered via webhooks or SSE. The content of the response will be contained in the message object.
31357
-
Fin's status will update to 'awaiting_user_reply'.
31361
+
Intermediate replies have status 'replying'; a separate fin_status_updated event with 'awaiting_user_reply' fires once Fin's reply is done.
31358
31362
x-tags:
31359
31363
- Fin Agent
31360
31364
properties:
@@ -31402,9 +31406,13 @@ components:
31402
31406
status:
31403
31407
type: string
31404
31408
enum:
31409
+
- replying
31405
31410
- awaiting_user_reply
31406
-
description: Fin's current status (always 'awaiting_user_reply' for this event).
31407
-
example: awaiting_user_reply
31411
+
description: |
31412
+
Fin's current status.
31413
+
- replying: Intermediate reply part; more parts may follow
31414
+
- awaiting_user_reply: Legacy status; instead use the fin_status_updated event with 'awaiting_user_reply', which fires once Fin's reply is done
31415
+
example: replying
31408
31416
stream_id:
31409
31417
type: string
31410
31418
description: |
@@ -35363,7 +35371,7 @@ tags:
35363
35371
35364
35372
Configure a webhook endpoint in the Fin Agent API settings to receive events, or use the `sse_subscription_url` from the API response to subscribe via SSE. See the [setup guide](/docs/guides/fin-agent-api/setup) for configuration details.
35365
35373
35366
-
- `fin_status_updated` - Fired when Fin's status changes (escalated, resolved, complete)
35374
+
- `fin_status_updated` - Fired when Fin's status changes (awaiting_user_reply, escalated, resolved, complete)
35367
35375
- `fin_replied` - Fired when Fin sends a reply to the user
0 commit comments