List Webhook Endpoints

curl --request GET \
  --url https://api.example.com/v1/webhooks \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.example.com/v1/webhooks', 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/v1/webhooks",
  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: <authorization>"
  ],
]);

$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/v1/webhooks"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "tenant": "partner-name",
    "name": "KYC Status Webhook",
    "url": "https://api.partner.com/webhooks/kyc",
    "apiKey": "whk_****...****5678",
    "eventTypes": ["kyc.status.changed", "card.activated"],
    "isActive": true,
    "metadata": { "environment": "production" },
    "createdAt": "2025-12-29T10:00:00.000Z",
    "updatedAt": "2025-12-29T12:00:00.000Z"
  }
]

GET

webhooks

List Webhook Endpoints

curl --request GET \
  --url https://api.example.com/v1/webhooks \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.example.com/v1/webhooks', 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/v1/webhooks",
  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: <authorization>"
  ],
]);

$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/v1/webhooks"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "tenant": "partner-name",
    "name": "KYC Status Webhook",
    "url": "https://api.partner.com/webhooks/kyc",
    "apiKey": "whk_****...****5678",
    "eventTypes": ["kyc.status.changed", "card.activated"],
    "isActive": true,
    "metadata": { "environment": "production" },
    "createdAt": "2025-12-29T10:00:00.000Z",
    "updatedAt": "2025-12-29T12:00:00.000Z"
  }
]

List Webhook Endpoints

GET https://api.baanx.com/v1/webhooks Retrieves all webhook configurations for the authenticated partner.

Overview

Returns an array of webhook endpoints with their current status, subscribed event types, and masked API keys. Use this to audit your webhook configurations and check which endpoints are active.

Authentication

This endpoint requires authentication via Bearer token:

Authorization: Bearer YOUR_ACCESS_TOKEN

Request

Headers

string

required

Bearer token for authentication

string

Must be application/json

Request Example

curl -X GET https://api.baanx.com/v1/webhooks \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch('https://api.baanx.com/v1/webhooks', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
  }
});

const data = await response.json();
console.log(data);

import requests

url = "https://api.baanx.com/v1/webhooks"
headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

response = requests.get(url, headers=headers)
print(response.json())

const listWebhooks = async (): Promise<WebhookConfig[]> => {
  const response = await fetch('https://api.baanx.com/v1/webhooks', {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
    }
  });

  if (!response.ok) {
    throw new Error(`HTTP error! status: ${response.status}`);
  }

  return await response.json();
};

Response

200 Success

Returns an array of webhook configuration objects. API keys are masked for security.

string (UUID)

Unique identifier for the webhook configuration

string

Partner tenant identifier

string

Human-readable name for the webhook

string

HTTPS endpoint URL for webhook delivery

string

Masked API key used for signature verification (e.g., whk_****...****5678)

array

List of event types this webhook subscribes to

boolean

Whether the webhook is currently active and receiving events

object

Custom metadata attached to the webhook

string (ISO 8601)

Timestamp when the webhook was created

string (ISO 8601)

Timestamp when the webhook was last updated

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "tenant": "partner-name",
    "name": "KYC Status Webhook",
    "url": "https://api.partner.com/webhooks/kyc",
    "apiKey": "whk_****...****5678",
    "eventTypes": ["kyc.status.changed", "card.activated"],
    "isActive": true,
    "metadata": { "environment": "production" },
    "createdAt": "2025-12-29T10:00:00.000Z",
    "updatedAt": "2025-12-29T12:00:00.000Z"
  }
]

Error Responses

{
  "message": "Not authenticated"
}

{
  "message": "Not authorized"
}

{
  "message": "Notification service is not configured for this environment"
}

POST /v1/webhooks - Create a new webhook endpoint
GET /v1/webhooks/{id} - Get a specific webhook by ID
PUT /v1/webhooks/{id} - Update a webhook configuration
DELETE /v1/webhooks/{id} - Delete a webhook endpoint

Overview

Authentication

User

Card

Orders

Wallet

Delegation

Consent

Referral

Webhooks

List Webhook Endpoints

List Webhook Endpoints

Overview

Authentication

Request

Headers

Request Example

Response

200 Success

Error Responses

​List Webhook Endpoints

​Overview

​Authentication

​Request

​Headers

​Request Example

​Response

​200 Success

​Error Responses

​Related Endpoints

List Webhook Endpoints

Overview

Authentication

Request

Headers

Request Example

Response

200 Success

Error Responses

Related Endpoints