Chatwoot · Schema

Webhook

Chatwoot Webhook schema

Customer-SupportMessagingLive ChatOmnichannelConversationsContactsAgentsOpen-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

webhook.json Raw ↑
{
  "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"
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/webhook"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.