Biklo for developersTESTsandbox-api.biklo.comchange

List your endpoints

GET/v1/webhooks

scope webhooks.manage

Also returns available_events, the full list you may subscribe to.

Response#

FieldTypeDescription
countintegerHow many endpoints you have registered.
dataarrayYour webhook endpoints.
data[].idintegerThe endpoint id.
data[].urlstringWhere we POST events.
data[].eventsstring[]Which events this endpoint is subscribed to.
data[].is_activebooleanWhether we are still delivering to it. An endpoint that fails 20 consecutive times is switched OFF automatically rather than retried forever — re-enable it with POST /v1/webhooks/{id}/enable once your receiver is fixed.
data[].consecutive_failuresintegerHow many deliveries have failed in a row. Resets to 0 on the first success. Watch it: it is the early warning before the endpoint is disabled.
data[].disabled_atstring|nullISO-8601 UTC of when it was switched off, or null while active.
data[].headersarrayCustom request headers we send to this endpoint, as {name, preview}. The values are stored encrypted and never returned. Replace them with PUT /v1/webhooks/{id}.
data[].headers[].namestringThe header name we send.
data[].headers[].previewstringThe first four characters of the value, then dots. Enough to tell two credentials apart, useless to anyone who does not already have it.
data[].secret_prefixstringThe first few characters of the signing secret, so you can tell two endpoints apart. The full secret is shown ONCE, when the endpoint is created, and never again.
available_eventsstring[]Every event name this API can send. The authoritative list — subscribing to anything outside it is rejected.

Example

{
    "count": 1,
    "data": [
        {
            "id": 1,
            "url": "https://erp.example.com/hooks",
            "events": [
                "order.created"
            ],
            "is_active": true,
            "consecutive_failures": 0,
            "disabled_at": null,
            "headers": [
                {
                    "name": "X-Api-Key",
                    "preview": "the ••••••••"
                }
            ],
            "secret_prefix": "whsec_64Ky4…"
        }
    ],
    "available_events": [
        "order.created",
        "order.status_changed"
    ]
}

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" \
  -H "Authorization: Bearer bk_test_YOUR_KEY"
<?php

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

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");

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

import requests

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

data = response.json()

const response = await fetch("https://sandbox-api.biklo.com/v1/webhooks", {
  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"))
    .header("Authorization", "Bearer bk_test_YOUR_KEY")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

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