Webhooks

Create a webhook

Creates a new webhook subscription with the specified URL, events, and configuration. Returns the created webhook, including its signing key for verifying incoming event payloads.

Token scopes: webhooks:write

post/webhooks

Request

  • Base URL: https://api.letsdeel.com/rest
  • URL: https://api.letsdeel.com/rest/webhooks
  • Auth: HTTP bearer

Request body

urlstring required

Endpoint to receive webhook.

namestring nullable required

Webhook subscription name.

eventsstring[] required

The list of events to enable for this subscription.

status'enabled' | 'disabled' required

Status of webhook.

api_versionstring required

Deel API version. Only v2 is accepted.

descriptionstring nullable required

Webhook subscription description.

signing_keystring nullable

The webhook's signing key, used to generate webhook signatures. Auto-generated if omitted.

include_child_orgsboolean nullable

When true, the webhook will also receive events from child organizations.

Response

successful operation

Changes

No recorded changes to this operation across all 1 revision of this API.