The API reference moved here from eksis.io/developers.
Webhooks

Update a webhook endpoint

PATCH
/v1/webhooks/{webhookId}

Change the address, the description, or the events, or turn the endpoint off and on. Turning it back on clears its failure count. Events from while it was off are not sent again. Needs a key with the admin role.

Authorization

headerAuthorizationBearer <token>

Send your key as Authorization: Bearer eksis_sk_....

Path Parameters

webhookId*string

Request Body

application/json
  1. body
url?string
Formaturi
Lengthlength <= 2048
description?|
Lengthlength <= 120
events?array<>

The events to receive. New event types are never added to an endpoint on their own.

Items1 <= items
enabled?boolean

Response Body

The endpoint after the change.

application/json
  1. response
data?
curl -X PATCH 'https://api.eksis.io/v1/webhooks/string' \  -H 'Authorization: Bearer eksis_sk_...' \  -H 'Content-Type: application/json' \  -d '{}'
{  "data": {    "id": "string",    "url": "http://example.com",    "description": "string",    "events": [      "post.target.published"    ],    "status": "active",    "disabledReason": "manual",    "secretPrefix": "string",    "consecutiveFailures": 0,    "lastSuccessAt": "2019-08-24T14:15:22Z",    "lastFailureAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z"  }}