Create an alert (legacy)
create_alarmCreate an alarm on the user's iPhone (kept for agents set up before 2026-10). Without fire_at it is a notification now (the app's feed); with fire_at a reminder at that time. type "normal": a quiet notification. type "urgent": an alarm that rings through silent mode and Focus until the user taps Done or Snooze. Use urgent only when the user must not miss it. "Call me", "ring me", "phone me", "wake me" (in any language) means an urgent alarm: now, or at the time they name. Optional color: pick the one that fits (see the color argument), or the one the user asks for. Optional sound (urgent alarms only): omit it for the user's default sound, or pick one that fits (see the sound argument).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | Optional details. Supports line breaks and URLs: line breaks are kept, and links, phone numbers and addresses can be tapped in the app. | |
| icon | No | Optional. The icon shown with it in the app, the Live Activity and the widget. Pick the one that fits, or omit it for the default (bell). Icons: bell: anything else (the default); checkmark.circle: a task, job or build finished; exclamationmark.triangle: an error, incident, failure or outage; calendar: a meeting, appointment, deadline or event; sportscourt: sport: a match, a game, a workout; gift: a birthday, anniversary or holiday; cart: shopping, orders, deliveries, prices; airplane: travel: flights, trips, check-in; heart: health and personal life: medication, family, self-care; briefcase: work: reviews, follow-ups, documents, clients. | |
| type | No | Default normal. | |
| color | No | Optional. The colour in the app (its icon in the feed and the list, the alarm screen and the Live Activity). Use the colour the user asks for. Otherwise pick the one that fits best, or omit it for the default (blue). Colours: blue: everything else (the default); red: critical: incidents, outages, failures, hard deadlines; orange: important or due soon: reviews, renewals, follow-ups; green: personal and health: sport, medication, family errands, money; purple: events and fun: meetings, birthdays, trips, matches. | |
| sound | No | Optional. The sound it rings with: only when it rings (urgent, ring: true); a quiet one is a notification with the sound from the app's Settings. Use the sound the user asks for. Otherwise omit it for the user's chosen default sound (picked in the app's Settings), or pick one when the context clearly suggests it: a football match -> stadium, something that must wake the user -> loudalarm or urgentpulse, a gentle nudge -> calmpiano or softbells. Sounds, calm to loud: default: the iPhone's standard system alarm sound, familiar; calmpiano: calm soft piano, gentle: quiet nudges, evenings; softbells: soft bells, gentle and quiet: a reminder that must not startle; sunrise: slowly rising warm tones: a gentle wake-up in the morning; chime: a clear short chime, neutral: everyday reminders; brightmarimba: bright cheerful marimba, the classic phone alarm feel: a normal alarm; upbeatpop: upbeat pop melody, energetic and happy: workouts, fun plans; urgentpulse: fast insistent pulsing beeps, hard to ignore: something urgent, incidents; loudalarm: very loud aggressive alarm that wakes you up: must not be slept through; stadium: football stadium fans chanting with drums and air horns: matches, sports events. | |
| title | Yes | Short text shown on the alarm. | |
| ends_at | No | Reminders only: when it ends (ISO 8601, after fire_at). | |
| fire_at | No | Only when the user named a time: a reminder then. ISO 8601 with offset, e.g. 2026-10-23T09:00:00+03:00. Without an offset the user's timezone is used. Omit for a notification now. | |
| location | No | Optional. An address or place; the app offers to open it in Maps. One line. | |
| countdown | No | Reminders only: show a countdown to fire_at on the phone. |