Skip to main content
GET
/
v1
/
webhooks
/
{id}
Get Webhook Endpoint
curl --request GET \
  --url https://api.example.com/v1/webhooks/{id} \
  --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"
}

Documentation Index

Fetch the complete documentation index at: https://docs.baanx.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Get Webhook Endpoint

GET https://api.baanx.com/v1/webhooks/{id} Retrieves a specific webhook configuration by ID.

​
Overview

Returns webhook details including its URL, subscribed event types, active status, and a masked API key. Use this to inspect the current configuration of a single webhook.

​
Authentication

This endpoint requires authentication via Bearer token: 
Authorization: Bearer YOUR_ACCESS_TOKEN

​
Request

​
Headers

​
Authorization
string
required
Bearer token for authentication

​
Path Parameters

​
id
string (UUID)
required
Unique identifier of the webhook configuration

​
Request Example

curl -X GET https://api.baanx.com/v1/webhooks/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

​
Response

​
200 Success

​
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 (e.g., whk_****...****5678). Use Rotate Key if you need a new key.
​
eventTypes
array
List of event types this webhook subscribes to
​
isActive
boolean
Whether the webhook is currently active
​
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"
}
  • GET /v1/webhooks - List all webhook endpoints
  • PUT /v1/webhooks/{id} - Update this webhook
  • DELETE /v1/webhooks/{id} - Delete this webhook
  • GET /v1/webhooks/{id}/logs - View delivery logs for this webhook