BioFlow / API docs / getWebhookEndpoint

Get a webhook endpoint.

GET /v1/webhook-endpoints/{endpoint_id}
scope: webhooks:readCreator & Pro plansquota cost: 1

Requires scope: webhooks:read. Plan entitlement: public_api (Creator and Pro).

Try it

Request.

curl "https://app.getbioflow.com/v1/webhook-endpoints/ENDPOINT_ID" \ -H "Authorization: Bearer bf_live_YOUR_KEY"
Parameters

Path & query parameters.

Parameters accepted by getWebhookEndpoint
NameInTypeRequiredDescription
endpoint_idpathstringyesEndpoint ID from List webhook endpoints
Response

200The endpoint.

Fields of the 200 response for getWebhookEndpoint
FieldTypeDescription
idstringStable opaque endpoint ID
urlstring
statusACTIVE | DISABLED
disabled_reasonstring | null
event_typesarray<contact.created | page.published | sale.paid | sale.refunded>
consecutive_failuresinteger
last_success_atstring (ISO 8601) | null
last_failure_atstring (ISO 8601) | null
previous_secret_expires_atstring (ISO 8601) | nullWhile set, the pre-rotation secret still signs deliveries (second signature)
created_atstring (ISO 8601)
updated_atstring (ISO 8601)

Every response also carries X-Request-Id plus the IETF draft-11 RateLimit / RateLimit-Policy headers.

Errors

What can go wrong here.

Problem codes this operation can return
CodeStatusMeaning
invalid_request400The request body or parameters failed validation
invalid_api_key401Missing, malformed, unknown, disabled, or expired API key
insufficient_scope403The API key was not granted the required scope
feature_not_enabled403The workspace plan does not include public API access
test_key_read_only403Test-mode keys are restricted to read operations
rate_limited429Per-key rate limit exceeded
quota_exhausted429Monthly API quota exhausted
internal_error500Something went wrong on our side

All errors are RFC 9457 application/problem+json — branch on code, quote request_id to support. Full registry on the API docs hub; interactive playground in the API reference.