chatwoot

← All modules

4 endpoints.

POST /api/v1/webhooks/chatwoot

Receive Webhook

200 — Successful Response

{
  "additionalProperties": true,
  "type": "object",
  "title": "Response Receive Webhook Api V1 Webhooks Chatwoot Post"
}

---

GET /api/v1/chatwoot/webhook-info

Webhook Info

The URL + secret to paste into Chatwoot's webhook settings — auto- provisions a secret on first call so there's nothing to generate by hand.

200 — Successful Response

{
  "additionalProperties": true,
  "type": "object",
  "title": "Response Webhook Info Api V1 Chatwoot Webhook Info Get"
}

---

POST /api/v1/customers/{customer_id}/chatwoot-link

Link Customer

Parameters

Name	In	Required	Type	Description
customer_id	path	yes	integer

Request body

{
  "properties": {
    "chatwoot_contact_id": {
      "type": "integer",
      "title": "Chatwoot Contact Id"
    }
  },
  "type": "object",
  "required": [
    "chatwoot_contact_id"
  ],
  "title": "ChatwootLinkIn"
}

200 — Successful Response

{
  "type": "object",
  "additionalProperties": true,
  "title": "Response Link Customer Api V1 Customers  Customer Id  Chatwoot Link Post"
}

422 — Validation Error

{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

---

POST /api/v1/crm/contacts/{contact_id}/chatwoot-link

Link Contact

Parameters

Name	In	Required	Type	Description
contact_id	path	yes	integer

Request body

{
  "properties": {
    "chatwoot_contact_id": {
      "type": "integer",
      "title": "Chatwoot Contact Id"
    }
  },
  "type": "object",
  "required": [
    "chatwoot_contact_id"
  ],
  "title": "ChatwootLinkIn"
}

200 — Successful Response

{
  "type": "object",
  "additionalProperties": true,
  "title": "Response Link Contact Api V1 Crm Contacts  Contact Id  Chatwoot Link Post"
}

422 — Validation Error

{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}