Biklo for developersTESTsandbox-api.biklo.comchange

Delivery log

GET/v1/webhooks/{id}/deliveries

scope webhooks.manage

What happened to every event we sent you — the answer to "we never got the order".

Query parameters#

NameExample
status—pending | delivered | failed | abandoned

Response#

FieldTypeDescription
countintegerHow many deliveries in this page.
dataarrayWhat we tried to send to this endpoint, newest first. This is where to look when your receiver did not get something.
data[].idintegerThe delivery id, for POST /v1/webhooks/deliveries/{deliveryId}/replay.
data[].eventstringWhich event it carried.
data[].event_idstringA stable id for the EVENT itself. The same event to two endpoints shares it, and a replay keeps it — so use it to make your handler idempotent rather than the delivery id.
data[].statusstringdelivered is a 2xx from your server. pending means it is queued or waiting on a backoff. failed means every retry was used up.

Accepts pending · delivered · failed

data[].attemptsintegerHow many times we have tried. Retries back off at 1, 5, 30, 120, 360 and 1440 minutes, then stop — a struggling server is not worth hammering.
data[].response_statusinteger|nullThe HTTP status your server returned, or null if it could not be reached at all. The two are worth telling apart.

Example

{
    "count": 1,
    "data": [
        {
            "id": 3,
            "event": "order.created",
            "event_id": "evt_vlvslhcxut3gj4oikfnqyf7n",
            "status": "delivered",
            "attempts": 1,
            "response_status": 200
        }
    ]
}

Failures use the shared error envelope — a machine-readable code and a request_id to quote to support. Error handling.

curl -X GET "https://sandbox-api.biklo.com/v1/webhooks/711/deliveries" \
  -H "Authorization: Bearer bk_test_YOUR_KEY"
<?php

$ch = curl_init('https://sandbox-api.biklo.com/v1/webhooks/711/deliveries');

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST  => 'GET',
    CURLOPT_HTTPHEADER     => [
        'Authorization: Bearer bk_test_YOUR_KEY',
    ],
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);

using System.Net.Http;
using System.Net.Http.Headers;

var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", "bk_test_YOUR_KEY");

var request = new HttpRequestMessage(
    new HttpMethod("GET"),
    "https://sandbox-api.biklo.com/v1/webhooks/711/deliveries");

var response = await client.SendAsync(request);
var json = await response.Content.ReadAsStringAsync();

import requests

response = requests.get(
    "https://sandbox-api.biklo.com/v1/webhooks/711/deliveries",
    headers={"Authorization": "Bearer bk_test_YOUR_KEY"},
)

data = response.json()

const response = await fetch("https://sandbox-api.biklo.com/v1/webhooks/711/deliveries", {
  method: "GET",
  headers: {
    Authorization: "Bearer bk_test_YOUR_KEY"
  }
});

const data = await response.json();

import java.net.http.*;
import java.net.URI;

var client = HttpClient.newHttpClient();

var request = HttpRequest.newBuilder()
    .uri(URI.create("https://sandbox-api.biklo.com/v1/webhooks/711/deliveries"))
    .header("Authorization", "Bearer bk_test_YOUR_KEY")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = client.send(request, HttpResponse.BodyHandlers.ofString());