Skip to main content
GET
/
v1
/
webhooks
List Webhook Endpoints
curl --request GET \
  --url https://api.example.com/v1/webhooks \
  --header 'Authorization: <authorization>'
[
  {
    "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

​
Authorization
string
required
Bearer token for authentication
​
Content-Type
string
Must be application/json

​
Request Example

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

​
Response

​
200 Success

Returns an array of webhook configuration objects. API keys are masked for security.
​
id
string (UUID)
Unique identifier for the webhook configuration
​
tenant
string
Partner tenant identifier
​
name
string
Human-readable name for the webhook
​
url
string
HTTPS endpoint URL for webhook delivery
​
apiKey
string
Masked API key used for signature verification (e.g., whk_****...****5678)
​
eventTypes
array
List of event types this webhook subscribes to
​
isActive
boolean
Whether the webhook is currently active and receiving events
​
metadata
object
Custom metadata attached to the webhook
​
createdAt
string (ISO 8601)
Timestamp when the webhook was created
​
updatedAt
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"
}
  • 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