---
title: "Create webhook"
method: POST
path: "/settings/v1/webhooks"
tags: ["Settings:v1:Webhook"]
---

# Create webhook

`POST /settings/v1/webhooks`

Create individual webhook settings under specified details

## Request body

- WebhookCreateRequest
  - `name` string, required — The name of the webhook
  - `url` string, uri, required — The specified endpoint url the payload will be sent to when the event is triggered. Must be a valid https endpoint.
  - `secretKey` string, nullable — The secret key for this webhook
  - `isDisabled` boolean — Determines whether the webhook settings is disabled or enabled upon creation. Default to enabled.
  - `featureType` string, required — The feature type of the webhook. Current options are: users, forms, time_activity, tasks
  - `entityId` string, 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.
  - `objectId` integer, nullable — Deprecated. Use `entity_id` instead. Kept for backward compatibility.
  - `eventTypes` string[], required — The event types under the specified feature type. The list of events is available in the Guides section or on the platform.
  - `webhookVersion` integer — The version of the webhook payload schema. Defaults to 1.

## Response `200`

Successful Response

- APIResponseV2PublicBaseWebhookResponse
  - `requestId` string
  - `data` PublicBaseWebhookResponse, required
    - `id` integer, required — The unique identifier of the webhook
    - `name` string, required — The name of the webhook
    - `userId` integer, required — Webhook creator's user id
    - `timeCreated` integer, required — The timestamp when the webhook was created
    - `url` string, uri, required — The webhook's URL
    - `isDisabled` boolean, required — The webhook's disabled status
    - `featureType` string, required — The webhook's feature type
    - `entityId` string, nullable — The webhook's entity id as a string. `null` for broadcast webhooks.
    - `objectId` integer, nullable — Deprecated. The legacy numeric object id for this webhook.
    - `retryLimit` integer, required — The webhook's retry limit
    - `eventTypes` string[], required — The webhook's event types
    - `webhookVersion` integer — The version of the webhook payload schema

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/connecteam/apis/connecteam-api-documentation.md) · [All operations](https://skmtc.net/connecteam/apis/connecteam-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/connecteam/connecteam-api-documentation/revisions/d8f7f302222e/schema)