Web Triggers Overview
Table of Contents
Web Triggers enable any app in the world to talk to an IntuiFace experience, provided both that third party app and IntuiFace has Internet access.
The mechanism is simple. Using any possible trigger, you can send a message with up to 3 parameters to one or more of your running IntuiFace experiences. Within the experience, a Message is received trigger will be raised with the message name and the parameters. It's then up to you to decide which actions you need to call within your experience, based on the received message.
To put this mechanism in place, you need to follow these three steps:
- Create a credential key. Make sure you use a key fpr the IntuiFace account that owns the licenses used by Players in the field.
- Identify the message you will be forwarding to IntuiFace and build the Zap/Applet/API call as needed for Zapier/IFTTT/third party services.
- Add the Web Triggers Interface Asset into your experience and set the proper Message is received triggers and the associated actions.
NOTE: A trigger can only be raised while in Play mode. To test your web triggers with Composer, don't forget to hit the Play button after setting your triggers and actions.
You need to add an instance of the Web Triggers Interface Asset into your experience, one for each message you expect to receive from the outside world.
You can then configure the Message is received trigger to call one or more actions. Use the optional "Message" filter parameter if you only want the trigger raised when a specific message is received. Otherwise, the trigger will be tripped by any message.
You can also use the message parameters as a condition for when to trigger a particular action.
On the action side, you can reuse the Message is received trigger properties as action parameters by using binding.
Now that your experience is ready to receive messages through its Web Triggers API, you need to setup how these messages will be sent. Non-developers can use our integration with IFTTT and Zapier. If you want to integrate an app which is not supported by these two platforms, use the Web Triggers API to create the integration yourself.
In all three cases, by default, the message will be sent to any of your running IntuiFace experiences. The identification of which experiences should be targeted is determined by your credential key.
Within IFTTT and Zapier, you have the option of specifying a subset of your experiences and / or Players by using a variety of filter properties:
- Experience name(s)
- Player name(s)
- Player tag(s)
With the Web Trigger API, you can use all of the above criteria plus:
- Experience ID(s)
- Player ID(s)
If you specify multiple fields, the filtering rule will be an AND of these rules.
Usage sample: In the context of meeting room signage, when you get an event reminder from a calendar, only update onscreen content for the Player which has the calendar name set as a tag.
These are the Properties, Triggers & Actions of the Web Triggers Interface Asset that enable you to receive messages from any third party application, service, or device in the cloud.
The properties below are read-only properties, thus only visible through a binding
All of these properties can be used to identify a Player / experience you want to target with a Web Trigger.
See more explanations in the article about the Web Triggers API Demo experience
- Device ID
- Device Name
- Experience name
- Experience ID
- Is connected
- Message is received: Raised when a message is received. Use the optional "Message filter" parameter to specify particular message content. This trigger is raised with the following properties:
- Parameter 1
- Parameter 2
- Parameter 3
This Interface Asset currently doesn't have any actions.