List webhook event types | Deel

Returns all available webhook event types that can be subscribed to. Each entry includes the event name, description, and a payload example.

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

Learn more about authentication

## 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)

AuthorizationBearer

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

Response

successful operation

datalist of objectsOptional

The list of webhook event types.

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

1	{
2	"data": [
3	{
4	"id": 101,
5	"name": "invoice-adjustment.reviewed",
6	"description": "Triggered when an invoice adjustment is reviewed and approved.",
7	"module_name": "contract",
8	"module_label": "Contracts",
9	"created_at": "2023-11-15T09:30:00Z",
10	"updated_at": "2024-04-10T14:45:00Z",
11	"payload_example": "{\"invoice_id\": \"inv_12345\", \"adjustment_amount\": 150.00, \"status\": \"reviewed\"}"
12	}
13	]
14	}

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

$	curl https://api.letsdeel.com/rest/webhooks/events/types \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"