Skip to main content
POST
/
v1
/
alarms
/
forecasts
/
register
Create registration
curl --request POST \
  --url https://api.iklim.co/v1/alarms/forecasts/register \
  --header 'Content-Type: application/json' \
  --data '
{
  "registrationId": "f7587d9e-2481-4b4c-818d-c8d1946851b7",
  "recipientId": "customer-system-001",
  "boundary": {
    "cityId": 6,
    "districtId": 557,
    "type": "ADMINISTRATIVE"
  },
  "forecastDays": 3,
  "forecastAlarmDelivery": [
    "MORNING",
    "EVENING"
  ],
  "webhook": {
    "accountId": "2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1",
    "url": "https://api.customer.com/alerts/forecast-callback",
    "httpMethod": "POST",
    "contentType": "application/json",
    "authentication": {
      "type": "API_KEY",
      "username": "alert-user",
      "password": "******"
    },
    "deliveryPolicy": {
      "timeout": 60,
      "maxRetries": 3,
      "retryDelay": 10
    }
  },
  "filter": {
    "precipitationThreshold": "MODERATE",
    "snowFallThreshold": "LIGHT",
    "windGustThreshold": "STRONG_WIND",
    "hotTemperatureThreshold": "HOT_SNAP",
    "coldTemperatureThreshold": "COLD_SNAP"
  }
}
'
{
  "registrationId": "f7587d9e-2481-4b4c-818d-c8d1946851b7",
  "recipientId": "customer-system-001",
  "boundary": {
    "cityId": 6,
    "districtId": 557
  },
  "forecastDays": 3,
  "forecastAlarmDelivery": [
    "MORNING",
    "EVENING"
  ],
  "webhook": {
    "accountId": "2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1",
    "url": "https://api.customer.com/alerts/forecast-callback",
    "httpMethod": "POST",
    "contentType": "application/json",
    "authentication": {
      "username": "alert-user",
      "password": "******"
    },
    "deliveryPolicy": {
      "timeout": 60,
      "maxRetries": 3,
      "retryDelay": 10
    }
  },
  "filter": {
    "precipitationThreshold": "MODERATE",
    "snowFallThreshold": "LIGHT",
    "windGustThreshold": "STRONG_WIND",
    "hotTemperatureThreshold": "HOT_SNAP",
    "coldTemperatureThreshold": "COLD_SNAP"
  },
  "createdAt": "2025-01-01T10:15:30Z",
  "updatedAt": "2025-01-01T11:15:30Z",
  "warnings": [
    "warning-1",
    "warning-2"
  ]
}

Body

application/json

Forecast point alarm registration.

​
registrationId
string<uuid>

UUID of the registration record (required for update operations).

Example:

"f7587d9e-2481-4b4c-818d-c8d1946851b7"

​
recipientId
string

Caller-defined external reference identifier for the notification recipient.

Example:

"customer-system-001"

​
boundary
object

Alarm registration boundary (discriminator field: type).

​
forecastDays
integer<int32>

Number of forecast days ahead to evaluate for alarm conditions (1–7).

Example:

3

​
forecastAlarmDelivery
enum<string>[]

Time windows at which alarm notifications are dispatched (MORNING – 04:00 UTC, EVENING – 16:00 UTC).

Available options:
MORNING,
EVENING
Example:
["MORNING", "EVENING"]
​
webhook
object

Outbound callback configuration for this registration.

​
filter
object

Threshold filters that control which forecast conditions trigger an alarm.

Response

OK

​
registrationId
string<uuid>

UUID of the registration record (required for update operations).

Example:

"f7587d9e-2481-4b4c-818d-c8d1946851b7"

​
recipientId
string

Caller-defined external reference identifier for the notification recipient.

Example:

"customer-system-001"

​
boundary
object

Alarm registration boundary (discriminator field: type).

​
forecastDays
integer<int32>

Number of forecast days ahead to evaluate for alarm conditions (1–7).

Example:

3

​
forecastAlarmDelivery
enum<string>[]

Time windows at which alarm notifications are dispatched (MORNING – 04:00 UTC, EVENING – 16:00 UTC).

Available options:
MORNING,
EVENING
Example:
["MORNING", "EVENING"]
​
webhook
object

Outbound callback configuration for this registration.

​
filter
object

Threshold filters that control which forecast conditions trigger an alarm.

​
createdAt
string<date-time>

Timestamp when the registration was first created (ISO-8601).

Example:

"2025-01-01T10:15:30Z"

​
updatedAt
string<date-time>

Timestamp of the most recent update to the registration (ISO-8601).

Example:

"2025-01-01T11:15:30Z"

​
warnings
string[]

Non-fatal warnings generated during registration processing.

Example:
["warning-1", "warning-2"]