Update Webhook

put

https://api.connecteam.com/settings/v1/webhooks/{webhookId}

Update an existing webhook settings by its unique ID.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

webhookId

integer

required

The unique identifier of the webhook

Body Params

Update data for new webhook

name

The name of the webhook

url

length ≥ 1

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

secretKey

The secret key for this webhook

isDisabled

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

featureType

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

entityId

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.

objectIddeprecated

Deprecated. Use entity_id instead. Kept for backward compatibility.

eventTypes

array | null

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

webhookVersion

The version of the webhook payload schema.

Responses

200Successful Response

422Validation Error