FurniOpsDocs
API referenceWebhooks

Update a webhook endpoint

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).

PATCH/v1/webhook-endpoints/{id}

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).

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"
If-Match*string

ETag of the representation being changed

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"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Fields of an endpoint to change

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

application/problem+json

application/problem+json

application/problem+json

curl -X PATCH "https://example.com/v1/webhook-endpoints/string" \  -H "If-Match: string" \  -H "Content-Type: application/json" \  -d '{}'
{  "object": "webhook_endpoint",  "id": "string",  "url": "string",  "description": "string",  "event_types": [    "string"  ],  "filters": {    "catalogues": [      "string"    ],    "sources": [      "string"    ],    "categories": [      "string"    ]  },  "coalesce_seconds": 0,  "payload": "thin",  "api_version": "2026-10-01",  "status": "enabled",  "status_reason": {    "code": "failing",    "message": "string",    "at": "2019-08-24T14:15:22Z"  },  "secrets": [    {      "hint": "string",      "created_at": "2019-08-24T14:15:22Z",      "expires_at": "2019-08-24T14:15:22Z"    }  ],  "livemode": true,  "version": 1,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

Send a test event POST

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}`.

catalogue.unverified Webhook

A vendor catalogue is no longer verified by its brand: FurniOps took an approved claim back. Signed with the endpoint's secret (Standard Webhooks `v1`).