This subscription sends a notification for each individual forecast output as it becomes available. The payload includes the model, initialization time, forecast zero, forecast hour, and the time at which the forecast is valid.
Within a filter, values use OR; different filters use AND. Arrays form every combination.
| Filter | Type | Description |
|---|---|---|
| model | string | string[] | Models to match.Options: wm-6 and wm-6-3km. An array matches any listed model; omit the filter to receive both. Use separate webhooks for model-specific schedules. |
| forecast_hour | integer | integer[] | Forecast hours to match.An array matches any listed hour. When model and forecast_hour are both set, an event must match both filters. Common values: 0, 3, 6, 12, 24, 48, 72, 120, 240, and 360. Omit the filter to receive every output. |
| initialization_time_hours | string | string[] | UTC times of day matched against the hour and minute of initialization_time. Seconds are ignored.Accepts H:MM or HH:MM. Look up the Run Information endpoint to see how each model reports initialization times. |
| min_initialization_time | string | Inclusive ISO 8601 lower bound for the run's initialization_time. |
| max_initialization_time | string | Inclusive ISO 8601 upper bound for the run's initialization_time. |
| min_valid_at | string | Inclusive ISO 8601 lower bound for the forecast output's valid_at. |
| max_valid_at | string | Inclusive ISO 8601 upper bound for the forecast output's valid_at. |
gridded and interpolated_point_forecast.
| Name | Type | Description |
|---|---|---|
| trigger_id | string | Identifies the update that triggered this notification. |
| type | string | The subscription type. Always forecast_hour.available for this payload. Allowed: forecast_hour.available |
| subscription_id | integer | Identifier of the subscription that matched this forecast output. |
| webhook_id | integer | Identifier of the webhook that received this delivery. |
| version | integer | Version of the webhook payload schema. |
| occurred_at | string (ISO 8601) | When the forecast output became available. |
| data | object | Details of the available forecast output. |
| model | string | Model whose forecast output was used. Allowed: wm-6, wm-6-3km |
| domain | string | Regional model domain. Currently conus for wm-6-3km. Allowed: conus; Present when: the model is regional |
| initialization_time | string (ISO 8601) | The forecast initialization time. |
| forecast_zero | string (ISO 8601) | Valid time of forecast hour 0. |
| forecast_hour | integer | Hours since forecast_zero. Unit: hours |
| valid_at | string (ISO 8601) | Time at which this forecast output is valid. |
| response | object | Endpoint response configured by response_options. Present when: response_options is configured |
| webhook_note | string | Optional webhook note. Present when: the webhook has a note |
| subscription_note | string | Optional subscription note. Present when: the subscription has a note |