Skip to content
HALOWERK

File Formats and Conversion

ical alarm alerted event coverage

Calendar alarm coverage finds the event indices without any embedded reminder and counts events with several alarms. Use it when an agent needs an event-level reminder coverage check.

POST https://format.halowerk.com/v1/ical-alarm-alerted-event-coverage

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": {
        "events": {
          "type": "integer"
        },
        "unalerted_indices": {
          "type": "array",
          "items": {
            "type": "integer"
          }
        },
        "multiple": {
          "type": "integer"
        }
      },
      "required": [
        "events",
        "unalerted_indices",
        "multiple"
      ]
    },
    "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 โ†’