Tomorrow.io · Schema

AlertCreateRequest

Payload to create or update an alert.

WeatherClimateForecastHistorical WeatherAir QualityPollenFireFloodRoutesMap TilesAviationMaritimePublic APIs

Properties

Name Type Description
name string
description string
insightIds array
locationIds array
notifications array
active boolean
View JSON Schema on GitHub

JSON Schema

alert-create-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/tomorrow/refs/heads/main/json-schema/alert-create-request-schema.json",
  "title": "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": "string",
            "format": "uri"
          }
        }
      }
    },
    "active": {
      "type": "boolean",
      "default": true
    }
  },
  "required": [
    "name",
    "insightIds"
  ]
}