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

Create a webhook endpoint

POST
/v1/webhooks

eksis checks that the address is https and reaches the public internet, then answers with the signing secret. The secret is shown only here. Needs a key with the admin role.

Authorization

headerAuthorizationBearer <token>

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

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

Response Body

The endpoint, with its secret.

application/json
  1. response
data?
curl -X POST 'https://api.eksis.io/v1/webhooks' \  -H 'Authorization: Bearer eksis_sk_...' \  -H 'Content-Type: application/json' \  -d '{  "url": "http://example.com",  "events": [    "post.target.published"  ]}'
{  "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",    "secret": "string"  }}