Skip to main content
POST
Create an integration hook

Authorizations

api_access_token
string
header
required

Token de usuario. Envía el valor en el header api_access_token. Lo obtienes en el perfil (GET /api/v1/profile) o al regenerarlo.

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