List webhooks | Deel | Documentation

curl -G https://api.letsdeel.com/rest/webhooks \
     -H "Authorization: Bearer <token>" \
     --data-urlencode _order=created_at:desc \
     -d cursor=eyJjcmVhdGVkQXQiOiIyMDI0LTAxLTAxIDEyOjAwOjAwKzAwIiwiaWQiOiJhYmMxMjMifQ \
     -d hidden=false \
     -d include=stats \
     -d limit=50 \
     -d search=mywebhook.com \
     -d status=enabled

{
  "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"
}

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

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.deel.training/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

AuthorizationBearer

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

Query parameters

limitintegerOptional1-100

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.

cursorstringOptional<=150 characters

Opaque cursor returned as cursor by the previous page. Send it to fetch the next page.

statusenumOptional

Only return webhook subscriptions with this status.

Allowed values:

hiddenbooleanOptional

Only return hidden (true) or visible (false) webhook subscriptions.

searchstringOptional<=200 characters

Case-insensitive match on the webhook subscription name or URL.

_orderstringOptionalformat: "^(name|created_at|status)(:(asc|desc))?$"

Sort as <column>[:<direction>], 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.

includeenumOptional

Set to stats to embed the delivery health of each webhook subscription for the last 7 days as stats.

Allowed values:

Response

successful operation

datalist of objects

The list of webhook subscriptions.

cursorstring or null

Cursor for the next page; pass it as the cursor query parameter. Null when there are no more results.

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