Biklo for developersTESTsandbox-api.biklo.comchange

Send yourself a test webhook

POST/v1/webhooks/{id}/test

scope webhooks.manage

Queues a test.ping to this endpoint so you can wire up a receiver without creating a real order first. It travels the same path as every real event — same queue, same headers, same HMAC signature — so a delivery that arrives and verifies here proves the real ones will too. Sent regardless of what the endpoint subscribes to, because an integrator testing a receiver has not necessarily decided which events they want yet. 202 means queued, not delivered: the outcome appears on GET /v1/webhooks/{id}/deliveries a moment later. Refused with 409 endpoint_disabled if the endpoint is switched off.

Response#

FieldTypeDescription
queuedbooleanAlways true — the delivery was accepted onto the queue.
delivery_idintegerFind this row on the deliveries route to see what your endpoint answered.
event_idstringThe id in the body and the X-Biklo-Event-Id header, so you can match it in your own logs.
eventstringAlways test.ping. It is not a subscribable event — you will never receive one you did not ask for.
urlstringWhere it is going, so a wrong endpoint id is obvious immediately.
deliveries_urlstringWhere the result will appear.

Example

{
    "queued": true,
    "delivery_id": 9412,
    "event_id": "evt_94q9tgtrsqymkrnwjdxbyfeh",
    "event": "test.ping",
    "url": "https://erp.example.com/hooks/biklo",
    "deliveries_url": "/v1/webhooks/1/deliveries"
}

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

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

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

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST  => 'POST',
    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("POST"),
    "https://sandbox-api.biklo.com/v1/webhooks/711/test");

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

import requests

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

data = response.json()

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

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