Reminders, due dates and repeats

Turn on the default confirm-your-spot reminders, and set up automatic messages before the event, before a session, or before a to-do is due.

Do first
Message people who haven't done something yet

A reminder rule sends a message at a time set relative to something: the event start, the guest’s invite, a session, or a to-do’s due date. It works out who to send to at send time, so guests who have already acted don’t get it.

Steps

  1. See what’s set up. reminders__getEventReminders gives the overview. reminders__listRulesForEvent lists every rule (includeInactive: true includes rules that are switched off).
  2. Default confirm-your-spot reminders. These go to invited guests who haven’t confirmed, 2, 7 and 14 days after their invite. Add any that are missing with reminders__addDefaultReminders. It only adds steps the event doesn’t have yet, and a dry-run lists what it would add.
  3. Create a rule with reminders__createReminderRule. Always dry-run first: it checks the timing and the merge fields.
    • scopeKind is what the timing is measured from: event, invite, agenda_item, agenda_activity or todo, with scopeId for the session or to-do.
    • offsetMinutes is negative for “before” and positive for “after”. For example, -43200 is 30 days before and -2880 is 2 days before.
    • audience is one of:
      • confirmed_guests;
      • unconfirmed_guests;
      • activity_participants;
      • condition: anyone matching recipientRule, the same rules as Message people who….
    • channel is email or push. Write the message in subjectTemplate, bodyTemplate and pushTitleTemplate, with bodyFormat set to text or rich.
    • Merge fields: {{firstName}}, {{lastName}}, {{eventName}}, {{actionLink}}, {{missingItems}}, {{todoTitle}}, {{dueDate}}.
    • Repeats. repeatEveryMinutes plus repeatCount (2 to 10) send it again. Each repeat checks again who still matches.
    • Due dates. scopeKind: "todo" with no rule goes to everyone who hasn’t finished that to-do, timed from its dueAt.
  4. Edit with reminders__updateReminderRule. active: 0 switches a rule off without deleting it.
    • reminders__resetDefaultReminderCopy restores a default reminder’s original wording; timing: true also restores its timing.
    • reminders__deleteReminderRule removes a rule.
  5. Check the timeline with reminders__listRemindersTimeline: what is scheduled, sent, skipped or failed, between two dates.

Examples

  • “Everyone without an arriving flight, 30 days before”: scopeKind: "event", offsetMinutes: -43200, audience: "condition", and the recipient rule {conditions:[{kind:"travel_missing", travel:"flight", direction:"arriving"}]}.
  • “Passport form, 2 days before it’s due, then daily twice more”: scopeKind: "todo", scopeId: <todoId>, offsetMinutes: -2880, repeatEveryMinutes: 1440, repeatCount: 3.

Updated 2026-11-02 · View as Markdown