Message Received

Webhook event payload for `message.received`.

View as Markdown

Delivery

Webhook deliveries are signed with Svix headers:

  • svix-id
  • svix-timestamp
  • svix-signature

Event Type

message.received

Payload Schema

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "event"
      ]
    },
    "event_type": {
      "type": "string",
      "enum": [
        "message.received"
      ]
    },
    "event_id": {
      "$ref": "#/components/schemas/type_events:EventId"
    },
    "message": {
      "$ref": "#/components/schemas/type_messages:Message"
    },
    "thread": {
      "$ref": "#/components/schemas/type_threads:ThreadItem"
    }
  },
  "required": [
    "type",
    "event_type",
    "event_id",
    "message",
    "thread"
  ],
  "title": "MessageReceivedEvent"
}

Example Payload

{
  "event_id": "<string>",
  "event_type": "message.received",
  "message": {
    "attachments": [
      {
        "attachment_id": "<string>",
        "content_disposition": "inline",
        "content_id": "<string>",
        "content_type": "<string>",
        "filename": "<string>",
        "size": 0
      }
    ],
    "bcc": [
      "<string>"
    ],
    "cc": [
      "<string>"
    ],
    "created_at": "2026-01-01T00:00:00Z",
    "extracted_html": "<string>",
    "extracted_text": "<string>",
    "from": "<string>",
    "headers": {},
    "html": "<string>",
    "in_reply_to": "<string>",
    "inbox_id": "<string>",
    "labels": [
      "<string>"
    ],
    "message_id": "<string>",
    "preview": "<string>",
    "references": [
      "<string>"
    ],
    "reply_to": [
      "<string>"
    ],
    "size": 0,
    "subject": "<string>",
    "text": "<string>",
    "thread_id": "<string>",
    "timestamp": "2026-01-01T00:00:00Z",
    "to": [
      "<string>"
    ],
    "updated_at": "2026-01-01T00:00:00Z"
  },
  "thread": {
    "attachments": [
      {
        "attachment_id": "<string>",
        "content_disposition": "inline",
        "content_id": "<string>",
        "content_type": "<string>",
        "filename": "<string>",
        "size": 0
      }
    ],
    "created_at": "2026-01-01T00:00:00Z",
    "inbox_id": "<string>",
    "labels": [
      "<string>"
    ],
    "last_message_id": "<string>",
    "message_count": 0,
    "preview": "<string>",
    "received_timestamp": "2026-01-01T00:00:00Z",
    "recipients": [
      "<string>"
    ],
    "senders": [
      "<string>"
    ],
    "sent_timestamp": "2026-01-01T00:00:00Z",
    "size": 0,
    "subject": "<string>",
    "thread_id": "<string>",
    "timestamp": "2026-01-01T00:00:00Z",
    "updated_at": "2026-01-01T00:00:00Z"
  },
  "type": "event"
}