Configuring execution time

Search…
You can configure when a Reaction should invoke an action for a matching event by configuring its execution time.
Immediate Reactions
Immediate Reactions causes the preconfigured action to execute as soon as an event of the expected type is received.
Example of a request setting up a Reaction that triggers immediately on event:
1
{
2
  "reactionName": "notify-on-order-shipped",
3
  "feedName": "order",
4
  "reactOnEventType": "OrderShippedEvent",
5
  "action": {
6
    "actionType": "HTTP_POST",
7
    "targetUri": "https://your-email-service"
8
  }
9
}
Copied!
A scheduled Reaction is configured to wait a certain time before executing its action. This makes it possible to implement use-cases such as reminders, loyalty awards or other cases where time is an important factor.
Scheduled Reactions
A scheduled Reaction is configured to wait a certain time before executing its action. This makes it possible to implement use-cases such as reminders, loyalty awards or other cases where time is an important factor.
To create a scheduled Reaction that triggers at a point in time relative to the time the event occurs, specify a pattern in the field offset. The pattern is defined in the ISO-8601 duration format (PnDTnHnMn.nS) - see separate section for details. Note that specifying a negative offset does not make sense in this case and will cause the Reaction to trigger instantly when the event occurs.
Example of a request setting up a Reaction with a 12h delay:
1
{
2
  "reactionName": "remind-players",
3
  "feedName": "gameround",
4
  "reactOnEventType": "GameRoundCompletedEvent",
5
  "offset": "PT12H",
6
  "action": {
7
    "actionType": "HTTP_POST",
8
    "targetUri": "https://your-push-notification-service"
9
  }
10
}
Copied!
Absolute trigger time
To create a scheduled Reaction that triggers at a point in time specified in the event data, use the field triggerTimeField and point out where the time information is located in the event. Note that dot notation is allowed.
Example of an event containing time information:
1
 {  
2
     "eventId":"634daa41-ba64-4558-9ee3-a281060f37ee",
3
     "eventType":"MeetingCreatedEvent",
4
     "data":{  
5
        "meeting": {
6
          "startTime": "2018-02-05T12:00:00Z"
7
        }
8
     }
9
  }
Copied!
Example of a request setting up a Reaction that will trigger when the meeting starts:
1
{
2
  "reactionName": "notify-participants",
3
  "feedName": "meeting",
4
  "reactOnEventType": "MeetingCreatedEvent",
5
  "triggerTimeField": "meeting.startTime",
6
  "action": {
7
    "actionType": "HTTP_POST",
8
    "targetUri": "https://some-notification-service"
9
  }
10
}
Copied!
Absolute trigger time with offset
It’s possible to add an offset to the case described above. For instance, to create a Reaction triggering two hours before the meeting starts, create a Reaction with both the triggerTimeField and the offset field specified. The offset pattern is defined in the ISO-8601 duration format (PnDTnHnMn.nS) which also supports negative offsets. See separate section for details.
1
{
2
  "reactionName": "remind-participants",
3
  "feedName": "meeting",
4
  "reactOnEventType": "MeetingCreatedEvent",
5
  "triggerTimeField": "meeting.startTime",
6
  "offset": "-PT2H",
7
  "action": {
8
    "actionType": "HTTP_POST",
9
    "targetUri": "https://your-push-notification-service"
10
  }
11
}
Copied!
Offset pattern
The offset pattern is defined in the ISO-8601 duration format (PnDTnHnMn.nS).
Examples:
1
"PT20.345S" - parses as "20.345 seconds"
2
"PT15M"     - parses as "15 minutes" (where a minute is 60 seconds)
3
"PT10H"     - parses as "10 hours" (where an hour is 3600 seconds)
4
"P2D"       - parses as "2 days" (where a day is 24 hours or 86400 seconds)
5
"P2DT3H4M"  - parses as "2 days, 3 hours and 4 minutes"
6
"PT-6H3M"   - parses as "-6 hours and +3 minutes"
7
"-PT6H3M"   - parses as "-6 hours and -3 minutes"
8
"-PT-6H+3M" - parses as "+6 hours and -3 minutes"
Copied!
Supported date/time formats  
The date or timestamp in the field specified as the triggerTimeField must be in any of the following formats:
Epoc millis timestamp (number)
'yyyy-MM-dd'T'HH:mm:ssZ'
'yyyy-MM-dd'
'yyyyMMdd'
'yyMMdd'
Cancelling scheduled actions
Each scheduled Reaction can be configured to automatically cancel its pending action if a certain event occurs by adding the event type to the array cancelOnEventTypes. This is particularly useful for cancelling timeouts or reminders no longer valid.
Example of a body setting up a Reaction with a 12h delay and a cancelOn event:
1
{
2
  "reactionName": "send-reminder-to-inactive-users",
3
  "feedName": "gamerounds",
4
  "reactOnEventType": "UserLoggedOutEvent",
5
  "cancelOnEventTypes": ["UserLoggedInEvent"],
6
  "offset": "P7D",
7
  "action": {
8
    "actionType": "HTTP_POST",
9
    "targetUri": "https://your-email-service"
10
  }
11
}
Copied!
Basic Usage
API Reference
Last modified 3yr ago
Copy link
Contents
Immediate Reactions
Scheduled Reactions
Absolute trigger time
Absolute trigger time with offset
Cancelling scheduled actions