KuikCodeDocs
APIReferenceWebhooks

List a webhook's deliveries

GET
/webhooks/{id}/deliveries

Delivery attempts at one webhook, newest first.

Authorization

apiKey
AuthorizationBearer <token>

An API key from Settings, Developers: Authorization: Bearer kc_live_...

In: header

Path Parameters

id*string
Length1 <= length

Query Parameters

limit?integer

Items per page, 1 to 100.

Range1 <= value <= 100
Default50
cursor?string

The next_cursor from the previous page. Omit for the first page.

status?string

Only deliveries in this state.

Value in

  • "pending"
  • "delivered"
  • "failed"

Response Body

application/json

application/json

curl -X GET "https://example.com/webhooks/string/deliveries"
{  "data": [    {      "id": "string",      "webhookId": "string",      "eventType": "string",      "eventId": "string",      "url": "http://example.com",      "status": "pending",      "attempts": 0,      "lastStatus": 0,      "lastError": "string",      "nextRetryAt": "2019-08-24T14:15:22Z",      "deliveredAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string"}

Rotate the signing secret POST

Mints a new secret and returns it. For the next 24 hours every delivery carries two `v1` signatures, one per secret, so the receiver can switch without dropping events.

Send a test event POST

POSTs a signed sample `scan.created` (with `test: true`) to the URL and reports what the receiver answered.