Sign in

v8

latestOpenAPI 3.1.02026-08-033623795.0 MB
Messages

Chat Message Created

Sent when a chat event is created

Required permissions:

  • webhook_receive:chat
postWebhookchat.message.created

Headers

webhook-idstring required

A unique identifier for this webhook request

Example:msg_xxxxxxxxxxxxxxxxxxxxxxxx
webhook-signaturestring required

The signature of the webhook request with the webhook version prepended

Example:v1,BASE64ENCODEDSIGNATURE
webhook-timestampstring required

The timestamp in seconds since the Unix epoch that the webhook was sent at on the server

Example:1727606400

Payload

api_version'v1' required

The API version for this webhook

api_version_datestring nullable required

The dated API version (Api-Version-Date) the payload is serialized to

company_idstring nullable

The account ID that this webhook event is associated with

idstring required

A unique ID for every single webhook request

timestampstring date-time required

The timestamp in ISO 8601 format that the webhook was sent at on the server

type'chat.message.created' required

The webhook event type

Example payload

{
  "api_version": "v1",
  "api_version_date": "2026-07-20",
  "company_id": "biz_xxxxxxxxxxxxxx",
  "data": {
    "audience": {
      "type": "channel",
      "user_ids": [
        "user_xxxxxxxxxxxxxx"
      ]
    },
    "channel": {
      "experience_id": "exp_xxxxxxxxxxxxxx",
      "id": "feed_xxxxxxxxxxxxxx",
      "type": "chat"
    },
    "message": {
      "content": "Hey, are you available for a **quick call**?",
      "created_at": "2023-12-01T05:00:00.401Z",
      "poll_votes": [
        {
          "count": 42
        }
      ],
      "reaction_counts": [
        {
          "count": 42
        }
      ],
      "updated_at": "2023-12-01T05:00:00.401Z",
      "user": {
        "id": "user_xxxxxxxxxxxxx",
        "name": "John Doe",
        "username": "johndoe42"
      },
      "view_count": 42
    },
    "reason": "channel_message"
  },
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "chat.message.created"
}

Response

Return a 200 status to indicate that the data was received successfully