Triggers

API 7.0

You can trigger predefined Events by sending a message to Touch Portal with the given eventId and additional data.

Sending a piece of data (a message) to Touch Portal should always end with a newline character. This will indicate Touch Portal that it is the whole message.

{
  "type":"triggerEvent",
  "eventId":"event002",
  "states":{
    "item1":"value",
    "item2":"someothervalue"
  }
}

This will trigger all events in Touch Portal that have the id "event002" and will send the states along as Local States in Touch Portal. The user will be able to use these in the flow as the user can with normal Local States.

Key Type Req. API Description
type Text yes 7.0 The "triggerEvent" corresponts to a message type to trigger an event by the given id.
eventId Text yes 7.0 The event id to trigger.
states Object No 7.0 This is a JSON Object that holds key value pairs of data that are used within Touch Portal as Local States.