{"__v":10,"_id":"55a5902880c8a30d00b323f8","category":{"__v":2,"_id":"55afb28ec8a85321007a5462","pages":["55b0cf51f202b12100cda2ff","55b0cf69b3171b3700b15404"],"project":"559a61d2dbcfd20d00710b39","version":"559a61d2dbcfd20d00710b3c","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-07-22T15:11:10.650Z","from_sync":false,"order":11,"slug":"experiences","title":"Experiences"},"parentDoc":null,"project":"559a61d2dbcfd20d00710b39","user":"55a575ebaaf9cf1900114d73","version":{"__v":23,"_id":"559a61d2dbcfd20d00710b3c","project":"559a61d2dbcfd20d00710b39","createdAt":"2015-07-06T11:09:06.510Z","releaseDate":"2015-07-06T11:09:06.510Z","categories":["559a61d3dbcfd20d00710b3d","55a589ddaaf9cf1900114dd0","55a589e30f354f0d00fd0312","55a589ea80c8a30d00b323cc","55a589f6aaf9cf1900114dd1","55a58d4e80c8a30d00b323e6","55a8e7a227a17d21005251a2","55a93098cf45e1390093f351","55afb085f202b12100cd9e83","55afb22e902fd51700f5f8bf","55afb260902fd51700f5f8c2","55afb28ec8a85321007a5462","55afb294f202b12100cd9e95","55afb29b902fd51700f5f8c5","55afb2a1c8a85321007a5463","55afb2a7902fd51700f5f8c7","55afb2ad902fd51700f5f8c8","55afb2b5902fd51700f5f8ca","55b74b2131bccb190081bedc","55bb441b54f9640d006e6cf2","565711085cb2420d00d70071","5681681330018c0d006bf7ff","588f38b5923d610f00c72dad"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-07-14T22:41:44.313Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":0,"body":"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.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"The Experience Object\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Obligatory?\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"createdAt\",\n    \"0-1\": \"long\",\n    \"0-2\": \"Autogenerated\",\n    \"0-3\": \"Creation date (timestamp UTC).\",\n    \"1-0\": \"experienceId\",\n    \"1-1\": \"string\",\n    \"1-2\": \"Autogenerated\",\n    \"1-3\": \"Experience identifier.\",\n    \"2-0\": \"appKey\",\n    \"2-1\": \"string\",\n    \"2-2\": \"Yes\",\n    \"2-3\": \"Application key.\",\n    \"3-0\": \"config.name\",\n    \"3-1\": \"string\",\n    \"3-2\": \"Yes\",\n    \"3-3\": \"Name of the experience.\",\n    \"4-0\": \"config.description\",\n    \"4-1\": \"string\",\n    \"4-2\": \"No\",\n    \"4-3\": \"Description of the experience.\",\n    \"5-0\": \"config.repeat\",\n    \"5-1\": \"string\",\n    \"5-2\": \"Yes\",\n    \"5-3\": \"Repeat interval. The experience cannot be triggered twice in this lapse of time.\",\n    \"6-0\": \"config.updatedAt\",\n    \"6-1\": \"long\",\n    \"6-2\": \"Autogenerated\",\n    \"6-3\": \"Last updated time (timestamp UTC).\",\n    \"7-0\": \"config.enabled\",\n    \"7-1\": \"boolean\",\n    \"7-2\": \"Yes\",\n    \"7-3\": \"Indicates whether the experience is active or not.\",\n    \"8-0\": \"config.exactlyOnce\",\n    \"8-1\": \"boolean\",\n    \"8-2\": \"Yes\",\n    \"8-3\": \"Indicates whether the experience can only be triggered once.\",\n    \"9-0\": \"campaignId\",\n    \"9-1\": \"string\",\n    \"9-2\": \"Yes\",\n    \"9-3\": \"The campaign id this experience belongs to.\",\n    \"10-0\": \"segmentId\",\n    \"10-1\": \"string\",\n    \"10-2\": \"No\",\n    \"10-3\": \"Segment Id, if the experience is targeted to a segment.\",\n    \"11-0\": \"action\",\n    \"11-1\": \"Action*\",\n    \"11-2\": \"No\",\n    \"11-3\": \"Action object that defines  what happens when the experience is triggered.\",\n    \"12-0\": \"trigger\",\n    \"12-1\": \"Trigger*\",\n    \"12-2\": \"No\",\n    \"12-3\": \"Trigger object that defines when the experience is triggered.\"\n  },\n  \"cols\": 4,\n  \"rows\": 13\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Repeat\",\n  \"body\": \"Accepted values for the `config.repeat` field:\\n`Immediately`, `Never`, `After1Min`, `After3Min`, `After5Min`, `After15Min`, `After30Min`, `After1Hour`, `After2Hours`, `After4Hours`, `After8Hours`, `After12Hours`, `After24Hours`, `NextDay`, `After2Days`, `After3Days`, `After5Days`, `NextWeek`, `After2Weeks`, `NextMonth`, `After2Months`\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Sample Experience Object\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"createdAt\\\": 1424351489581,\\n    \\\"experienceId\\\": \\\"PT7Swn6QcTw0dY6-sMAgJQ\\\",\\n    \\\"appKey\\\": \\\"AeZQ_Wm9iW2v7QgvdTtmx1\\\",\\n    \\\"config\\\": {\\n      \\\"category\\\": null,\\n      \\\"description\\\": null,\\n      \\\"name\\\": \\\"Enter Place Demo\\\",\\n      \\\"repeat\\\": \\\"NextDay\\\",\\n      \\\"updatedAt\\\": 1424351489582,\\n      \\\"enabled\\\": true,\\n      \\\"exactlyOnce\\\": false\\n    },\\n    \\\"campaignId\\\": \\\"klyRDN-RPe7wcaAsNJ5LLQ\\\",\\n    \\\"segmentId\\\": null,\\n    \\\"action\\\": {\\n      \\\":::at:::type\\\": \\\"SendLocalMessageAction\\\",\\n      \\\"contentType\\\": \\\"text/plain\\\",\\n      \\\"content\\\": {\\n        \\\"default\\\": \\\"Welcome to our Office!\\\"\\n      },\\n      \\\"bgAlert\\\": {}\\n    },\\n    \\\"trigger\\\": {\\n      \\\"@type\\\": \\\"EnterPlaceTrigger\\\",\\n      \\\"placeId\\\": \\\"8Q9mI6TyKhGXIMvlz1jr7g\\\"\\n    }\\n  }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"Represents an event triggered by segment, time and proximity (such as beacons) conditions.","slug":"experiences","type":"basic","title":"Experiences"}

Experiences

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. [block:api-header] { "type": "basic", "title": "The Experience Object" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Obligatory?", "h-3": "Description", "0-0": "createdAt", "0-1": "long", "0-2": "Autogenerated", "0-3": "Creation date (timestamp UTC).", "1-0": "experienceId", "1-1": "string", "1-2": "Autogenerated", "1-3": "Experience identifier.", "2-0": "appKey", "2-1": "string", "2-2": "Yes", "2-3": "Application key.", "3-0": "config.name", "3-1": "string", "3-2": "Yes", "3-3": "Name of the experience.", "4-0": "config.description", "4-1": "string", "4-2": "No", "4-3": "Description of the experience.", "5-0": "config.repeat", "5-1": "string", "5-2": "Yes", "5-3": "Repeat interval. The experience cannot be triggered twice in this lapse of time.", "6-0": "config.updatedAt", "6-1": "long", "6-2": "Autogenerated", "6-3": "Last updated time (timestamp UTC).", "7-0": "config.enabled", "7-1": "boolean", "7-2": "Yes", "7-3": "Indicates whether the experience is active or not.", "8-0": "config.exactlyOnce", "8-1": "boolean", "8-2": "Yes", "8-3": "Indicates whether the experience can only be triggered once.", "9-0": "campaignId", "9-1": "string", "9-2": "Yes", "9-3": "The campaign id this experience belongs to.", "10-0": "segmentId", "10-1": "string", "10-2": "No", "10-3": "Segment Id, if the experience is targeted to a segment.", "11-0": "action", "11-1": "Action*", "11-2": "No", "11-3": "Action object that defines what happens when the experience is triggered.", "12-0": "trigger", "12-1": "Trigger*", "12-2": "No", "12-3": "Trigger object that defines when the experience is triggered." }, "cols": 4, "rows": 13 } [/block] [block:callout] { "type": "info", "title": "Repeat", "body": "Accepted values for the `config.repeat` field:\n`Immediately`, `Never`, `After1Min`, `After3Min`, `After5Min`, `After15Min`, `After30Min`, `After1Hour`, `After2Hours`, `After4Hours`, `After8Hours`, `After12Hours`, `After24Hours`, `NextDay`, `After2Days`, `After3Days`, `After5Days`, `NextWeek`, `After2Weeks`, `NextMonth`, `After2Months`", "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Sample Experience Object" } [/block] [block:code] { "codes": [ { "code": "{\n \"createdAt\": 1424351489581,\n \"experienceId\": \"PT7Swn6QcTw0dY6-sMAgJQ\",\n \"appKey\": \"AeZQ_Wm9iW2v7QgvdTtmx1\",\n \"config\": {\n \"category\": null,\n \"description\": null,\n \"name\": \"Enter Place Demo\",\n \"repeat\": \"NextDay\",\n \"updatedAt\": 1424351489582,\n \"enabled\": true,\n \"exactlyOnce\": false\n },\n \"campaignId\": \"klyRDN-RPe7wcaAsNJ5LLQ\",\n \"segmentId\": null,\n \"action\": {\n \"@type\": \"SendLocalMessageAction\",\n \"contentType\": \"text/plain\",\n \"content\": {\n \"default\": \"Welcome to our Office!\"\n },\n \"bgAlert\": {}\n },\n \"trigger\": {\n \"@type\": \"EnterPlaceTrigger\",\n \"placeId\": \"8Q9mI6TyKhGXIMvlz1jr7g\"\n }\n }", "language": "json" } ] } [/block]