BioFlow / API docs / testWebhookEndpoint

Send a test event.

POST /v1/webhook-endpoints/{endpoint_id}/test

scope: webhooks:writeCreator & Pro plansquota cost: 1send an Idempotency-Key

Synchronously send a signed endpoint.test event to the endpoint and report the outcome. Does not touch the delivery log or failure counters.

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

Consequential operation — send an Idempotency-Key header.

Open in Claude ↗Open in ChatGPT ↗

Try it

Request.

curl "https://app.getbioflow.com/v1/webhook-endpoints/ENDPOINT_ID/test" \
  -X POST \
  -H "Authorization: Bearer bf_live_YOUR_KEY" \
  -H "Idempotency-Key: a-unique-id-per-attempt"

Parameters

Path & query parameters.

Parameters accepted by testWebhookEndpoint
Name	In	Type	Required	Description
`endpoint_id`	path	string	yes	Endpoint ID from List webhook endpoints

Response

200 — The test outcome.

Fields of the 200 response for testWebhookEndpoint
Field	Type	Description
`delivered`	boolean	—
`status_code`	integer \| null	—
`error`	string \| null	—

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
Code	Status	Meaning
`invalid_request`	400	The request body or parameters failed validation
`invalid_api_key`	401	Missing, malformed, unknown, disabled, or expired API key
`insufficient_scope`	403	The API key was not granted the required scope
`feature_not_enabled`	403	The workspace plan does not include public API access
`test_key_read_only`	403	Test-mode keys are restricted to read operations
`rate_limited`	429	Per-key rate limit exceeded
`quota_exhausted`	429	Monthly API quota exhausted
`internal_error`	500	Something 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.