Skip to navigation

Send a simulated webhook event

Beta

Sends the sample payload of an event type to one of your webhook subscriptions right away so you can test a new or changed endpoint without waiting for a real event. The webhook must be enabled and subscribed to the event type. Each organization can simulate each event type up to 10 times per hour.

Token scopes: webhooks:write

Beta: this version requires the X-Beta: true request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-01-28.

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

webhook_idstringRequired
Unique identifier of the webhook subscription.

Headers

X-BetaenumRequiredDefaults to true

Opts in to the beta version of this endpoint. Must be true.

Allowed values:

Request

This endpoint expects an object.
dataobjectRequired
The event to simulate.

Response

The sample event was sent; the delivery attempt is returned.

dataobject

Errors

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