FurniOpsDocs
API referenceWebhooks

Send a test event

Sends a webhook.test event to the endpoint now, signed like any other, whatever it subscribes to. Follow it with GET /v1/webhook-endpoints/{id}/deliveries/{delivery}.

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

Sends a webhook.test event to the endpoint now, signed like any other, whatever it subscribes to. Follow it with GET /v1/webhook-endpoints/{id}/deliveries/{delivery}.

Authorization

apiKey
AuthorizationBearer <token>

An API key (fo_live_… / fo_test_…) as a bearer token

In: header

Path Parameters

id*string

Webhook endpoint ID

Match^whe_[0-9A-Za-z]{22}$

Header Parameters

FurniOps-Version?string

Dated API version; pinned per organisation on first use and overridable per request

Value in

  • "2026-10-01"
  • "2026-10-04"
FurniOps-Mode?string

The data the request acts on: test is the organisation's sandbox. An OAuth token picks it (live by default); an API key's mode is fixed, and naming the other one is refused

Value in

  • "live"
  • "test"
Idempotency-Key*string

Unique key for this operation, reused on retries (24 h)

Length1 <= length <= 257
FurniOps-Dry-Run?string

Preview the write and change nothing: true answers the would-be response, explain a Preview (application/vnd.furniops.preview+json)

Value in

  • "true"
  • "explain"

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+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/test" \  -H "Idempotency-Key: string"
{  "object": "webhook_delivery",  "id": "string",  "endpoint": "string",  "event": {    "id": "string",    "type": "string",    "subject": "string"  },  "status": "pending",  "attempts": 0,  "next_attempt_at": "2019-08-24T14:15:22Z",  "last_status": -9007199254740991,  "created_at": "2019-08-24T14:15:22Z",  "completed_at": "2019-08-24T14:15:22Z"}

Rotate an endpoint's secret POST

Makes a new signing secret, shown once in the answer. The current secret keeps signing beside it for `overlap_hours` (default 24), so deliveries carry both signatures until the receiver has switched. A secret already rotated out is retired at once.

Update a webhook endpoint PATCH

Changes the URL, description, event types, filters or status. Send the endpoint's ETag as `If-Match`. Setting `enabled` resumes an endpoint FurniOps disabled; events missed while it was disabled are not sent (read them from the change feed).