Chatwoot · Schema

Webhook

Chatwoot Webhook schema

Customer SupportMessagingLive ChatOmni-channelConversationsContactsAgentsOpen Source

Properties

Name	Type	Description
id	number	The ID of the webhook
url	string	The url to which the events will be send
name	string	The name of the webhook
subscriptions	array	The list of subscribed events
secret	string	Secret used to sign webhook requests. Signed webhook deliveries include `X-Chatwoot-Timestamp` and `X-Chatwoot-Signature`; the signature is `sha256=` followed by the HMAC-SHA256 of `{timestamp}.{raw_r
account_id	number	The id of the account which the webhook object belongs to

View JSON Schema on GitHub

JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "The ID of the webhook"
    },
    "url": {
      "type": "string",
      "description": "The url to which the events will be send"
    },
    "name": {
      "type": "string",
      "description": "The name of the webhook"
    },
    "subscriptions": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "conversation_created",
          "conversation_status_changed",
          "conversation_updated",
          "contact_created",
          "contact_updated",
          "message_created",
          "message_updated",
          "webwidget_triggered",
          "conversation_typing_on",
          "conversation_typing_off"
        ]
      },
      "description": "The list of subscribed events"
    },
    "secret": {
      "type": "string",
      "nullable": true,
      "description": "Secret used to sign webhook requests. Signed webhook deliveries include `X-Chatwoot-Timestamp` and `X-Chatwoot-Signature`; the signature is `sha256=` followed by the HMAC-SHA256 of `{timestamp}.{raw_request_body}` using this secret. Deliveries also include `X-Chatwoot-Delivery` when a delivery id is available."
    },
    "account_id": {
      "type": "number",
      "description": "The id of the account which the webhook object belongs to"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/chatwoot/main/json-schema/webhook.json",
  "title": "Webhook",
  "description": "Chatwoot Webhook schema"
}