> 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://docs.deel.wtf/api/stable/llms.txt > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.deel.wtf/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.deel.wtf/_mcp/server. # List webhooks GET https://api.letsdeel.com/rest/webhooks Lists every webhook subscription configured for the organization. Use this to find the id of a specific subscription before retrieving, updating, or deleting it, or to audit which events are currently wired up. **Token scopes**: `webhooks:read` Reference: https://docs.deel.wtf/api/endpoints/webhooks/get-webhooks ## 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.deel.training/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 ### Query parameters - `limit` (integer, optional) — Opt-in pagination: maximum number of webhook subscriptions to return in one page, newest first. Without `limit` and `cursor` every subscription is returned. `limit` has no fixed default; if you send only `cursor`, the page returns up to 100 subscriptions. - `cursor` (string, optional) — Opaque cursor returned as `cursor` by the previous page. Send it to fetch the next page. - `status` (enum, optional) — Only return webhook subscriptions with this status. - Allowed values: `enabled`, `disabled` - `hidden` (boolean, optional) — Only return hidden (`true`) or visible (`false`) webhook subscriptions. - `search` (string, optional) — Case-insensitive match on the webhook subscription name or URL. - `_order` (string, optional) — Sort as `[:]`, where column is `name`, `created_at` or `status` and direction is `asc` (default) or `desc`. Only applies when the call is not paginated (no `limit` or `cursor`); pages are always newest first. - `include` (enum, optional) — Set to `stats` to embed the delivery health of each webhook subscription for the last 7 days as `stats`. - Allowed values: `stats` ## Response ### 200 successful operation - `data` (list of WebhooksGetResponsesContentApplicationJsonSchemaDataItems, required) — The list of webhook subscriptions. - `cursor` (string, required, nullable) — Cursor for the next page; pass it as the `cursor` query parameter. Null when there are no more results. ## Errors ### 400 Bad Request Error Bad Request. The request could not be understood or was missing required parameters. - `errors` (list of WebhooksGetResponsesContentApplicationJsonSchemaErrorsItems, required) — The list of errors that caused the request to fail. ### 401 Unauthorized Error Unauthorized. Authentication credentials were missing or invalid. - `errors` (list of WebhooksGetResponsesContentApplicationJsonSchemaErrorsItems, 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 WebhooksGetResponsesContentApplicationJsonSchemaErrorsItems, required) — The list of errors that caused the request to fail. ### 404 Not Found Error Not Found. The requested resource could not be found. - `errors` (list of WebhooksGetResponsesContentApplicationJsonSchemaErrorsItems, required) — The list of errors that caused the request to fail. ### 405 Method Not Allowed Error Method Not Allowed. The HTTP method is not supported for this resource. - `errors` (list of WebhooksGetResponsesContentApplicationJsonSchemaErrorsItems, required) — The list of errors that caused the request to fail. ### 429 Too Many Requests Error Too Many Requests. The rate limit has been exceeded. - `errors` (list of WebhooksGetResponsesContentApplicationJsonSchemaErrorsItems, 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 WebhooksGetResponsesContentApplicationJsonSchemaErrorsItems, required) — The list of errors that caused the request to fail. ## Types ### WebhooksGetResponsesContentApplicationJsonSchemaDataItems - `id` (string, required) — Unique identifier of this resource. - `url` (string, required) — Endpoint to receive webhook. - `name` (string, required, nullable) — Webhook subscription name. - `events` (list of string, required) — The list of events to enable for this subscription. - `status` (enum, required) — Status of webhook. - Allowed values: `enabled`, `disabled` - `created_at` (string, required) — Time at which the webhook was created. - `updated_at` (string, required) — Time at which the webhook was updated. - `api_version` (string, required, default: v2) — Deel API version. Currently Deel accepts v1 or v2. - `description` (string, required, nullable) — Webhook subscription description. - `signing_key` (string, required, nullable) — The webhook's signing key, used to generate webhook signatures. - `stats` (WebhooksGetResponsesContentApplicationJsonSchemaDataItemsStats, optional) — Delivery health for the last 7 days. Present only when `include=stats` is sent. - `hidden` (boolean, optional, nullable) — Whether to hide the webhook from the frontend view (commonly used by Deel third-party apps). - `internal` (boolean, optional) — Indicates whether the webhook is internal to Deel. - `deleted_at` (string, optional, nullable) — Time at which the webhook was deleted. - `include_child_orgs` (boolean, optional, nullable) — When true, the webhook will also receive events from child organizations. ### WebhooksGetResponsesContentApplicationJsonSchemaErrorsItems - `message` (string, required) — Human-readable description of the error. - `error_code` (string, optional) — Machine-readable error code. ### WebhooksGetResponsesContentApplicationJsonSchemaDataItemsStats Delivery health for the last 7 days. Present only when `include=stats` is sent. - `daily` (list of WebhooksGetResponsesContentApplicationJsonSchemaDataItemsStatsDailyItems, required) — Per UTC day totals, oldest first. - `total` (integer, required) — Delivery attempts in the window. - `failed` (integer, required) — Failed delivery attempts in the window. - `succeeded` (integer, required) — Successful delivery attempts in the window. - `window_days` (integer, required) — Number of days covered. - `success_rate` (double, required, nullable) — Success percentage (0-100, one decimal); null when nothing was delivered. - `p95_latency_ms` (double, required, nullable) — 95th percentile delivery latency in milliseconds. ### WebhooksGetResponsesContentApplicationJsonSchemaDataItemsStatsDailyItems - `date` (string, required) — UTC day, `YYYY-MM-DD`. - `total` (integer, required) — Delivery attempts on this day. - `succeeded` (integer, required) — Successful delivery attempts on this day. ## Examples **Response** ```json { "data": [ { "id": "00000000-0000-0000-0000-000000000000", "url": "https://mywebhook.com/listening", "name": "My webhooks", "events": [ "contract.created" ], "status": "enabled", "created_at": "2024-01-01T12:00:00Z", "updated_at": "2024-01-02T12:00:00Z", "api_version": "v2", "description": "My first webhook", "signing_key": "abcdefghijklmnopqrstuvwxyz0123456789ABCDEFGH", "stats": { "daily": [ { "date": "2024-01-01", "total": 20, "succeeded": 19 } ], "total": 120, "failed": 2, "succeeded": 118, "window_days": 7, "success_rate": 98.3, "p95_latency_ms": 420 }, "hidden": false, "internal": false, "deleted_at": "2024-01-03T12:00:00Z", "include_child_orgs": false } ], "cursor": "string" } ``` **SDK Code** ```python import requests url = "https://api.letsdeel.com/rest/webhooks" querystring = {"_order":"created_at:desc","cursor":"eyJjcmVhdGVkQXQiOiIyMDI0LTAxLTAxIDEyOjAwOjAwKzAwIiwiaWQiOiJhYmMxMjMifQ==","hidden":"false","include":"stats","limit":"50","search":"mywebhook.com","status":"enabled"} headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://api.letsdeel.com/rest/webhooks?_order=created_at%3Adesc&cursor=eyJjcmVhdGVkQXQiOiIyMDI0LTAxLTAxIDEyOjAwOjAwKzAwIiwiaWQiOiJhYmMxMjMifQ%3D%3D&hidden=false&include=stats&limit=50&search=mywebhook.com&status=enabled'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; 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" "net/http" "io" ) func main() { url := "https://api.letsdeel.com/rest/webhooks?_order=created_at%3Adesc&cursor=eyJjcmVhdGVkQXQiOiIyMDI0LTAxLTAxIDEyOjAwOjAwKzAwIiwiaWQiOiJhYmMxMjMifQ%3D%3D&hidden=false&include=stats&limit=50&search=mywebhook.com&status=enabled" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") 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?_order=created_at%3Adesc&cursor=eyJjcmVhdGVkQXQiOiIyMDI0LTAxLTAxIDEyOjAwOjAwKzAwIiwiaWQiOiJhYmMxMjMifQ%3D%3D&hidden=false&include=stats&limit=50&search=mywebhook.com&status=enabled") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.letsdeel.com/rest/webhooks?_order=created_at%3Adesc&cursor=eyJjcmVhdGVkQXQiOiIyMDI0LTAxLTAxIDEyOjAwOjAwKzAwIiwiaWQiOiJhYmMxMjMifQ%3D%3D&hidden=false&include=stats&limit=50&search=mywebhook.com&status=enabled") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.letsdeel.com/rest/webhooks?_order=created_at%3Adesc&cursor=eyJjcmVhdGVkQXQiOiIyMDI0LTAxLTAxIDEyOjAwOjAwKzAwIiwiaWQiOiJhYmMxMjMifQ%3D%3D&hidden=false&include=stats&limit=50&search=mywebhook.com&status=enabled', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.letsdeel.com/rest/webhooks?_order=created_at%3Adesc&cursor=eyJjcmVhdGVkQXQiOiIyMDI0LTAxLTAxIDEyOjAwOjAwKzAwIiwiaWQiOiJhYmMxMjMifQ%3D%3D&hidden=false&include=stats&limit=50&search=mywebhook.com&status=enabled"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.letsdeel.com/rest/webhooks?_order=created_at%3Adesc&cursor=eyJjcmVhdGVkQXQiOiIyMDI0LTAxLTAxIDEyOjAwOjAwKzAwIiwiaWQiOiJhYmMxMjMifQ%3D%3D&hidden=false&include=stats&limit=50&search=mywebhook.com&status=enabled")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers 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() ```