Event API Responses

Requests sent to the Event API return JSON that contains information about any campaigns that are returned. A response from the Event API has the following structure.

{
    "campaignResponses": CampaignResponse[],
    "compiledCampaignTemplates": CompiledCampaignTemplate[],
    "campaignExplanations": CampaignExplanation[],
    "errorCode": number,
    "resolvedUserId": string,
    "persistedUserId": object,
    "eventDetails": eventDetails
}

The CampaignResponse Object

The CampaignResponse object contains data associated with the campaigns returned from an event.

{
    "type": string,
    "campaignId": string,
    "campaignName": string,
    "campaignType": string,
    "experienceId": string,
    "experienceName": string,
    "experienceSourceCode": string,
    "state": string,
    "displayMode": string,
    "redirectUrl": null,
    "saveParameters": boolean,
    "hidePageBeforeRedirect": boolean,
    "campaignJavascriptContent": null,
    "javascriptContent": null,
    "userGroup": string,
    "googleAnalyticsConfig": null,
    "messages": [],
    "pageChanges": [],
    "templateNames": string[],
    "serverSideMessages": ServerSideMessage[],
    "payload": payload
}

The ServerSideMessage Object

The ServerSideMessage object contains data associated with serverSideMessages returned in a campaignResponse.

For server-side campaigns, an array of ServerSideMessage objects is returned that contains information about the data returned for the server-side campaign message. The event must be sent with source.channel set to "Server" in order to return serverSideMessages. For more information on configuring server-side campaigns, see Server-Side Campaigns.

{
    "type": string,
    "id": string,
    "data": string,
    "targetName": string,
    "containsDynamicContent": boolean,
    "promotedItemKeys": PromotedItem[] | null,
    "campaignState": string,
    "dataMap": dataMap
}

Example Values

The following is an example of a value returned in the promotedItemKeys object:

{
    type: "p",
    _id: "123"
}

The following is an example of a value returned in the dataMap object:

dataMap: {
    "myText": "helloWorld",
    "myNumber": "1",
    "myPromotedContent": [
        {
            "type": "p",
            "_id": "123"
        },
        {
            "type": "p",
            "_id": "456"
        }
    ]
}

For keys with type "Promoted Content", the full value of each item is returned unless the "Item IDs only" option is enabled in the message settings. For more information on configuring server-side campaigns and the returned dataMap object, see Server-Side Campaigns.

The CompiledCampaignTemplates Object

The CompiledCampaignTemplates object contains data associated with campaignTemplates returned in an event.

An event response returns an array of any compiledCampaignTemplates used in a campaignResponse. The compiledCampaignTemplates object contains information about the campaign templates.

{
    "id": string,
    "name": string | null,
    "bundle" string
}

The CampaignExplanations Object

The CampaignExplanations Object contains data associated with campaignExplanations returned in an event.

The campaignExplanations object returns in an event only if debug.explanations is true in the event payload. It contains additional information about why campaigns did or didn’t return in the event response. It’s only returned if the event request is authenticated.

{
    "class": string,
    "campaignId": string,
    "campaignName": string,
    "experienceId": string,
    "experienceName": string,
    "messageId": string,
    "explanationMessage": string,
    "context": string
}

See Also

• Salesforce Help: Server-Side Campaigns