Deel: Create a webhook — 201 response body — data
Create a webhook: 201 response body, field data. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Create a webhook — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The webhook subscription. |
api_version | string | Required within parent | Deel API version. Currently Deel accepts v1 or v2 version. Default: v2 |
created_at | string | Required within parent | Time at which the webhook was created. |
deleted_at | JSON | Optional | |
deleted_at (anyOf 1) | string | Alternative | Time at which the webhook was deleted. |
deleted_at (anyOf 2) | null | Alternative | Time at which the webhook was deleted. |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | Webhook subscription description. |
description (anyOf 2) | null | Alternative | Webhook subscription description. |
events | array | Required within parent | The list of events to enable for this subscription. |
events[] | string | Each item | |
hidden | JSON | Optional | |
hidden (anyOf 1) | boolean | Alternative | Property to hide the webhook from frontend view. Commonly by Deel 3rd party apps |
hidden (anyOf 2) | null | Alternative | Property to hide the webhook from frontend view. Commonly by Deel 3rd party apps |
id | string | Required within parent | Unique identifier of this resource. |
include_child_orgs | JSON | Optional | |
include_child_orgs (anyOf 1) | boolean | Alternative | When true, the webhook will also receive events from child organizations. |
include_child_orgs (anyOf 2) | null | Alternative | When true, the webhook will also receive events from child organizations. |
internal | boolean | Optional | Indicates whether the webhook is internal to Deel. |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | Webhook subscription name. |
name (anyOf 2) | null | Alternative | Webhook subscription name. |
signing_key | JSON | Required within parent | |
signing_key (anyOf 1) | string | Alternative | The webhook’s signing key, used to generate webhook signatures. |
signing_key (anyOf 2) | null | Alternative | The webhook’s signing key, used to generate webhook signatures. |
status | string | Required within parent | Status of webhook. Known values: enabled, disabled |
updated_at | string | Required within parent | Time at which the webhook was updated. |
url | string | Required within parent | Endpoint to receive webhook. |