FurniOpsDocs
API referenceWebhooks

Get a webhook endpoint

One endpoint; its secrets appear only by their last characters.

  • Scopeswebhooks:read
  • Rate classread
GET/v1/webhook-endpoints/{id}

One endpoint; its secrets appear only by their last characters.

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-None-Match?string

ETag of a cached representation; a match returns 304

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

curl -X GET "https://example.com/v1/webhook-endpoints/string"
{  "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"}

Get a delivery GET

One delivery with the payload as sent and every attempt: when, the status, how long it took, and the start of the receiver's answer.

List an endpoint's deliveries GET

The events sent (or being sent) to the endpoint, newest first, kept 30 days (fewer when the plan's delivery days are fewer). Filter by `status` (`failed` shows what to recover), event `type`, or one `event`.