Chat

A chat is a conversation between an initiator and one or more participants. The initiator is the entity that created the chat; participants are the entities in it (including the initiator). An initiator or participant can be a user, an agent, or an app integration.

Messages get sent and received within a chat. A chat also holds attachments and system messages.

  {
      "id": "682f4b313981b5f54e96ea4b",
      "key": null,
      "orgId": "6816330b6f46b5afc080fbf7",
      "state": null,
      "title": null,
      "systemMessages": [],
      "latestMessageId": null,
      "createdAt": "2025-05-22T16:05:05.453Z",
      "updatedAt": "2025-05-22T16:05:05.453Z"
  }

Properties

id ^string

The unique ID of the chat.

key ^{string optional}

A stable, caller-defined key used to create or locate a logical chat without tracking its id. Useful when bridging external chat apps. See chatKey on messages.

orgId ^{string optional}

The ID of the organization the chat belongs to.

title ^{string optional}

A human-readable title for the chat.

state ^{object optional}

A JSON object holding key-value pairs that represent the current state of the chat. A good place to store information you'd like to retrieve programmatically later, such as the identity of the user in the chat.

latestMessageId ^{string optional}

The unique ID of the latest message in the chat.