Skip to content

Deel: Webhooks schemas

14 Deel schemas with complete fields and constraints.

← Webhooks operations · All schemas

Create a webhook — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootThe webhook subscription.
api_versionstringRequired within parentDeel API version. Currently Deel accepts v1 or v2.
Default: v2
created_atstringRequired within parentTime at which the webhook was created.
deleted_atJSONOptional
deleted_at (anyOf 1)stringAlternativeTime at which the webhook was deleted.
deleted_at (anyOf 2)nullAlternativeTime at which the webhook was deleted.
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeWebhook subscription description.
description (anyOf 2)nullAlternativeWebhook subscription description.
eventsarrayRequired within parentThe list of events to enable for this subscription.
events[]stringEach item
hiddenJSONOptional
hidden (anyOf 1)booleanAlternativeWhether to hide the webhook from the frontend view (commonly used by Deel third-party apps).
hidden (anyOf 2)nullAlternativeWhether to hide the webhook from the frontend view (commonly used by Deel third-party apps).
idstringRequired within parentUnique identifier of this resource.
include_child_orgsJSONOptional
include_child_orgs (anyOf 1)booleanAlternativeWhen true, the webhook will also receive events from child organizations.
include_child_orgs (anyOf 2)nullAlternativeWhen true, the webhook will also receive events from child organizations.
internalbooleanOptionalIndicates whether the webhook is internal to Deel.
nameJSONRequired within parent
name (anyOf 1)stringAlternativeWebhook subscription name.
name (anyOf 2)nullAlternativeWebhook subscription name.
signing_keyJSONRequired within parent
signing_key (anyOf 1)stringAlternativeThe webhook's signing key, used to generate webhook signatures.
signing_key (anyOf 2)nullAlternativeThe webhook's signing key, used to generate webhook signatures.
statusstringRequired within parentStatus of webhook.
Known values: enabled, disabled
updated_atstringRequired within parentTime at which the webhook was updated.
urlstringRequired within parentEndpoint to receive webhook.

Delete a webhook — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootThe result of the delete operation.
deletedbooleanRequired within parentConfirms the deletion.

