Skip to content

Commit 1a93887

Browse files
authored
Document Fin Agent replying status in v2.16 (#609)
1 parent 60e3c8a commit 1a93887

1 file changed

Lines changed: 13 additions & 5 deletions

File tree

descriptions/2.16/api.intercom.io.yaml

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3971,7 +3971,7 @@ paths:
39713971
Please reach out to your accounts team to discuss access.
39723972
{% /admonition %}
39733973

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*.
39753975

39763976
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.
39773977
responses:
@@ -4016,6 +4016,7 @@ paths:
40164016
type: string
40174017
enum:
40184018
- thinking
4019+
- replying
40194020
- awaiting_user_reply
40204021
- escalated
40214022
- resolved
@@ -4203,6 +4204,7 @@ paths:
42034204
type: string
42044205
enum:
42054206
- thinking
4207+
- replying
42064208
- awaiting_user_reply
42074209
- escalated
42084210
- resolved
@@ -31316,11 +31318,13 @@ components:
3131631318
status:
3131731319
type: string
3131831320
enum:
31321+
- awaiting_user_reply
3131931322
- escalated
3132031323
- resolved
3132131324
- complete
3132231325
description: |
3132331326
Fin's current status.
31327+
- awaiting_user_reply: Fin has finished replying and is waiting for the user to respond
3132431328
- escalated: The conversation has been escalated to a human
3132531329
- resolved: The user's query has been resolved
3132631330
- complete: Fin has completed its workflow
@@ -31354,7 +31358,7 @@ components:
3135431358
description: |
3135531359
Event fired when Fin replies to a user.
3135631360
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.
3135831362
x-tags:
3135931363
- Fin Agent
3136031364
properties:
@@ -31402,9 +31406,13 @@ components:
3140231406
status:
3140331407
type: string
3140431408
enum:
31409+
- replying
3140531410
- 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
3140831416
stream_id:
3140931417
type: string
3141031418
description: |
@@ -35363,7 +35371,7 @@ tags:
3536335371

3536435372
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.
3536535373

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)
3536735375
- `fin_replied` - Fired when Fin sends a reply to the user
3536835376
- `fin_reply_chunk` - SSE-only streaming event fired during reply generation (requires streaming enabled)
3536935377

0 commit comments

Comments
 (0)