Tomorrow.io · JSON Structure

Alert Structure

A persistent alert that fires insights over linked locations and pushes activations to a webhook.

Type: object Properties: 8 Required: 3

WeatherClimateForecastHistorical WeatherAir QualityPollenFireFloodRoutesMap TilesAviationMaritimePublic APIs

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

Properties

id name description insightIds notifications active createdAt updatedAt

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

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/tomorrow/refs/heads/main/json-structure/alert-structure.json",
  "name": "Alert",
  "description": "A persistent alert that fires insights over linked locations and pushes activations to a webhook.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "6183d156022c1b0008686b14"
    },
    "name": {
      "type": "string",
      "example": "Hail Watch \u2014 Northeast Region"
    },
    "description": {
      "type": "string"
    },
    "insightIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "6183d156022c1b00086860a1"
      ]
    },
    "notifications": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "webhook"
            ],
            "example": "webhook"
          },
          "url": {
            "type": "uri",
            "example": "https://hooks.example.com/tomorrow-alerts"
          }
        }
      }
    },
    "active": {
      "type": "boolean",
      "example": true
    },
    "createdAt": {
      "type": "datetime"
    },
    "updatedAt": {
      "type": "datetime"
    }
  },
  "required": [
    "id",
    "name",
    "insightIds"
  ]
}