Create a webhook

POST

/webhooks

POST

/rest/webhooks

$ curl -X POST https://api.letsdeel.com/rest/webhooks \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "body": {
>     "name": "New Contract Webhook",
>     "description": "Webhook to notify when a contract is created.",
>     "status": "enabled",
>     "url": "https://hooks.myapp.com/webhook/contract-created",
>     "signing_key": "a3f5d9e8b7c6d4e2f1a0b9c8d7e6f5a4",
>     "api_version": "v2",
>     "events": [
>       "contract.created"
>     ]
>   }
> }'

1 {
2   "data": {
3     "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
4     "url": "https://hooks.myapp.com/webhook/contract-created",
5     "name": "New Contract Webhook",
6     "events": [
7       "contract.created"
8     ],
9     "status": "enabled",
10     "created_at": "2024-06-10T09:15:00Z",
11     "updated_at": "2024-06-10T09:15:00Z",
12     "api_version": "v2",
13     "description": "Webhook to notify when a contract is created.",
14     "signing_key": "a3f5d9e8b7c6d4e2f1a0b9c8d7e6f5a4",
15     "hidden": false,
16     "internal": true,
17     "deleted_at": null
18   }
19 }

Create a new webhooks subscription. Token scopes: webhooks:write

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/

Request

This endpoint expects an object.

urlstringRequired

Endpoint to receive webhook.

namestring or nullRequired

Webhook subscription name.

eventslist of stringsRequired

The list of events to enable for this subscription.

statusenumRequired

Status of webhook.

Allowed values:

api_versionstringRequiredDefaults to v2

Deel API version. Only v2 is accepted.

descriptionstring or nullRequired

Webhook subscription description.

signing_keystring or nullOptional32-128 characters

The webhook’s signing key, used to generate webhook signatures. Auto-generated if omitted.

Response

successful operation

dataobject

The webhook subscription.

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

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