Event Definition Schedule

An automation that executes a fire event activity will automatically be created if a schedule is defined in the Event Definition. The sample json below should be inserted into the Event Definition request body.

Sample JSON

FieldRequired ( Read Only)Description
StartDateTimeyesThe first time the scheduled automation should run.
EndDateTimenoThe last time the scheduled automation should run. Required if EndType = EndDate
OccurrencesnoInteger indicating how many times the scheduled automation should run. Required if EndType = Occurrences.
EndTypeyesEndDate or Occurrences, indicates if automation schedule should stop after a specified date or a specified number of runs.
FrequencyyesMinutely, Hourly, Daily, Weekly, Monthly, Yearly
RecurrencePatternyesInterval - used by Minutely, Hourly, DailyEveryWeekDay - used by DailyByDay - used by Weekly, Monthly, YearlyByWeek - used by Monthly, Yearly
IntervalnoInteger, used for Mintuely, Hourly, Daily, Weekly, and Monthly schedules (not used for Yearly). Required if RecurrencePattern = Interval.
SundaynoBoolean, may be null, only used for weekly schedules.
MondaynoBoolean, may be null, only used for weekly schedules.
TuesdaynoBoolean, may be null, only used for weekly schedules.
WednesdaynoBoolean, may be null, only used for weekly schedules.
ThursdaynoBoolean, may be null, only used for weekly schedules.
FridaynoBoolean, may be null, only used for weekly schedules.
SaturdaynoBoolean, may be null, only used for weekly schedules.
ScheduledDaynoDay of month (1 to 31), used for Monthly and Yearly schedules.
ScheduledDayOfWeeknoName of day of week (Sunday), used for Monthly and Yearly schedules.
ScheduledWeeknoFirst, Second, Third, Fourth, Last, used for Monthly and Yearly schedules.