Skip to main content
post{configured webhook URL}

Webhook payloads

LLM
View as Markdown
Open llms.txt

Endpoint shape implemented by external webhook receivers. Return any 2xx response after accepting an event.

Authorization

Scheme

  • standardWebhooks

External receiver endpoint shape for webhook events.

Parameters

  • Name
    webhook-id
    Type
    header string
    Description
    Stable event identifier. Deduplicate deliveries with this value.
  • Name
    webhook-timestamp
    Type
    header integer
    Description
    Unix timestamp in seconds for the delivery attempt. Reject stale timestamps to prevent replay.
  • Name
    webhook-signature
    Type
    header string
    Description
    Standard Webhooks signature header. Verify it against `webhook-id`, `webhook-timestamp`, and the exact raw request body.

Request body

  • Name
    application/json
    Type
    WebhookPayload
    Description
    Required body.

Payload variants

  • Name
    contact.created
    Type
    ContactCreatedWebhookEvent
    Description
  • Name
    contact.updated
    Type
    ContactUpdatedWebhookEvent
    Description
  • Name
    contact.archived
    Type
    ContactArchivedWebhookEvent
    Description
  • Name
    conversation.started
    Type
    ConversationStartedWebhookEvent
    Description
  • Name
    conversation.updated
    Type
    ConversationUpdatedWebhookEvent
    Description
  • Name
    conversation.closed
    Type
    ConversationClosedWebhookEvent
    Description
  • Name
    message.created
    Type
    MessageCreatedWebhookEvent
    Description
  • Name
    message.updated
    Type
    MessageUpdatedWebhookEvent
    Description

Responses

  • 2XX

    Event accepted