FurniOpsDocs
API referenceWebhooks

List webhook endpoints

The organisation's endpoints, newest first.

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

The organisation's endpoints, newest first.

Authorization

apiKey
AuthorizationBearer <token>

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

In: header

Query Parameters

limit?integer

Page size

Range1 <= value <= 100
Default20
starting_after?string

Opaque position returned by a previous page

Match^[A-Za-z0-9_-]{1,512}$
ending_before?string

Opaque position returned by a previous page

Match^[A-Za-z0-9_-]{1,512}$

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

curl -X GET "https://example.com/v1/webhook-endpoints"
{  "object": "list",  "data": [    {      "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"    }  ],  "has_more": true,  "next_cursor": "string"}