curl --request GET \
--url https://api.example.com/api/v1/bko/webhooks/{webhookId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v1/bko/webhooks/{webhookId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v1/bko/webhooks/{webhookId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/bko/webhooks/{webhookId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/bko/webhooks/{webhookId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/bko/webhooks/{webhookId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/bko/webhooks/{webhookId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"webhookId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"externalProvider": "in_memory",
"externalEventId": "hook_123",
"externalEventType": "charge.paid",
"actionType": "PAYMENT_PAID",
"payload": {
"id": "hook_123",
"type": "charge.paid"
},
"status": "PROCESSED",
"receivedCount": 2,
"createdAt": "2026-01-01T00:00:00.000Z",
"lastReceivedAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z",
"error": "Payment not found",
"createdBy": null,
"updatedBy": null,
"processedAt": "2026-01-01T00:00:00.000Z"
}{
"errors": [
{
"message": "required",
"path": "name"
}
],
"message": "Bad Request Error",
"statusCode": 400
}{
"message": "Missing or invalid access token",
"statusCode": 401
}{
"message": "Insufficient permissions",
"statusCode": 403
}{
"message": "Internal Server Error",
"statusCode": 500
}Get Webhook
Returns a webhook.
curl --request GET \
--url https://api.example.com/api/v1/bko/webhooks/{webhookId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v1/bko/webhooks/{webhookId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v1/bko/webhooks/{webhookId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/bko/webhooks/{webhookId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/bko/webhooks/{webhookId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/bko/webhooks/{webhookId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/bko/webhooks/{webhookId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"webhookId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
"externalProvider": "in_memory",
"externalEventId": "hook_123",
"externalEventType": "charge.paid",
"actionType": "PAYMENT_PAID",
"payload": {
"id": "hook_123",
"type": "charge.paid"
},
"status": "PROCESSED",
"receivedCount": 2,
"createdAt": "2026-01-01T00:00:00.000Z",
"lastReceivedAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z",
"error": "Payment not found",
"createdBy": null,
"updatedBy": null,
"processedAt": "2026-01-01T00:00:00.000Z"
}{
"errors": [
{
"message": "required",
"path": "name"
}
],
"message": "Bad Request Error",
"statusCode": 400
}{
"message": "Missing or invalid access token",
"statusCode": 401
}{
"message": "Insufficient permissions",
"statusCode": 403
}{
"message": "Internal Server Error",
"statusCode": 500
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Webhook identifier
"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"
Query Parameters
Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.
Response
OK
Webhook
Webhook identifier
"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"
External provider name
"in_memory"
External provider webhook event identifier
"hook_123"
External provider webhook event type
"charge.paid"
Persisted internal webhook action type
UPDATE_PAYMENT, PAYMENT_PAID, UPDATE_ORDER, UPDATE_TRANSFER "PAYMENT_PAID"
Original provider webhook payload
Show child attributes
Show child attributes
{ "id": "hook_123", "type": "charge.paid" }
Webhook processing status
RECEIVED, PROCESSED, FAILED "PROCESSED"
Number of provider deliveries for this event
2
Creation timestamp
"2026-01-01T00:00:00.000Z"
Last provider delivery timestamp
"2026-01-01T00:00:00.000Z"
Last update timestamp
"2026-01-01T00:00:00.000Z"
Webhook processing error
"Payment not found"
Created by
null
Updated by
null
Webhook processed timestamp
"2026-01-01T00:00:00.000Z"