Get Webhook Endpoint
Webhooks
Get Webhook Endpoint
Retrieve a specific webhook configuration by ID
GET
Get Webhook Endpoint
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:Request
Headers
string
required
Bearer token for authentication
Path Parameters
string (UUID)
required
Unique identifier of the webhook configuration
Request Example
Response
200 Success
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 (e.g.,
whk_****...****5678). Use Rotate Key if you need a new key.array
List of event types this webhook subscribes to
boolean
Whether the webhook is currently active
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
Error Responses
Related Endpoints
GET /v1/webhooks- List all webhook endpointsPUT /v1/webhooks/{id}- Update this webhookDELETE /v1/webhooks/{id}- Delete this webhookGET /v1/webhooks/{id}/logs- View delivery logs for this webhook