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"
      ]
    },
    "inbox_id": {
      "type": "string"
    },
    "folder": {
      "type": "string"
    },
    "uid": {
      "type": "integer"
    },
    "message_id": {
      "type": "string"
    },
    "context_url": {
      "type": "string"
    },
    "from": {
      "type": "string",
      "nullable": true
    },
    "subject": {
      "type": "string",
      "nullable": true
    },
    "intent": {
      "type": "string",
      "nullable": true
    },
    "vip_score": {
      "type": "number",
      "nullable": true
    },
    "enrichment_tier": {
      "type": "string",
      "enum": [
        "shallow",
        "deep"
      ]
    },
    "contact_relationship": {
      "type": "object",
      "nullable": true,
      "additionalProperties": true
    },
    "deep_context_credits_consumed": {
      "type": "integer"
    },
    "historical_context": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "zep_temporal_summary": {
      "type": "object",
      "nullable": true,
      "additionalProperties": true
    },
    "timestamp": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "type",
    "event_type",
    "inbox_id",
    "folder",
    "uid",
    "message_id",
    "context_url",
    "enrichment_tier",
    "deep_context_credits_consumed",
    "historical_context",
    "timestamp"
  ],
  "title": "HumanMessageReceivedEvent"
}

Example Payload

{
  "contact_relationship": {},
  "context_url": "<string>",
  "deep_context_credits_consumed": 0,
  "enrichment_tier": "shallow",
  "event_type": "message.received",
  "folder": "<string>",
  "from": "<string>",
  "historical_context": [
    {}
  ],
  "inbox_id": "<string>",
  "intent": "<string>",
  "message_id": "<string>",
  "subject": "<string>",
  "timestamp": "2026-01-01T00:00:00Z",
  "type": "event",
  "uid": 0,
  "vip_score": 0,
  "zep_temporal_summary": {}
}