v1

latestOpenAPI 3.1.02026-07-24145580597.0 KB

Settings:v1:Webhook

Create webhook

Create individual webhook settings under specified details

post/settings/v1/webhooks

Request body

namestring required

The name of the webhook

urlstring uri required

The specified endpoint url the payload will be sent to when the event is triggered. Must be a valid https endpoint.

secretKeystring nullable

The secret key for this webhook

isDisabledboolean

Determines whether the webhook settings is disabled or enabled upon creation. Default to enabled.

featureTypestring required

The feature type of the webhook. Current options are: users, forms, time_activity, tasks

entityIdstring nullable

The ID of the entity scoping this webhook, as a string. For numeric-scoped features (e.g. time activity, shift scheduler) pass the numeric ID as a string, e.g. "67". For string-scoped features (e.g. chat) pass the domain identifier directly, e.g. "conv_abc". If both entity_id and object_id are provided, entity_id wins.

objectIdinteger nullable

Deprecated. Use entity_id instead. Kept for backward compatibility.

eventTypesstring[] required

The event types under the specified feature type. The list of events is available in the Guides section or on the platform.

webhookVersioninteger

The version of the webhook payload schema. Defaults to 1.

Response

Successful Response

requestIdstring