> This page is for API, version 2026-01-01 (Stable) (default). > For other versions, use one of these documentation indexes: > - 2026-01-01 (Stable) (default): https://developer.deel.com/api/stable/llms.txt > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developer.deel.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.deel.com/_mcp/server. # Send a simulated webhook event POST https://api.letsdeel.com/rest/webhooks/{webhook_id}/simulate Content-Type: application/json 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. Reference: https://developer.deel.com/api/reference/endpoints/webhooks/simulate-webhook-by-id-v-2026-10-28 ## Authentication - `Authorization` header (bearer token, required) — ## 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 curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication) - `Authorization` header (bearer token, required) — Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/ ## Servers - `https://api.letsdeel.com/rest` (Production, default) - `https://api-staging.letsdeel.com/rest` (Demo) ## Request ### Path parameters - `webhook_id` (string, required) — Unique identifier of the webhook subscription. ### Headers - `X-Beta` (enum, required, default: true) — Opts in to the beta version of this endpoint. Must be `true`. - Allowed values: `true` ### Body (application/json) This endpoint expects an object. - `data` (WebhooksWebhookIdSimulatePostRequestBodyContentApplicationJsonSchemaData, required) — The event to simulate. ## Response ### 200 The sample event was sent; the delivery attempt is returned. - `data` (WebhooksWebhookIdSimulatePostResponsesContentApplicationJsonSchemaData, required) ## Errors ### 400 Bad Request Error Bad Request. The webhook is disabled, is not subscribed to the event type, or the event type cannot be simulated. - `errors` (list of WebhooksWebhookIdSimulatePostResponsesContentApplicationJsonSchemaErrorsItems, required) — The list of errors that caused the request to fail. ### 401 Unauthorized Error Unauthorized. Authentication credentials were missing or invalid. - `errors` (list of WebhooksWebhookIdSimulatePostResponsesContentApplicationJsonSchemaErrorsItems, required) — The list of errors that caused the request to fail. ### 403 Forbidden Error Forbidden. You do not have permission to access this resource. - `errors` (list of WebhooksWebhookIdSimulatePostResponsesContentApplicationJsonSchemaErrorsItems, required) — The list of errors that caused the request to fail. ### 404 Not Found Error Not Found. No webhook with this id exists in your organization, or the event type has no sample payload. - `errors` (list of WebhooksWebhookIdSimulatePostResponsesContentApplicationJsonSchemaErrorsItems, required) — The list of errors that caused the request to fail. ### 429 Too Many Requests Error Too Many Requests. The organization has already simulated this event type 10 times in the last hour. - `errors` (list of WebhooksWebhookIdSimulatePostResponsesContentApplicationJsonSchemaErrorsItems, required) — The list of errors that caused the request to fail. ### 500 Internal Server Error Internal Server Error. An unexpected error occurred. - `errors` (list of WebhooksWebhookIdSimulatePostResponsesContentApplicationJsonSchemaErrorsItems, required) — The list of errors that caused the request to fail. ## Types ### WebhooksWebhookIdSimulatePostRequestBodyContentApplicationJsonSchemaData The event to simulate. - `event_type` (string, required) — Name of the event type to simulate. The webhook must be subscribed to it. ### WebhooksWebhookIdSimulatePostResponsesContentApplicationJsonSchemaData - `delivery` (WebhooksWebhookIdSimulatePostResponsesContentApplicationJsonSchemaDataDelivery, required, nullable) — The delivery attempt made to your endpoint, or null when no delivery was made. - `is_success` (boolean, required) — True when your endpoint accepted the delivery. ### WebhooksWebhookIdSimulatePostResponsesContentApplicationJsonSchemaErrorsItems - `code` (string, required) — Machine-readable error code. - `message` (string, required) — Human-readable description of the error. - `details` (WebhooksWebhookIdSimulatePostResponsesContentApplicationJsonSchemaErrorsItemsDetails, optional) — Additional information about the error, when available. ### WebhooksWebhookIdSimulatePostResponsesContentApplicationJsonSchemaDataDelivery The delivery attempt made to your endpoint, or null when no delivery was made. - `status` (enum, required) — Outcome of the delivery attempt. - Allowed values: `success`, `failed` - `attempt_id` (integer, required, nullable) — Unique identifier of the delivery attempt. - `duration_ms` (integer, required, nullable) — Time your endpoint took to answer, in milliseconds. - `response_status_code` (integer, required, nullable) — HTTP status code your endpoint answered with, or null when it did not answer. ### WebhooksWebhookIdSimulatePostResponsesContentApplicationJsonSchemaErrorsItemsDetails Additional information about the error, when available. ## Examples **Request** ```json { "data": { "event_type": "contract.created" } } ``` **Response** ```json { "data": { "delivery": { "status": "success", "attempt_id": 987, "duration_ms": 118, "response_status_code": 200 }, "is_success": true } } ``` **SDK Code** ```python import requests url = "https://api.letsdeel.com/rest/webhooks/00000000-0000-0000-0000-000000000000/simulate" payload = { "data": { "event_type": "contract.created" } } headers = { "X-Beta": "true", "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.letsdeel.com/rest/webhooks/00000000-0000-0000-0000-000000000000/simulate'; const options = { method: 'POST', headers: { 'X-Beta': 'true', Authorization: 'Bearer ', 'Content-Type': 'application/json' }, body: '{"data":{"event_type":"contract.created"}}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.letsdeel.com/rest/webhooks/00000000-0000-0000-0000-000000000000/simulate" payload := strings.NewReader("{\n \"data\": {\n \"event_type\": \"contract.created\"\n }\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("X-Beta", "true") req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.letsdeel.com/rest/webhooks/00000000-0000-0000-0000-000000000000/simulate") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["X-Beta"] = 'true' request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"data\": {\n \"event_type\": \"contract.created\"\n }\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.letsdeel.com/rest/webhooks/00000000-0000-0000-0000-000000000000/simulate") .header("X-Beta", "true") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"data\": {\n \"event_type\": \"contract.created\"\n }\n}") .asString(); ``` ```php request('POST', 'https://api.letsdeel.com/rest/webhooks/00000000-0000-0000-0000-000000000000/simulate', [ 'body' => '{ "data": { "event_type": "contract.created" } }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', 'X-Beta' => 'true', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.letsdeel.com/rest/webhooks/00000000-0000-0000-0000-000000000000/simulate"); var request = new RestRequest(Method.POST); request.AddHeader("X-Beta", "true"); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"data\": {\n \"event_type\": \"contract.created\"\n }\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "X-Beta": "true", "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["data": ["event_type": "contract.created"]] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.letsdeel.com/rest/webhooks/00000000-0000-0000-0000-000000000000/simulate")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```