Skip to main content

Interval Timer Event Source

When you select Interval Timer as the event source for the Flux App, the App will be triggered at regular intervals.

Copy/Save

Interval Timer Event Source

When you select Interval Timer as the event source for the Flux App, the App will be triggered at regular intervals.

Event Source Configuration

Set the conditions for when event messages should be published to the channel from the event source.

  • Enabled: To send messages using the interval timer, set to Enable. If set to Disable, no message will be sent.
  • Schedule Expression: Specify the time interval as an integer. The minimum interval is 1 minute.
  • Event Payload: Sets the JSON object that is sent to the attached channel when the Scheduled Timer starts.
  • Description: Enter a description of the Interval Timer.

Data Format

The data sent to a channel configured with the Interval Timer event source consists of Message and Context.

You can check the data received by the event to the Flux App in the History tab of Soracom Flux Studio. For more details, refer to View Logs.

Message

Message specified in the Event Payload, or null if not specified.

Context

Data related to the Interval Timer. Here's an example:

{
  "eventType": "schedule",
  "scheduleId": "0123456789ABCDEFGHIJKLMNOP",
  "timestamp": 1723203168131
}

The attributes are as follows:

AttributeDescription
eventTypeThe type of event. When the Interval Timer triggers the Flux App, the value is schedule.
scheduleIdAn ID assigned to each Interval Timer.
timestampThe date and time when the Flux App execution was triggered by the Interval Timer event source (UNIX time in milliseconds).

To reference the above Context in an action, input it as ${event.context.<CONTEXT_ATTRIBUTE>} or event.context.<CONTEXT_ATTRIBUTE> == 1.

Search Esc to close / Enter to view results