List webhook event types — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptionalThe list of webhook event types.
data[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalTime at which the event type was created.
descriptionstringRequired within parentDescribes the webhook event and other pertinent info.
idJSONRequired within parent
id (anyOf 1)numberAlternativeEvent type unique identifier.
Format: double
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
module_labelstringRequired within parentDisplay name of the rabbit queue in Deel UI.
module_namestringRequired within parentName of the rabbit queue.
namestringRequired within parentName of the webhook event.
payload_exampleJSONOptional
payload_example (anyOf 1)stringAlternativeJSON payload example of the specific event.
payload_example (anyOf 2)nullAlternativeJSON payload example of the specific event.
updated_atstringOptionalTime at which the event type was updated.

List webhooks — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
cursorJSONRequired within parent
cursor (anyOf 1)stringAlternativeCursor for the next page; pass it as the `cursor` query parameter. Null when there are no more results.
cursor (anyOf 2)nullAlternativeCursor for the next page; pass it as the `cursor` query parameter. Null when there are no more results.
dataarrayRequired within parentThe list of webhook subscriptions.
data[]ModelEach itemExpand List webhooks — 200 response body — data item

Referenced models: List webhooks — 200 response body — data item

List webhooks — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
api_versionstringRequired within parentDeel API version. Currently Deel accepts v1 or v2.
Default: v2
created_atstringRequired within parentTime at which the webhook was created.
deleted_atJSONOptional
deleted_at (anyOf 1)stringAlternativeTime at which the webhook was deleted.
deleted_at (anyOf 2)nullAlternativeTime at which the webhook was deleted.
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeWebhook subscription description.
description (anyOf 2)nullAlternativeWebhook subscription description.
eventsarrayRequired within parentThe list of events to enable for this subscription.
events[]stringEach item
hiddenJSONOptional
hidden (anyOf 1)booleanAlternativeWhether to hide the webhook from the frontend view (commonly used by Deel third-party apps).
hidden (anyOf 2)nullAlternativeWhether to hide the webhook from the frontend view (commonly used by Deel third-party apps).
idstringRequired within parentUnique identifier of this resource.
include_child_orgsJSONOptional
include_child_orgs (anyOf 1)booleanAlternativeWhen true, the webhook will also receive events from child organizations.
include_child_orgs (anyOf 2)nullAlternativeWhen true, the webhook will also receive events from child organizations.
internalbooleanOptionalIndicates whether the webhook is internal to Deel.
nameJSONRequired within parent
name (anyOf 1)stringAlternativeWebhook subscription name.
name (anyOf 2)nullAlternativeWebhook subscription name.
signing_keyJSONRequired within parent
signing_key (anyOf 1)stringAlternativeThe webhook's signing key, used to generate webhook signatures.
signing_key (anyOf 2)nullAlternativeThe webhook's signing key, used to generate webhook signatures.
statsModelOptionalExpand List webhooks — 200 response body — data item stats
Delivery health for the last 7 days. Present only when `include=stats` is sent.
statusstringRequired within parentStatus of webhook.
Known values: enabled, disabled
updated_atstringRequired within parentTime at which the webhook was updated.
urlstringRequired within parentEndpoint to receive webhook.

Referenced models: List webhooks — 200 response body — data item stats

List webhooks — 200 response body — data item stats

FieldTypePresenceDescription and constraints
$objectRootDelivery health for the last 7 days. Present only when `include=stats` is sent.
dailyarrayRequired within parentPer UTC day totals, oldest first.
daily[]ModelEach itemExpand List webhooks — 200 response body — data item stats daily item
failedJSONRequired within parent
failed (anyOf 1)integerAlternativeFailed delivery attempts in the window.
failed (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
p95_latency_msJSONRequired within parent
p95_latency_ms (anyOf 1)JSONAlternative
p95_latency_ms (anyOf 1) (anyOf 1)numberAlternative95th percentile delivery latency in milliseconds.
Format: double
p95_latency_ms (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
p95_latency_ms (anyOf 2)nullAlternative95th percentile delivery latency in milliseconds.
Format: double
succeededJSONRequired within parent
succeeded (anyOf 1)integerAlternativeSuccessful delivery attempts in the window.
succeeded (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
success_rateJSONRequired within parent
success_rate (anyOf 1)JSONAlternative
success_rate (anyOf 1) (anyOf 1)numberAlternativeSuccess percentage (0-100, one decimal); null when nothing was delivered.
Format: double
success_rate (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
success_rate (anyOf 2)nullAlternativeSuccess percentage (0-100, one decimal); null when nothing was delivered.
Format: double
totalJSONRequired within parent
total (anyOf 1)integerAlternativeDelivery attempts in the window.
total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
window_daysJSONRequired within parent
window_days (anyOf 1)integerAlternativeNumber of days covered.
window_days (anyOf 2)stringAlternativePattern: ^-?[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

FieldTypePresenceDescription and constraints
$objectRoot
datestringRequired within parentUTC day, `YYYY-MM-DD`.
succeededJSONRequired within parent
succeeded (anyOf 1)integerAlternativeSuccessful delivery attempts on this day.
succeeded (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
totalJSONRequired within parent
total (anyOf 1)integerAlternativeDelivery attempts on this day.
total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Send a simulated webhook event — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
deliveryJSONRequired within parentThe delivery attempt made to your endpoint, or null when no delivery was made.
delivery (anyOf 1)ModelAlternativeExpand Send a simulated webhook event — 200 response body — data / delivery / status: success, failed
delivery (anyOf 2)nullAlternative
is_successbooleanRequired within parentTrue 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

FieldTypePresenceDescription and constraints
$objectRootThe delivery attempt made to your endpoint, or null when no delivery was made.
attempt_idJSONRequired within parent
attempt_id (anyOf 1)JSONAlternative
attempt_id (anyOf 1) (anyOf 1)integerAlternativeUnique identifier of the delivery attempt.
attempt_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
attempt_id (anyOf 2)nullAlternativeUnique identifier of the delivery attempt.
duration_msJSONRequired within parent
duration_ms (anyOf 1)JSONAlternative
duration_ms (anyOf 1) (anyOf 1)integerAlternativeTime your endpoint took to answer, in milliseconds.
duration_ms (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
duration_ms (anyOf 2)nullAlternativeTime your endpoint took to answer, in milliseconds.
response_status_codeJSONRequired within parent
response_status_code (anyOf 1)JSONAlternative
response_status_code (anyOf 1) (anyOf 1)integerAlternativeHTTP status code your endpoint answered with, or null when it did not answer.
response_status_code (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
response_status_code (anyOf 2)nullAlternativeHTTP status code your endpoint answered with, or null when it did not answer.
statusstringRequired within parentOutcome of the delivery attempt.
Known values: success, failed

Send a simulated webhook event — request body — body data

FieldTypePresenceDescription and constraints
$objectRootThe event to simulate.
event_typestringRequired within parentName of the event type to simulate. The webhook must be subscribed to it.

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.