Skip to main content
Retrieve a webhook endpoint by its ID.
GET /api/v1/businesses/:businessId/webhook-endpoints/:endpointId Returns the configuration of a single webhook endpoint. The signing secret is not returned.

Parameters

Path

NameTypeRequiredDescription
businessIdstringYesThe business ID
endpointIdstringYesThe endpoint ID

Request example

curl --request GET 'https://payments.bleepay.com/api/v1/businesses/biz_abc/webhook-endpoints/wh_abc123' \
  --header 'Authorization: Bearer <business_token>'

Response

Response schema

FieldTypeDescription
idstringEndpoint identifier
urlstringDelivery URL
descriptionstringHuman-readable description
eventsarraySubscribed event types
enabledbooleanWhether the endpoint is active
createdAtstringISO 8601 creation timestamp
updatedAtstringISO 8601 last update timestamp

Example response

{
  "id": "wh_abc123",
  "url": "https://example.com/webhooks/bleepay",
  "description": "Production webhook endpoint",
  "events": ["deposit.pending", "deposit.confirmed", "deposit.expired"],
  "enabled": true,
  "createdAt": "2026-06-09T12:00:00.000Z",
  "updatedAt": "2026-06-09T12:00:00.000Z"
}