Rotate the signing secret
POST /v1/webhook-endpoints/{endpoint_id}/rotate-secret — Mint a NEW whsec_ secret (returned once). For 24 hours deliveries carry TWO signatures — the new and the…
Mint a NEW whsec_ secret (returned once). For 24 hours deliveries carry TWO signatures — the new and the previous secret — so you can roll your verifier without dropping events.
Requires scope: webhooks:write. Plan entitlement: public_api (Creator and Pro).
Consequential operation — send an Idempotency-Key header.
API key (bf_live_… / bf_test_…) as a Bearer token.
In: header
Path Parameters
Endpoint ID from List webhook endpoints
1 <= lengthResponse Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/v1/webhook-endpoints/string/rotate-secret"{ "endpoint": { "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" }, "secret": "string", "previous_secret_expires_at": "2019-08-24T14:15:22Z"}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.
Send a test event POST
POST /v1/webhook-endpoints/{endpoint_id}/test — Synchronously send a signed endpoint.test event to the endpoint and report the outcome. Does not touch the delivery…