organizationstring uuid required
ID of the organization this reminder belongs to. You must be a member of it.
teaminteger nullable
Optional ID of the project this reminder is scoped to. Required when targeting a specific resource. Must belong to the chosen organization.
titlestring required
Short text shown as the notification title when the reminder fires.
messagestring
Optional longer body for the notification.
resource_typestring nullable
Optional PostHog resource this reminder is about. One of: dashboard, insight, experiment, feature_flag, survey, notebook, replay, error_tracking. Resources are project-scoped, so a team must be set when this is provided.
resource_idstring nullable
ID of the referenced resource; must exist in the chosen project.
scheduled_atstring date-time nullable
For a one-off reminder: when it should fire (ISO 8601, future).
cron_expressionstring nullable
For a recurring reminder: a 5-field cron expression (e.g. '0 9 * * 1' = Mondays 9am). May fire at most 4 times per day. Mutually exclusive with recurrence_interval.
timezonestring
IANA timezone the schedule resolves in (e.g. 'America/New_York'). Defaults to the project timezone when a team is set, otherwise UTC.
end_datestring date-time nullable
Optional: recurring reminders stop (status=completed) after this time.
next_fire_atstring date-time nullable required
last_fired_atstring date-time nullable required
status'active' | 'completed' | 'errored' required
- active - Active
- completed - Completed
- errored - Errored
created_atstring date-time required
updated_atstring date-time nullable required