Conversation created

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

A new chat has started.

Use conversation.created to open a corresponding support ticket or start tracking a new chat. Store data.conversation.id as the conversation identifier and data.visitor.id as the contact identifier in your integration. To retrieve the transcript, use the conversation ID with List Conversation Messages. Subscribe to Message received for incoming messages and Contact created for contact creation or identification. These events support different parts of the workflow.

For signature verification and retries, see Webhooks overview.

POST webhook: conversation.created

Parameters

Name	In	Required	Type	Description
`X-Chatway-Event`	header	Yes	string	Event name for this delivery. Example: conversation.created
`X-Chatway-Webhook-Id`	header	Yes	string (uuid)	Unique webhook subscription ID. Example: 9f3c2a1b-4d5e-4f70-8a9b-0c1d2e3f4a5b
`X-Chatway-Delivery-Id`	header	Yes	string	Unique ID for this HTTP delivery attempt (`del_` + 32 hex characters). A new value is sent on each retry. Example: del_1b0279b1f28f12c0b9f2a2fdbf3758ee
`X-Chatway-Delivery-Attempt`	header	Yes	string	Attempt number for this event (`1` on first try). Sent as a decimal string in the header. Example: 1
`X-Chatway-Timestamp`	header	Yes	string	Unix timestamp in seconds when the request was signed. Sent as a decimal string in the header. Example: 1770201001
`X-Chatway-Signature`	header	Yes	string	`sha256=` followed by the lowercase hex HMAC SHA256 of `{X-Chatway-Timestamp}.{raw request body}`, keyed with your webhook secret. The example is computed for the example body serialized as compact JSON, the example timestamp, and the placeholder secret `whsec_exampleSecretForDocsOnly00000000`. Example: sha256=6e064332f00b9fb319699b8db1858b00de6af505db243862ff332b134e818554

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 `conversation.created`.
data (object, required) — Payload for conversation.created.
- conversation (object, required)
  - 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.
  - created_at (string (date-time))
  - first_page_url (string)
- 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.
  - country (string) — Visitor country code (for example US). Omitted when unknown.
  - ip (string) — Visitor IP address. Omitted when unknown.
  - first_page_url (string) — First page the visitor viewed. Omitted when unknown.
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": "conversation.created",
    "data": {
        "conversation": {
            "id": "0f46c0a1-8938-40e3-b2b5-bb56f569fcab",
            "channel": "website",
            "status": "open",
            "widget_name": "Main site widget",
            "identifier": "eouqtiupanm6uvglwshy",
            "created_at": "2026-02-04T10:30:00Z",
            "first_page_url": "https://example.com/pricing"
        },
        "visitor": {
            "id": "9b0c5fe6-35ad-459d-b6ba-4288191f84f1",
            "name": "John Doe",
            "email": "[email protected]",
            "phone": "+1XXXXXXXXXX",
            "country": "US",
            "ip": "203.0.113.10",
            "first_page_url": "https://example.com/pricing"
        }
    },
    "occurred_at": "2026-02-04T10:30:00Z",
    "version": "2026-09"
}