Scheduling

Notification scheduling defaults

When you create a notification, you will be able to set timedelta, which may be used on its own as a delay (when having a positive value), or in combination with the schedule parameter set in the event payloads.

Event payload

The schedule option lets you fine tune when the event should be processed. Common use cases are meeting reminders, post-event surveys, a specific time of the day, a simple delay, etc.

Options

The options for scheduling are: datetime, timedelta, time and timezone. You may use multiple combinations of these but some combinations are not allowed (see below).

Definitions

• datetime (ISO 8601 format): By default we compute when to process an event based on its creation date. If you set datetime, the event will be processed at the time specified.
  Example: 2022-01-23T22:22:00-07:00
  The timezone is optional and defaults to UTC.
• timedelta (number + unit): Offsets the processing of an event up to 30 days in the past/future.
  Examples: +1day, -30minutes, 3600seconds
  Allowed units are: "week(s)", "day(s)", "hour(s)", "minute(s)", "second(s)"
  If no unit is set, the default is seconds, e.g. 2022-01-23T22:22:00
• time (24 hour format): Ideally processes the event at a specific time of the day. If the event is sent after that time, it is processed immediately. So for a time set at 13:00, events sent from 00:00 to 13:00 will be processed at 13:00, and events sent from 13:01 to 23:59 will be sent immediately.
  Example: 10:00, 23:59:59
  If the timezone attribute isn't set, UTC is assumed.
• timezone: Can only be used with time.
  Example: "America/Denver", "Europe/Paris"

Combinations

• datetime + timedelta: You can set a timedelta (negative or positive) to offset the processing of an event scheduled at a specific datetime.

  • Send reminder 30 minutes before the meeting:
    datetime="2022-01-23T22:22:00-07:00" timedelta="-30minutes"
  • Send a survey a day after an event:
    datetime="2022-01-23T22:22:00-07:00" timedelta="+1day"

• time + timezone: Set a specific timezone for the time of the day.
  time="13:30" timezone="Europe/Paris"

• datetime + time: Send at a specific time on a specific day.
  datetime="2022-01-02T13:00" time="11:30"