For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportDeel Home
OverviewPlatformEmployer of RecordContractorsGlobal PayrollHREmbeddedDeel ITAPI ReferenceChangelog
OverviewPlatformEmployer of RecordContractorsGlobal PayrollHREmbeddedDeel ITAPI ReferenceChangelog
  • Resources
    • Blog
    • Community
    • API spec
  • Platform
    • Introduction
    • Screenings
    • Immigration
  • Endpoints
      • POSTCreate a webhook
      • DELDelete a webhook
      • PATCHEdit a webhook
      • GETList of webhook event types
      • GETList of webhooks
      • GETRetrieve a single webhook
LogoLogo
SupportDeel Home
EndpointsWebhooks

List of webhook event types

GET
/webhooks/events/types
GET
/rest/v2/webhooks/events/types
$curl https://api.letsdeel.com/rest/v2/webhooks/events/types \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json"
1{
2  "data": [
3    {
4      "id": 101,
5      "module_name": "contract",
6      "module_label": "Contracts",
7      "name": "invoice-adjustment.reviewed",
8      "description": "Triggered when an invoice adjustment is reviewed and approved.",
9      "payload_example": "{\"invoice_id\": \"inv_12345\", \"adjustment_amount\": 150.00, \"status\": \"reviewed\"}",
10      "created_at": "2023-11-15T09:30:00Z",
11      "updated_at": "2024-04-10T14:45:00Z"
12    }
13  ]
14}
Retrieve a list of webhook event types.
Was this page helpful?
Previous

List of webhooks

Next
Built with

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 curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)
OR
AuthorizationBearer

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

Response

successful operation
datalist of objects

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

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.

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

Learn more about authentication