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.
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
- See what’s set up.
reminders__getEventRemindersgives the overview.reminders__listRulesForEventlists every rule (includeInactive: trueincludes rules that are switched off). - 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. - Create a rule with
reminders__createReminderRule. Always dry-run first: it checks the timing and the merge fields.scopeKindis what the timing is measured from:event,invite,agenda_item,agenda_activityortodo, withscopeIdfor the session or to-do.offsetMinutesis negative for “before” and positive for “after”. For example,-43200is 30 days before and-2880is 2 days before.audienceis one of:confirmed_guests;unconfirmed_guests;activity_participants;condition: anyone matchingrecipientRule, the same rules as Message people who….
channelisemailorpush. Write the message insubjectTemplate,bodyTemplateandpushTitleTemplate, withbodyFormatset totextorrich.- Merge fields:
{{firstName}},{{lastName}},{{eventName}},{{actionLink}},{{missingItems}},{{todoTitle}},{{dueDate}}. - Repeats.
repeatEveryMinutesplusrepeatCount(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 itsdueAt.
- Edit with
reminders__updateReminderRule.active: 0switches a rule off without deleting it.reminders__resetDefaultReminderCopyrestores a default reminder’s original wording;timing: truealso restores its timing.reminders__deleteReminderRuleremoves a rule.
- 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.