Events handled

The following events are handled by the Campaign Standard extension:

Campaign Request Content

This event is dispatched from the Event Hub when a Campaign rule is found to be true. For example, after the user launches the app, the "User has launched the app" rule is found to be true. A triggered consequences event is dispatched, which contains the data of the displayed local, alert, or full-screen message.

Data payload definition

Here are the key-value pairs in this event:

Event data example

triggered consequence data

{
  "triggeredconsequence": {
    "assetsPath": "assets/path/",
    "id": "123",
    "detail": {
      "template": "local",
      "wait": 0,
      "userData": {
        "deliveryId": "123abc",
        "broadlogId": "456edf"
      },
      "title": "local example",
      "content": "local example text"
    },
    "type": "iam"
  }
}

Configuration Response Content

The data property in this event is used by each extension to modify its current settings. Each extension is responsible for reading out the part of the data property for which it is concerned.

Data payload definition

The Adobe Campaign Standard extension reads the following key from the configuration event:

Event data example

{
    "global.privacy":"optedin",
    "campaign.timeout":1,
    "campaign.mcias":"mcias-va7.cloud.adobe.io/mcias",
    "__dev__campaign.pkey":"",
    "__stage__campaign.pkey":"",
    "campaign.pkey":"",
    "__dev__campaign.server":"mcias.campaign-demo.adobe.com",
    "__stage__campaign.server":"mcias.campaign-demo.adobe.com",
    "campaign.server":"mcias.campaign-demo.adobe.com"
}

Request Identity

This event is dispatched by the API to setLinkageFields, which sets the linkage fields. It is used to download personalized in-app messages.

Data payload definition

Here are the key-value pairs in this event:

Event data example

{ 
    "linkagefields": 
    { 
        "firstName":"john", 
        "lastName":"doe", 
        "age":30
    }
}

Request Reset

This event is dispatched when users no longer want to use personalized in-app messages. After this event is received, Campaign deletes all personalized messages and downloads only generic messages again.

Data payload definition

This event has no event data.

Lifecycle Response Content

This event is a response from the Lifecycle extension to notify a client/extension about lifecycle context data in which the extension/client might be interested. The event is generated by the Lifecycle extension, and the API is called after a lifecycle start, stop, or pause.

Data payload definition

Here are the key-value pairs in this event:

Event data example

{    "lifecyclecontextdata": 
    {
        "installdate":"22/05/2014",        
        "hourofday":6,        
        "dayofweek":2,        
        "osversion":"iOS 12.3",        
        "appID":"contextDataValue",        
        "resolution":"600x1345",        
        "devicename":"iPhoneX",        
        "launchevent":"LaunchEvent",        
        "prevsessionlength":345,        
        "locale":"en-US",        
        "runmode":"Application",        
        "launches":42    
    },    
    "starttimestampmillis" :44,    
    "maxsessionlength":22
}

Generic Data OS

This event is dispatched by the Core extension to the Event Hub when the collectMessageInfo API is invoked by the app developer to track local and push notification interactions.

Data payload definition

Here are the key-value pairs in this event:

Event data example

{
  "deliveryId": "1442de4",
  "action": "2",
  "broadlogId": "h1c1380"
}

Events dispatched

The following events are dispatched by the Campaign Standard extension:

Campaign Response Content

This event is a response from the Adobe Campaign Standard extension and contains the message interaction details (Viewed, Triggered or Clicked).

Event details

Data payload definition

Here is the definition of the key-value pairs in this event:

Event data example

{ "a.message.id": "12345678", "a.message.triggered": "1" }
{ "a.message.id": "12345678", "a.message.viewed": "1" }
{ "a.message.id": "12345678", "a.message.clicked": "1" }