Skip to main content
POST
/
api
/
v1
/
accounts
/
{account_id}
/
integrations
/
hooks
Create an integration hook
curl --request POST \
  --url https://app.chatwoot.com/api/v1/accounts/{account_id}/integrations/hooks \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '{
  "app_id": 1,
  "inbox_id": 1,
  "status": 1,
  "settings": {}
}'
{
  "id": "<string>",
  "app_id": "<string>",
  "inbox_id": "<string>",
  "account_id": "<string>",
  "status": true,
  "hook_type": true,
  "settings": {}
}

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

Body

application/json
​
app_id
integer

The ID of app for which integration hook is being created

Example:

1

​
inbox_id
integer

The inbox ID, if the hook is an inbox hook

Example:

1

​
status
integer

The status of the integration (0 for inactive, 1 for active)

Example:

1

​
settings
object

The settings required by the integration

Example:
{}

Response

Success

​
id
string

The ID of the integration hook

​
app_id
string

The ID of the integration app

​
inbox_id
string

Inbox ID if its an Inbox integration

​
account_id
string

Account ID of the integration

​
status
boolean

Whether the integration hook is enabled for the account

​
hook_type
boolean

Whether its an account or inbox integration hook

​
settings
object

The associated settings for the integration

⌘I