Skip to content
HALOWERK

File Formats and Conversion

ical alarm advance time envelope

Calendar alarm lead-time profiling measures the shortest and longest advance notice among relative start-based alarms in seconds. Use it when an agent needs the range of start reminders before an event.

POST https://format.halowerk.com/v1/ical-alarm-advance-time-envelope

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
icsstringYes
Show full input schema
{
  "type": "object",
  "properties": {
    "ics": {
      "type": "string",
      "maxLength": 26000,
      "minLength": 1
    }
  },
  "required": [
    "ics"
  ],
  "additionalProperties": false
}

Open original schema

Published input example

{
  "ics": "BEGIN:VEVENT\r\nUID:water-day-2027\r\nDTSTAMP:20261120T000000Z\r\nDTSTART:20270322T090000Z\r\nDTEND:20270322T100000Z\r\nBEGIN:VALARM\r\nACTION:DISPLAY\r\nTRIGGER:-PT15M\r\nDESCRIPTION:World Water Day\r\nREPEAT:2\r\nDURATION:PT5M\r\nEND:VALARM\r\nEND:VEVENT"
}

Result & documentation

Show published result schema
{
  "type": "object",
  "required": [
    "measured_at",
    "source",
    "data",
    "limitations"
  ],
  "properties": {
    "measured_at": {
      "type": "string"
    },
    "source": {
      "type": "object",
      "required": [
        "reference",
        "retrieved_at"
      ],
      "properties": {
        "reference": {
          "type": "string"
        },
        "retrieved_at": {
          "type": "string"
        }
      }
    },
    "data": {
      "type": "object",
      "properties": {
        "qualifying": {
          "type": "integer"
        },
        "min_seconds": {
          "type": [
            "number",
            "null"
          ]
        },
        "max_seconds": {
          "type": [
            "number",
            "null"
          ]
        },
        "nonlead": {
          "type": "integer"
        }
      },
      "required": [
        "qualifying",
        "min_seconds",
        "max_seconds",
        "nonlead"
      ]
    },
    "limitations": {
      "type": "string"
    }
  }
}

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-20 UTC.

More endpoints in this hub

All endpoints in this hub โ†’