PATCH Add Subscription

Add another subscription to a webhook. This endpoint accepts both PATCH and PUT. The request body is a single subscription object.

Only one subscription of each type is allowed. Duplicate types return 422; use a separate webhook for another configuration. See Forecast Subscriptions.

/webhooks/v1/<id>/subscriptions/webhooks/v1/<id>/subscriptions

Path parameters

Name	Type	Description
id Required	integer	Unique webhook identifier.

Request parameters

Name	Type	Description
subscription_type Required	string	The subscription type to add (e.g. forecast_hour.available).
note Optional	string	Free-text label included in every outgoing payload for this subscription.
filters Optional	object	Filters for this subscription type.If omitted, all notifications for the subscription type are delivered.
response_options Optional	object	Attach one compatible forecast response inside data.response .Invalid configurations return 422 . See Response Options.

Examples

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

-H "Content-Type: application/json" \ -H "Content-Type: application/json" \

-d '{"subscription_type":"forecast_hour.available","note":"WM6 forecast outputs","filters":{"model":"wm-6","initialization_time_hours":["0:00","12:00"]},"response_options":{"type":"gridded"}}' \ -d '{"subscription_type":"forecast_hour.available","note":"WM6 forecast outputs","filters":{"model":"wm-6","initialization_time_hours":["0:00","12:00"]},"response_options":{"type":"gridded"}}' \

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

content-type: application/json

1 {{

2 "id": 42, "id": 42,

3 "name": null, "name": null,

4 "note": null, "note": null,

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

6 "active": true, "active": true,

7 "subscriptions": [ "subscriptions": [

8 { {

9 "id": 81, "id": 81,

10 "subscription_type": "initialization_time.available", "subscription_type": "initialization_time.available",

11 "note": null, "note": null,

12 "filters": { "filters": {

13 "model": "wm-6" "model": "wm-6"

14 } }

15 }, },

16 { {

17 "id": 82, "id": 82,

18 "subscription_type": "forecast_hour.available", "subscription_type": "forecast_hour.available",

19 "note": "WM6 forecast outputs", "note": "WM6 forecast outputs",

20 "filters": { "filters": {

21 "model": "wm-6", "model": "wm-6",

22 "initialization_time_hours": [ "initialization_time_hours": [

23 "0:00", "0:00",

24 "12:00" "12:00"

25 ] ]

26 }, },

27 "response_options": { "response_options": {

28 "type": "gridded" "type": "gridded"

29 } }

30 } }

31 ], ],

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

33 "updated_at": "2025-03-09T13:00:00Z" "updated_at": "2025-03-09T13:00:00Z"

34 }}