Skip to main content
POST
/
v1
/
alarms
/
geometries
/
register
Create registration
curl --request POST \
  --url https://api.iklim.co/v1/alarms/geometries/register \
  --header 'Content-Type: application/json' \
  --data '
{
  "registrationId": "f7587d9e-2481-4b4c-818d-c8d1946851b7",
  "recipientId": "Recipient 1",
  "boundary": {
    "cityId": 6,
    "districtId": 557,
    "neighborhoodId": 55766
  },
  "webhook": {
    "accountId": "2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1",
    "url": "https://api.customer.com/alerts/callback",
    "httpMethod": "POST",
    "contentType": "application/json",
    "authentication": {
      "type": "API_KEY",
      "username": "alert-user",
      "password": "******"
    },
    "requestHeaders": {
      "source": "iklim.co",
      "custom-header": "value"
    },
    "deliveryPolicy": {
      "timeout": 60,
      "maxRetries": 3,
      "retryDelay": 10
    }
  },
  "filter": {
    "lightning": {
      "type": "FLASH_CLOUD_TO_GROUND",
      "peakCurrent": -12.5,
      "inCloudHeight": 4500
    },
    "thunderstorm": {
      "intersectsAffectedPolygon": true,
      "intersectsCellPolygon": false,
      "severityThreshold": "MEDIUM",
      "speedThreshold": 20
    },
    "precipitation": {
      "intensities": [
        "LIGHT",
        "MODERATE"
      ]
    }
  }
}
'
{
  "registrationId": "f7587d9e-2481-4b4c-818d-c8d1946851b7",
  "recipientId": "Recipient 1",
  "boundary": {
    "cityId": 6,
    "districtId": 557,
    "neighborhoodId": 55766
  },
  "webhook": {
    "accountId": "2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1",
    "url": "https://api.customer.com/alerts/callback",
    "httpMethod": "POST",
    "contentType": "application/json",
    "authentication": {
      "username": "alert-user",
      "password": "******"
    },
    "requestHeaders": {
      "source": "iklim.co",
      "custom-header": "value"
    },
    "deliveryPolicy": {
      "timeout": 60,
      "maxRetries": 3,
      "retryDelay": 10
    }
  },
  "filter": {
    "lightning": {
      "type": "FLASH_CLOUD_TO_GROUND",
      "peakCurrent": -12.5,
      "inCloudHeight": 4500
    },
    "thunderstorm": {
      "intersectsAffectedPolygon": true,
      "intersectsCellPolygon": false,
      "severityThreshold": "MEDIUM",
      "speedThreshold": 20
    },
    "precipitation": {
      "intensities": [
        "LIGHT",
        "MODERATE"
      ]
    }
  },
  "createdAt": "2025-01-01T10:15:30Z",
  "updatedAt": "2025-01-01T11:15:30Z",
  "warnings": [
    "warning-1",
    "warning-2"
  ]
}

Body

application/json

Registration payload (boundary, webhook, and filters)

​
registrationId
string<uuid>

Registration UUID

Example:

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

​
recipientId
string

Recipient identifier. The recipient ID must be unique and comply with the US-ASCII character set.

Example:

"Recipient 1"

​
boundary
object

Alarm registration boundary

Defines the geographic scope to monitor for alarm conditions. The concrete boundary type is selected via the type discriminator field; supply only the fields that belong to the chosen subtype.

  • ADMINISTRATIVE – boundary identified by city (cityId), district (districtId), and optionally neighborhood (neighborhoodId).
  • POLYGON – arbitrary closed polygon defined by a list of exterior ring coordinates (WGS84).
  • H3INDEX – boundary defined by a single Uber H3 cell address.
​
webhook
object

Webhook configuration

​
filter
object

Alarm filters

Response

OK

Registration response (timestamps and warnings)

​
registrationId
string<uuid>

Registration UUID

Example:

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

​
recipientId
string

Recipient identifier. The recipient ID must be unique and comply with the US-ASCII character set.

Example:

"Recipient 1"

​
boundary
object

Alarm registration boundary

Defines the geographic scope to monitor for alarm conditions. The concrete boundary type is selected via the type discriminator field; supply only the fields that belong to the chosen subtype.

  • ADMINISTRATIVE – boundary identified by city (cityId), district (districtId), and optionally neighborhood (neighborhoodId).
  • POLYGON – arbitrary closed polygon defined by a list of exterior ring coordinates (WGS84).
  • H3INDEX – boundary defined by a single Uber H3 cell address.
​
webhook
object

Webhook configuration

​
filter
object

Alarm filters

​
createdAt
string<date-time>

Creation time

Example:

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

​
updatedAt
string<date-time>

Last update time

Example:

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

​
warnings
string[]

Warnings

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