Register a destination URL for webhook deliveries and optionally configure one or more subscriptions.
| Name | Type | Description |
|---|---|---|
| url Required | string (uri) | The HTTPS URL to deliver payloads to. Must be publicly reachable. |
| name Optional | string | null | Webhook name. |
| note Optional | string | null | Free-text description returned with every delivery. Useful for providing context to LLMs or downstream automation. |
| subscriptions Optional | object | null | Subscriptions to create, keyed by subscription type. If omitted, the webhook receives no deliveries. |
| <type> Optional | object | Subscription type key. For example: initialization_time.available or forecast_hour.available. See Forecast Subscriptions. |
| note Optional | string | null | Free-text label included in every outgoing payload for this subscription. Useful for providing context to LLMs or downstream automation. |
| filters Optional | object | Filters for this subscription type. If omitted, all notifications for the subscription type are delivered. |
| response_options Optional | object | null | Attach one compatible forecast response inside data.response. See Attaching Forecast Responses for configuration and compatibility. |
| active Optional | boolean | Whether the webhook is enabled. Default: true |
Returns the created webhook configuration. The response includes generated webhook and subscription identifiers, a one-time signing secret, and timestamps.
| Name | Type | Description |
|---|---|---|
| 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[] | Active subscriptions for this webhook. |
| 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 | Subscription note. 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. |
| signing_secret | string | Secret used to verify delivery signatures. Returned only at creation. Store it securely. |