Campaign Classic event reference

Events handled

The following events are handled by the Adobe Campaign Classic extension:

Campaign request content

This event is a request to make a registration or a track (receive or click) call and is generated by the API when the following conditions are met:

• When a registration request needs to be sent (registerDevice).
• When a track receive request needs to be sent (trackNotificationReceive).
• When a track click request needs to be sent (trackNotificationClick).

registerDevice

The following key-value pairs are used in this event:

The registerDevice API parameters are also sent in the event, as described below. The deviceinfo map is internally populated.

Copy
{
    "additionalParameters": {
        "firstName": "John",
        "lastName": "Doe",
        "zipCode": 94403,
        "testId": "11000.1110002321321",
        "region": "US",
        "userId": "123999333",
        "age": 28
    },
    "deviceToken": "d6x4Bu6pxDg:APA91bG9jZb6oQ3-sExUZRbaYP_LjA6POO0NXMaUaxcBQj9GF5ZBGlFo76raIabLziMMt2mLhLafBW9kYqiZ3Nemwjox3Hg6muTPyLeMOuGj24mCitVt73_KML184meqLYXCqhvg53MI",
    "registerDevice": true,
    "deviceInfo": {
        "deviceName": "generic_x86",
        "deviceBrand": "Android",
        "deviceManufacturer": "unknown",
        "deviceUuid": "00000000-3398-7b70-0000-000033987b70"
    },
    "userKey": "john@example.com"
}
Copied to your clipboard
{
    "additionalParameters": {
        "firstName": "John",
        "lastName": "Doe",
        "zipCode": 94403,
        "testId": "11000.1110002321321",
        "region": "US",
        "userId": "123999333",
        "age": 28
    },
    "deviceToken": "d6x4Bu6pxDg:APA91bG9jZb6oQ3-sExUZRbaYP_LjA6POO0NXMaUaxcBQj9GF5ZBGlFo76raIabLziMMt2mLhLafBW9kYqiZ3Nemwjox3Hg6muTPyLeMOuGj24mCitVt73_KML184meqLYXCqhvg53MI",
    "registerDevice": true,
    "deviceInfo": {
        "deviceName": "generic_x86",
        "deviceBrand": "Android",
        "deviceManufacturer": "unknown",
        "deviceUuid": "00000000-3398-7b70-0000-000033987b70"
    },
    "userKey": "john@example.com"
}

trackNotificationReceive

The following key-value pairs are used in this event:

The trackNotificationReceive parameters are also sent in the event, as described below:

Copy
{
    "trackReceive": true,
    "trackInfo": {
        "_mId": "12345",
        "_dId": "f0190"
    }
}
Copied to your clipboard
{
    "trackReceive": true,
    "trackInfo": {
        "_mId": "12345",
        "_dId": "f0190"
    }
}

trackNotificationClick

The following key-value pairs are used in this event:

The trackNotificationClick parameters are also sent in the event, as described below:

Copy
{
    "trackClick": true,
    "trackInfo": {
        "_mId": "12345",
        "_dId": "f0190"
    }
}
Copied to your clipboard
{
    "trackClick": true,
    "trackInfo": {
        "_mId": "12345",
        "_dId": "f0190"
    }
}

Configuration response content

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

Data payload definition

The following key/value pair is used by the Adobe Campaign Classic extension from the configuration event.

Events dispatched

The following events are dispatched by the Campaign Classic extension:

Campaign response content

This event is a response from the Campaign Classic extension to notify the result of the registration request that is sent to the Campaign Classic marketing server.

This event is dispatched in a response to the registerDevice API and contains a registrationstatus key of type boolean, which signals the success or failure of the registration request.

Event details

Data payload definition

The following key-value pair is used in this event:

Event data example

Registration status

Copy
{
    "registrationstatus": true
}
Copied to your clipboard
{
    "registrationstatus": true
}