Tomorrow.io · JSON Structure

Alert Create Request Structure

Payload to create or update an alert.

Type: object Properties: 6 Required: 2
WeatherClimateForecastHistorical WeatherAir QualityPollenFireFloodRoutesMap TilesAviationMaritimePublic APIs

AlertCreateRequest is a JSON Structure definition published by Tomorrow.io, describing 6 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

name description insightIds locationIds notifications active

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/tomorrow/refs/heads/main/json-structure/alert-create-request-structure.json",
  "name": "AlertCreateRequest",
  "description": "Payload to create or update an alert.",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "example": "Hail Watch \u2014 Northeast Region"
    },
    "description": {
      "type": "string"
    },
    "insightIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "locationIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "notifications": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "webhook"
            ]
          },
          "url": {
            "type": "uri"
          }
        }
      }
    },
    "active": {
      "type": "boolean",
      "default": true
    }
  },
  "required": [
    "name",
    "insightIds"
  ]
}