EaserixDocs
DevelopersAPI referenceLinksWebhooks

Update a webhook

Update url, events, or active. Re-activating resets the failure count.

View as Markdown
PATCH
/v1/webhooks/{id}

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/webhooks/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "webhook": {    "id": "string",    "url": "string",    "events": [      "string"    ],    "active": true,    "failureCount": 0,    "lastStatus": 0,    "lastDelivery": "2019-08-24T14:15:22Z",    "secret": "string",    "created": "2019-08-24T14:15:22Z"  }}

Create a webhook

Registers an https endpoint for link.created/updated/deleted and link.clicked events (click events are aggregated per link per flush, not one call per click). Deliveries are signed with HMAC-SHA256 in X-Easerix-Signature ("sha256=<hex>" over the raw body). The signing secret is returned ONCE in this response. Endpoints failing 20 consecutive deliveries are auto-deactivated.

Delete a webhook

Next Page