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. Default: `1`
page_size Optional	integer	Number of results per page. Max: 100; Default: `20`
active Optional	boolean	Filter by active state. Omit to return all states.
subscription_type Optional	string	Filter to webhooks with a specific subscription type. Allowed: `initialization_time.available`, `forecast_hour.available`, `events.available`, `degree_days.available`, `tropical_cyclones.available`
url Optional	string	Partial URL match. Returns webhooks whose URL contains this string.

Response Fields

Name	Type	Description
webhooks	object[]	Webhook summary objects.
id	integer	Unique webhook identifier.
name	string \| null	Webhook name. Null when not set.
note	string \| null	Free-text description. Returns null when not set.
url	string (uri)	The registered payload URL.
active	boolean	Whether this webhook is enabled for automatic deliveries.
subscriptions	object[]	Summary of subscriptions.
id	integer	Unique subscription identifier.
subscription_type	string	The subscription type. Allowed: `initialization_time.available`, `forecast_hour.available`, `events.available`, `degree_days.available`, `tropical_cyclones.available`
note	string \| null	Free-text label. Returns null when not set.
filters	object	Filters configured for the subscription.
response_options	object	Attached-response configuration. Present when: one is configured
created_at	string (ISO 8601)	When the webhook was created.
updated_at	string (ISO 8601)	When the webhook was last updated.
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 -H "Authorization: Bearer $WB_API_KEY" \curl -H "Authorization: Bearer $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 "initialization_time_hours": [ "initialization_time_hours": [

17 "0:00", "0:00",

18 "12:00" "12:00"

19 ] ]

20 }, },

21 "response_options": { "response_options": {

22 "type": "gridded" "type": "gridded"

23 } }

24 } }

25 ], ],

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

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

28 } }

29 ], ],

30 "page": 1, "page": 1,

31 "page_size": 20, "page_size": 20,

32 "total": 1 "total": 1

33 }}