Inquirly

Update a webhook object

PATCH

/api/v1/accounts/{account_id}/webhooks/{webhook_id}

Webhooks

Update a webhook object in the account

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/api/v1/accounts//webhooks/' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
    "url": "string",
    "subscriptions": [
        "conversation_created"
    ]
}'

Response Example

200 - Example 1

{
    "id": 0,
    "url": "string",
    "subscriptions": [
        "conversation_created"
    ],
    "account_id": 0
}

Request

Path Params

account_id

integer

required

The numeric ID of the account

webhook_id

string

required

Body Params application/json; charset=utf-8

url

string

optional

The url where the events should be sent

subscriptions

array[string]

optional

The events you want to subscribe to.

Allowed values:

conversation_createdconversation_status_changedconversation_updatedmessage_createdmessage_updatedwebwidget_triggered

Examples

Responses

🟢200OK

application/json; charset=utf-8

Success

Body

number

optional

The ID of the webhook

url

string

optional

The url to which the events will be send

subscriptions

array[string]

optional

The list of subscribed events

Allowed values:

conversation_createdconversation_status_changedconversation_updatedcontact_createdcontact_updatedmessage_createdmessage_updatedwebwidget_triggered

account_id

number

optional

The id of the account which the webhook object belongs to

🟠401Unauthorized

Add a webhook

Delete a webhook