Custom data assigned

Incoming webhook deliveries are authenticated with HMAC signature headers (X-Chatway-Signature and X-Chatway-Timestamp), not your Chatway API key.

Custom data was added to a conversation or contact.

Use custom.data.assigned to react to a custom-field assignment, such as a subscription plan being stored. data.custom_data contains the field name and value; the example assigns enterprise to the plan field. Read data.assigned_by to identify the actor. Subscribe to Custom data removed for removals. For label-based classification, such as VIP, use Tag assigned.

For signature verification and retries, see Webhooks overview.

POST webhook: custom.data.assigned

Parameters

Request body

Signed JSON envelope for this event.

application/json

• id (string, required) — Stable event ID (`evt_…`). Same across HTTP retries for this notification.
• event (string, required) — Event name. For this webhook, always `custom.data.assigned`.
• data (object, required) — Payload for custom.data.assigned.
  • conversation (object) — The contact's latest conversation. Omitted when the contact has no conversation yet.
    • id (string (uuid), required) — Conversation ID.
    • channel (string, required) — Normalized channel.
    • status (string, required) — Conversation status.
    • widget_name (string) — Present when the conversation is tied to a website widget.
    • identifier (string) — Widget identifier when widget_name is present.
  • visitor (object, required)
    • id (string (uuid), required) — Visitor/contact ID.
    • name (string) — Visitor name. Omitted when empty.
    • email (string|null, required) — Visitor email. Always present; null when unknown.
    • phone (string|null, required) — Visitor phone. Always present; null when unknown.
  • custom_data (object, required) — Single key/value pair for the assigned custom data field.
  • assigned_by (object, required) — Who performed the action. Contains exactly one of: agent, automation, or system.
    • agent (object)
      • id (string (uuid), required) — Agent ID.
      • name (string, required) — Agent display name.
      • email (string) — Agent email when available.
    • automation (object)
      • id (string (uuid), required)
      • name (string, required)
    • system (object)
• occurred_at (string (date-time), required) — When the business event occurred.
• version (string, required) — Payload schema version.

Responses

200

Return any 2xx status to acknowledge receipt.

410

Optional HTTP 410 Gone to signal the endpoint is permanently unavailable. Like every non-2xx response below 500 (including 408 and 429), it is not retried. It does not disable the subscription; turn the webhook off in Chatway Settings if you want deliveries to stop.

Examples

Request body example

{
    "id": "evt_1234567890abcdef1234567890abcdef",
    "event": "custom.data.assigned",
    "data": {
        "conversation": {
            "id": "0f46c0a1-8938-40e3-b2b5-bb56f569fcab",
            "channel": "website",
            "status": "open",
            "widget_name": "Main site widget",
            "identifier": "eouqtiupanm6uvglwshy"
        },
        "visitor": {
            "id": "9b0c5fe6-35ad-459d-b6ba-4288191f84f1",
            "name": "John Doe",
            "email": "[email protected]",
            "phone": "+1XXXXXXXXXX"
        },
        "custom_data": {
            "plan": "enterprise"
        },
        "assigned_by": {
            "automation": {
                "id": "c3d327ab-3ef6-4d19-8ee1-11b06c912cd6",
                "name": "Assign Sales Agent"
            }
        }
    },
    "occurred_at": "2026-02-04T10:30:00Z",
    "version": "2026-09"
}