BioFlow
API Reference

Update a webhook endpoint

PATCH /v1/webhook-endpoints/{endpoint_id} — Change the URL (re-verified with a signed test event first), the subscribed event types, or enable/disable delivery…

PATCH
/v1/webhook-endpoints/{endpoint_id}

Change the URL (re-verified with a signed test event first), the subscribed event types, or enable/disable delivery. Re-enabling resets the consecutive-failure counter; missed events can then be re-queued with Replay failed deliveries.

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

Authorization

AuthorizationBearer <token>

API key (bf_live_… / bf_test_…) as a Bearer token.

In: header

Path Parameters

endpoint_id*string

Endpoint ID from List webhook endpoints

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X PATCH "https://example.com/v1/webhook-endpoints/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "url": "string",  "status": "ACTIVE",  "disabled_reason": "string",  "event_types": [    "contact.created"  ],  "consecutive_failures": 0,  "last_success_at": "2019-08-24T14:15:22Z",  "last_failure_at": "2019-08-24T14:15:22Z",  "previous_secret_expires_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

Get a webhook endpoint GET

GET /v1/webhook-endpoints/{endpoint_id} — Get a webhook endpoint. Requires scope webhooks:read.

Delete a webhook endpoint DELETE

DELETE /v1/webhook-endpoints/{endpoint_id} — Permanently delete the endpoint and its delivery history. This cannot be undone. Requires scope webhooks:write.