Skip to navigation
EndpointsWebhooks

Update a webhook

Updates one or more fields of an existing webhook subscription without recreating it — for example, enabling or disabling delivery, changing the events it is subscribed to, or opting it in to also receive events from child organizations. Use this after creating a webhook via POST /rest/webhooks whenever its configuration needs to change.

Token scopes: webhooks:write

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

OR
AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Path parameters

idstringRequired
Unique identifier of the webhook subscription.

Request

This endpoint expects an object.
urlstringOptional
Endpoint to receive webhook. Must use https.
namestringOptional<=128 characters
Webhook subscription name.
eventslist of stringsOptional
Replaces the list of events enabled for this subscription. Retries scheduled for removed events are cancelled.
statusenumOptional
Status of webhook.
Allowed values:
descriptionstring or nullOptional
Webhook subscription description.
include_child_orgsboolean or nullOptional
When true, the webhook will also receive events from child organizations.

Response

successful operation
dataobject
The webhook subscription.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
405
Method Not Allowed Error
429
Too Many Requests Error
500
Internal Server Error