Represents an event triggered by segment, time and proximity (such as beacons) conditions.
An Experience is composed of two components: The trigger and the action. The trigger defines when the experience is executed, based on defined conditions. The action is what is executed when the experience is triggered.
The Experience Object
Name | Type | Obligatory? | Description |
---|---|---|---|
createdAt | long | Autogenerated | Creation date (timestamp UTC). |
updatedAt | long | Autogenerated | Last updated time (timestamp UTC). |
experienceId | string | Autogenerated | Experience identifier. |
campaignId | string | Yes | The campaign id this experience belongs to. |
config.name | string | Yes | Name of the experience. |
config.description | string | No | Description of the experience. |
config.repeat | string | Yes | Repeat interval. The experience cannot be triggered twice in this lapse of time. |
config.enabled | boolean | No | Indicates whether the experience is active or not. |
trigger | Trigger | Yes | Trigger object that defines when the experience is triggered. |
action | Action | Yes | Action object that defines what happens when the experience is triggered. |
Repeat
Accepted values for the
config.repeat
field:
Immediately
,Never
,After1Min
,After3Min
,After5Min
,After15Min
,After30Min
,After1Hour
,After2Hours
,After4Hours
,After8Hours
,After12Hours
,After24Hours
,NextDay
,After2Days
,After3Days
,After5Days
,NextWeek
,After2Weeks
,NextMonth
,After2Months
{
"createdAt": 1494507646115,
"updatedAt": 1494508789757,
"experienceId": "EwMu6GDwRRuXXYbkktx--Q",
"campaignId": "dexNkpsVRPKdgkh6d6uDgg",
"config": {
"name": "Enter MOCA HQ",
"description": "Welcome message on arrival",
"repeat": "NextDay",
"enabled": true
},
"trigger": {
"@type": "EnterPlaceTrigger",
"placeId": "rzwbxsgXSRSxqdjSe7xZTQ"
},
"action": {
"@type": "OpenUrlAction",
"contentType": "text/x-url",
"content": {
"default": "http://www.mocaplatform.com"
},
"bgAlert": {
"default": "Welcome to MOCA office!"
}
}
}