Skip to main content
GET
List Webhook Endpoints

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:

Request

Headers

string
required
Bearer token for authentication
string
Must be application/json

Request Example

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

Error Responses

  • 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