GET List Webhooks

Retrieve your webhook endpoints and their subscriptions, with optional filters for status, subscription type, and destination URL.

/webhooks/v1/webhooks/v1

Query parameters

Name	Type	Description
page Optional	integer	Page number. Defaults to 1.
page_size Optional	integer	Results per page. Defaults to 20, max 100.
active Optional	boolean	Filter by active state. Omit to return all.
subscription_type Optional	string	Filter to webhooks with a specific subscription type (e.g. initialization_time.available).
url Optional	string	Partial URL match. Returns any webhook whose URL contains this string.

Response parameters

Name	Type	Description
webhooks	object[]	Array of webhook summary objects.
id	integer	Unique webhook identifier.
name	string	Human-readable label. Null if not set.
note	string	Free-text description. Null if not set.
url	string	The registered payload URL.
active	boolean	Whether the webhook is currently active.
subscriptions	object[]	Summary of subscriptions.
id	integer	Unique subscription identifier.
subscription_type	string	The subscription type.
note	string	Free-text label. Null if not set.
filters	object	Filters configured for the subscription.
created_at	string	ISO 8601 timestamp of creation.
updated_at	string	ISO 8601 timestamp of last update.
page	integer	Current page number.
page_size	integer	Maximum number of results requested for this page.
total	integer	Total webhooks across all pages.

Examples

curl -u "$WB_CLIENT_ID:$WB_API_KEY" \curl -u "$WB_CLIENT_ID:$WB_API_KEY" \

"https://api.windbornesystems.com/webhooks/v1" "https://api.windbornesystems.com/webhooks/v1"

content-type: application/json

1 {{

2 "webhooks": [ "webhooks": [

3 { {

4 "id": 42, "id": 42,

5 "name": null, "name": null,

6 "note": null, "note": null,

7 "url": "https://example.com/webhook", "url": "https://example.com/webhook",

8 "active": true, "active": true,

9 "subscriptions": [ "subscriptions": [

10 { {

11 "id": 81, "id": 81,

12 "subscription_type": "initialization_time.available", "subscription_type": "initialization_time.available",

13 "note": null, "note": null,

14 "filters": { "filters": {

15 "model": "wm-6" "model": "wm-6"

16 } }

17 } }

18 ], ],

19 "created_at": "2025-03-09T12:00:00Z", "created_at": "2025-03-09T12:00:00Z",

20 "updated_at": "2025-03-09T12:00:00Z" "updated_at": "2025-03-09T12:00:00Z"

21 } }

22 ], ],

23 "page": 1, "page": 1,

24 "page_size": 20, "page_size": 20,

25 "total": 1 "total": 1

26 }}