Edit a webhook | Deel | Documentation

curl -X PATCH https://api.letsdeel.com/rest/v2/webhooks/id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "body": {
    "name": "Invoice Payment Webhook",
    "description": "Webhook to notify when an invoice is paid",
    "status": "enabled",
    "url": "https://hooks.example.com/invoice-payment",
    "signing_key": "a1b2c3d4e5f67890abcdef1234567890",
    "events": [
      "invoice.paid"
    ]
  }
}'

{
  "data": {
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "name": "Invoice Payment Webhook",
    "description": "Webhook to notify when an invoice is paid",
    "status": "enabled",
    "url": "https://hooks.example.com/invoice-payment",
    "signing_key": "a1b2c3d4e5f67890abcdef1234567890",
    "api_version": "v2",
    "events": [
      "invoice.paid"
    ],
    "created_at": "2024-05-10T09:15:00Z",
    "updated_at": "2024-06-01T12:00:00Z",
    "hidden": false,
    "internal": false
  }
}

Edit a webhook subscription.

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.

1 curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
2   -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/

Path parameters

idstringRequired

Request

This endpoint expects an object.

namestring or nullRequired

Webhook subscription name.

descriptionstring or nullRequired

Webhook subscription description.

statusenumRequired

Status of webhook.

Allowed values:

urlstringRequired

Endpoint to receive webhook.

signing_keystring or nullRequired

The webhook's signing key, used to generate webhook signatures.

eventslist of stringsRequired

The list of events to enable for this subscription.

api_versionstringOptionalDefaults to v2

Deel API version. Currently Deel accepts v1 or v2 version.

Response

successful operation

dataobject

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