Deel: Webhooks schemas
14 Deel schemas with complete fields and constraints.
← Webhooks operations · All schemas
Create a webhook — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create a webhook — 201 response body — data The webhook subscription. |
Referenced models: Create a webhook — 201 response body — data
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. 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 | Whether to hide the webhook from the frontend view (commonly used by Deel third-party apps). |
hidden (anyOf 2) | null | Alternative | Whether to hide the webhook from the frontend view (commonly used by Deel third-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. |
Delete a webhook — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Delete a webhook — 200 response body — data The result of the delete operation. |
Referenced models: Delete a webhook — 200 response body — data
Delete a webhook — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The result of the delete operation. |
deleted | boolean | Required within parent | Confirms the deletion. |
List webhook event types — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | The list of webhook event types. |
data[] | Model | Each item | Expand List webhook event types — 200 response body — data item |
Referenced models: List webhook event types — 200 response body — data item
List webhook event types — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | Time at which the event type was created. |
description | string | Required within parent | Describes the webhook event and other pertinent info. |
id | JSON | Required within parent | |
id (anyOf 1) | number | Alternative | Event type unique identifier. Format: double |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
module_label | string | Required within parent | Display name of the rabbit queue in Deel UI. |
module_name | string | Required within parent | Name of the rabbit queue. |
name | string | Required within parent | Name of the webhook event. |
payload_example | JSON | Optional | |
payload_example (anyOf 1) | string | Alternative | JSON payload example of the specific event. |
payload_example (anyOf 2) | null | Alternative | JSON payload example of the specific event. |
updated_at | string | Optional | Time at which the event type was updated. |
List webhooks — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cursor | JSON | Required within parent | |
cursor (anyOf 1) | string | Alternative | Cursor for the next page; pass it as the `cursor` query parameter. Null when there are no more results. |
cursor (anyOf 2) | null | Alternative | Cursor for the next page; pass it as the `cursor` query parameter. Null when there are no more results. |
data | array | Required within parent | The list of webhook subscriptions. |
data[] | Model | Each item | Expand List webhooks — 200 response body — data item |
Referenced models: List webhooks — 200 response body — data item
List webhooks — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
api_version | string | Required within parent | Deel API version. Currently Deel accepts v1 or v2. 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 | Whether to hide the webhook from the frontend view (commonly used by Deel third-party apps). |
hidden (anyOf 2) | null | Alternative | Whether to hide the webhook from the frontend view (commonly used by Deel third-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. |
stats | Model | Optional | Expand List webhooks — 200 response body — data item stats Delivery health for the last 7 days. Present only when `include=stats` is sent. |
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. |
Referenced models: List webhooks — 200 response body — data item stats
List webhooks — 200 response body — data item stats
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Delivery health for the last 7 days. Present only when `include=stats` is sent. |
daily | array | Required within parent | Per UTC day totals, oldest first. |
daily[] | Model | Each item | Expand List webhooks — 200 response body — data item stats daily item |
failed | JSON | Required within parent | |
failed (anyOf 1) | integer | Alternative | Failed delivery attempts in the window. |
failed (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
p95_latency_ms | JSON | Required within parent | |
p95_latency_ms (anyOf 1) | JSON | Alternative | |
p95_latency_ms (anyOf 1) (anyOf 1) | number | Alternative | 95th percentile delivery latency in milliseconds. Format: double |
p95_latency_ms (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
p95_latency_ms (anyOf 2) | null | Alternative | 95th percentile delivery latency in milliseconds. Format: double |
succeeded | JSON | Required within parent | |
succeeded (anyOf 1) | integer | Alternative | Successful delivery attempts in the window. |
succeeded (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
success_rate | JSON | Required within parent | |
success_rate (anyOf 1) | JSON | Alternative | |
success_rate (anyOf 1) (anyOf 1) | number | Alternative | Success percentage (0-100, one decimal); null when nothing was delivered. Format: double |
success_rate (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
success_rate (anyOf 2) | null | Alternative | Success percentage (0-100, one decimal); null when nothing was delivered. Format: double |
total | JSON | Required within parent | |
total (anyOf 1) | integer | Alternative | Delivery attempts in the window. |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
window_days | JSON | Required within parent | |
window_days (anyOf 1) | integer | Alternative | Number of days covered. |
window_days (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: List webhooks — 200 response body — data item stats daily item
List webhooks — 200 response body — data item stats daily item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
date | string | Required within parent | UTC day, `YYYY-MM-DD`. |
succeeded | JSON | Required within parent | |
succeeded (anyOf 1) | integer | Alternative | Successful delivery attempts on this day. |
succeeded (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total | JSON | Required within parent | |
total (anyOf 1) | integer | Alternative | Delivery attempts on this day. |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Send a simulated webhook event — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Send a simulated webhook event — 200 response body — data |
Referenced models: Send a simulated webhook event — 200 response body — data
Send a simulated webhook event — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
delivery | JSON | Required within parent | The delivery attempt made to your endpoint, or null when no delivery was made. |
delivery (anyOf 1) | Model | Alternative | Expand Send a simulated webhook event — 200 response body — data / delivery / status: success, failed |
delivery (anyOf 2) | null | Alternative | |
is_success | boolean | Required within parent | True when your endpoint accepted the delivery. |
Referenced models: Send a simulated webhook event — 200 response body — data / delivery / status: success, failed
Send a simulated webhook event — 200 response body — data / delivery / status: success, failed
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The delivery attempt made to your endpoint, or null when no delivery was made. |
attempt_id | JSON | Required within parent | |
attempt_id (anyOf 1) | JSON | Alternative | |
attempt_id (anyOf 1) (anyOf 1) | integer | Alternative | Unique identifier of the delivery attempt. |
attempt_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
attempt_id (anyOf 2) | null | Alternative | Unique identifier of the delivery attempt. |
duration_ms | JSON | Required within parent | |
duration_ms (anyOf 1) | JSON | Alternative | |
duration_ms (anyOf 1) (anyOf 1) | integer | Alternative | Time your endpoint took to answer, in milliseconds. |
duration_ms (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
duration_ms (anyOf 2) | null | Alternative | Time your endpoint took to answer, in milliseconds. |
response_status_code | JSON | Required within parent | |
response_status_code (anyOf 1) | JSON | Alternative | |
response_status_code (anyOf 1) (anyOf 1) | integer | Alternative | HTTP status code your endpoint answered with, or null when it did not answer. |
response_status_code (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
response_status_code (anyOf 2) | null | Alternative | HTTP status code your endpoint answered with, or null when it did not answer. |
status | string | Required within parent | Outcome of the delivery attempt. Known values: success, failed |
Send a simulated webhook event — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The event to simulate. |
event_type | string | Required within parent | Name of the event type to simulate. The webhook must be subscribed to it. |