Skip to main content
GET
/
api
/
v1
/
accounts
/
{account_id}
/
webhooks
List all webhooks
curl --request GET \
  --url https://app.chatwoot.com/api/v1/accounts/{account_id}/webhooks \
  --header 'api_access_token: <api-key>'
[
  {
    "id": 123,
    "url": "<string>",
    "name": "<string>",
    "subscriptions": [],
    "secret": "<string>",
    "account_id": 123
  }
]

Authorizations

​
api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

​
account_id
integer
required

The numeric ID of the account

Response

Success

​
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
enum<string>[]

The list of subscribed events

Available options:
conversation_created,
conversation_status_changed,
conversation_updated,
contact_created,
contact_updated,
message_created,
message_updated,
webwidget_triggered,
conversation_typing_on,
conversation_typing_off
​
secret
string | null

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
number

The id of the account which the webhook object belongs to