API Reference

Create webhook

post
https://api.connecteam.com/settings/v1/webhooks

Create individual webhook settings under specified details

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Create data for new webhook

string
required

The name of the webhook

uri
required
length ≥ 1

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

The secret key for this webhook

boolean
Defaults to false

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

string
required

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

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.

deprecated

Deprecated. Use entity_id instead. Kept for backward compatibility.

eventTypes
array of strings
required
length ≥ 1

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

Eventtypes*
integer
Defaults to 1

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

Responses

Updated 26 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 26 days ago