Inquirly

Create an integration hook

POST

/api/v1/accounts/{account_id}/integrations/hooks

Integrations

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v1/accounts//integrations/hooks' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
    "app_id": "string",
    "inbox_id": "string",
    "settings": {}
}'

Response Example

200 - Example 1

{
    "id": "string",
    "app_id": "string",
    "inbox_id": "string",
    "account_id": "string",
    "status": true,
    "hook_type": true,
    "settings": {}
}

Request

Path Params

account_id

integer

required

The numeric ID of the account

Body Params application/json; charset=utf-8

app_id

string

optional

The ID of app for which integration hook is being created

inbox_id

string

optional

The inbox ID, if the hook is an inbox hook

settings

object

optional

The settings required by the integration

Examples

Responses

🟢200OK

application/json; charset=utf-8

Success

Body

string

optional

The ID of the integration hook

app_id

string

optional

The ID of the integration app

inbox_id

string

optional

Inbox ID if its an Inbox integration

account_id

string

optional

Account ID of the integration

status

boolean

optional

Whether the integration hook is enabled for the account

hook_type

boolean

optional

Whether its an account or inbox integration hook

settings

object

optional

The associated settings for the integration

🟠401Unauthorized

List all the Integrations

Update an Integration Hook