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.For example: "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 configuration.At most one subscription of each type is allowed. Use a separate webhook for another configuration of the same type.If omitted, the webhook is created without subscriptions and receives no deliveries. |
| <type> Required | string | Subscription type key.For example: initialization_time.available or forecast_hour.available. See Forecast Subscriptions. |
| 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 notifications for the subscription type are delivered. |
| response_options Optional | object | Attach one compatible forecast response inside data.response .See Response Options for configuration and compatibility. |
| 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 at creation. 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. |