Sluby
REST APIWebhooks

Get a webhook endpoint.

GET
/api/v1/webhooks/{id}

Authorization

bearerAuth
headerAuthorizationBearer <token>

A Sluby API key (sluby_...) sent as Authorization: Bearer <key>. Keys carry scopes: upload, read, manage.

Path Parameters

id*string

Endpoint id.

Response Body

The endpoint.

application/json
  1. response
id*string
Formatuuid
url*string
events*array<string>
is_active*boolean

False while the endpoint is paused: no events are sent to it.

created_at*string
Formatdate-time
last_delivery_at*|

When the newest delivery attempt was made; null before the first.

Formatdate-time
last_delivery_ok*|

Whether the newest attempt got a 2xx answer; null before the first. Attempts are kept for 30 days.

Example Request
curl -X GET 'https://sluby.example.com/api/v1/webhooks/string'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "url": "string",  "events": [    "string"  ],  "is_active": true,  "created_at": "2019-08-24T14:15:22Z",  "last_delivery_at": "2019-08-24T14:15:22Z",  "last_delivery_ok": true}

Send a logged delivery again. POST

Queues the stored payload of the delivery again, with the same event `id` so a receiver that already handled it can drop the repeat. It is signed with the current secret, gets a new X-Sluby-Delivery id and the usual retries, and each attempt is logged with `manual: true`. A paused endpoint answers 409.

Edit, pause or resume a webhook endpoint. PATCH

Send any of `url`, `events` and `is_active`. A new URL is checked like at registration. `is_active: false` pauses the endpoint: nothing is sent to it, and deliveries already queued for it are dropped. `is_active: true` resumes it for new events. The signing secret does not change.