Fin Agent Replied Event | Intercom and Fin Developer Platform

REST API Reference

Fin Agent Replied Event

Event fired when Fin replies to a user. The content of the response will be contained in the message object. Intermediate replies have status 'replying'; a separate fin_status_updated event with 'awaiting_user_reply' fires once Fin's reply is done.

event_namestringrequired

The name of the event.

Value:"fin_replied"

Example:"fin_replied"

conversation_idstringrequired

The ID of the conversation.

Example:"123456"

user_idstringrequired

The ID of the user.

Example:"7891"

messageobjectrequired

Fin's answer to the user's query.

statusstringrequired

Fin's current status.

replying: Intermediate reply part; more parts may follow
awaiting_user_reply: Legacy status; instead use the fin_status_updated event with 'awaiting_user_reply', which fires once Fin's reply is done

Enum:"replying""awaiting_user_reply"

Example:"replying"

stream_idstring

Optional. Present when the reply was generated via streaming. Correlates this event with the fin_reply_chunk events that preceded it. Use this to know when to replace streamed chunk_text with the final message body.

Example:"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"

created_at_msstring, (date-time)required

The timestamp the event was created at, with millisecond precision.

Example:"2025-01-24T10:00:00.123Z"

{
  "event_name": "fin_replied",
  "conversation_id": "123456",
  "user_id": "7891",
  "message": {
    "id": "98765",
    "author": "fin",
    "body": "<p>You can see your account details by clicking on the <em>Account</em> tab in the top right corner of the screen.</p>",
    "timestamp_ms": "2025-01-24T09:01:00.456Z"
  },
  "status": "replying",
  "stream_id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
  "created_at_ms": "2025-01-24T10:00:00.123Z"
}