Log In

Overview

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

NameTypeObligatory?Description
createdAtlongAutogeneratedCreation date (timestamp UTC).
updatedAtlongAutogeneratedLast updated time (timestamp UTC).
experienceIdstringAutogeneratedExperience identifier.
campaignIdstringYesThe campaign id this experience belongs to.
config.namestringYesName of the experience.
config.descriptionstringNoDescription of the experience.
config.repeatstringYesRepeat interval. The experience cannot be triggered twice in this lapse of time.
config.enabledbooleanNoIndicates whether the experience is active or not.
triggerTriggerYesTrigger object that defines when the experience is triggered.
actionActionYesAction 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!"
    }
  }
}