Register a destination URL for webhook deliveries and optionally configure one or more subscriptions.
| Name | Type | Description |
|---|---|---|
| url Required | string | The HTTPS URL to deliver payloads to. Must be publicly reachable. |
| name Optional | string | Short human-readable label (e.g. "Iceland Campaign"). Shown in list views. |
| note Optional | string | Free-text description returned with every delivery. Useful for providing context to LLMs or downstream automation. |
| subscriptions Optional | object | Map of subscription type to config. This map can create one subscription per type; use Add Subscription afterward to add another subscription of the same type. If omitted, the webhook is created without subscriptions and will not receive deliveries. |
| <type> Required | string | Subscription type key (e.g. initialization_time.available, forecast_hour.available). See Forecast Subscriptions for the full list. |
| note Optional | string | 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 matching notifications are delivered. |
| active Optional | boolean | Whether the webhook is enabled. Defaults to true. |
Returns the request body plus the following additional fields:
| Name | Type | Description |
|---|---|---|
| id | integer | Unique webhook identifier. |
| signing_secret | string | Secret used to verify delivery signatures. Returned only when the webhook is created; store it securely. |
| subscriptions | object[] | Subscriptions created for this webhook. |
| id | integer | Unique subscription identifier. |
| created_at | string | ISO 8601 timestamp of creation. |
| updated_at | string | ISO 8601 timestamp of last update. |