Send Client Event

POST /v2/events/clientEvent

This endpoint is used to capture user activity throughout a session by logging various client events. It allows modeling specific user interactions such as interacting with an offer and recording an ad impression.

Request Headers:

Content-Type: application/json
Authorization: Bearer
x-source-customer-id: string
x-mock-data: true

Note: x-mock-data is only required to return dummy data for testing and development purposes. Refer to the Security Requirements section on suggestions to secure the x-source-customer-id.

Here is the documentation formatted for better readability:

Request Attributes:

ClientEventMessage

Property	Type	Description	Required
`clientEventId`	string	GUID assigned by client to associate with the event	Yes
`clientEventType`	`ClientEventType`	Type of the event which took place	Yes
`clientEvent`	`ClientEvent`	Event which took place	Yes
`clientEventTimestamp`	string	ISO-8601 timestamp representing when the event took place	Yes
`clientEventMetadata`	`ClientEventMetadata`	Metadata to associate with event, if applicable	Depends

LogEnrollment (Send Client Event)

Request Payload

{
    "clientEvents": [
        {
            "clientEventId": "12395199-1565-4565-bf99-3f94ee505d12",
            "clientEventType": "SessionAction",
            "clientEvent": "LogEnrollment",
            "clientEventTimestamp": "2024-10-01T07:00:00Z",
         }
    ]
}

Response

{
    "requestId": "380052b4-3a64-4952-b640-ba696eb9f44b"
}

Activating an offer (Send Client Event)

Request Payload

{
    "clientEvents": [
        {
            "clientEventId": "12395199-1565-4565-bf99-3f94ee505d12",
            "clientEventType": "AdInteraction",
            "clientEvent": "ActivateOffer",
            "clientEventTimestamp": "2024-10-01T07:00:00Z",
            "clientEventMetadata": {
                "serveToken": "CiQ3MGU5ZjQzMy0xMjQxLTRlZTctOTZlZi02ZWM4MDQwZjg3MzgQqoTjo6syGgoxMDAwMDYyNzQwIgVFbWFpbA==",
                "section": "Dashboard",
                "channel": "OLB",
            }
        }
    ]
}

Response

{
    "requestId": "380052b4-3a64-4952-b640-ba696eb9f44b"
}

Send an Impression (Send Client Event)

Request Payload

{
    "clientEvents": [
        {
            "clientEventId": "12395199-1565-4565-bf99-3f94ee505d12",
            "clientEventType": "AdImpression",
            "clientEvent": "AdViewableImpression",
            "clientEventTimestamp": "2024-10-01T07:00:00Z",
            "clientEventMetadata": {
                "serveToken": "CiQ3MGU5ZjQzMy0xMjQxLTRlZTctOTZlZi02ZWM4MDQwZjg3MzgQqoTjo6syGgoxMDAwMDYyNzQwIgVFbWFpbA==",
                "section": "Dashboard",
                "channel": "OLB",
            }
        }
    ]
}

Response

{
    "requestId": "380052b4-3a64-4952-b640-ba696eb9f44b"
}

Response:

200 OK: Indicates successful retrieval of ads.
401 Unauthorized: Indicates that token is invalid
500 Internal Server Error: Indicates a failure in submitting clientEvent.

Types

ClientEventType

Value	Type	Description
`AdImpression`	`String`	Pertains to an Ad Impression, e.g., a viewable impression
`AdInteraction`	`String`	Pertains to an Ad Interaction, such as activating the Ad
`CustomerProfileAction`	`String`	Action on a customer’s profile, like viewing a reward summary
`SessionAction`	`String`	Pertains to a customer’s session, such as changing geolocation

ClientEvent

Value	Type	Event description	ClientEventType
`DisplayElementExpanded`	`String`	User expanded display element to show offer details	AdInteraction
`DisplayElementCollapsed`	`String`	User collapsed display element to hide offer details	AdInteraction
`UrlLinkClicked`	`String`	User clicked on a URL embedded in an offer message	AdInteraction
`ActivateOffer`	`String`	Activate the offer associated with an Ad	AdInteraction
`ParkOffer`		Park an offer, hiding it from the customer	AdInteraction
`AdViewableImpression`	`String`	Signal that a viewable impression has taken place	AdImpression
`LogEnrollment`	`String`	Event sent when the user is shown offers at session start	SessionAction

ClientEventAdMetadata

Value	Type	Event description	Required
`serveToken`	`String`	Serve token which was originally returned with the ad	Yes
`section`	Section	ID pertaining to the FI-specific section of the UI where the event took place. For example, if the event took place in a “Featured Offers” section with a sectionId of 5, the event’s sectionId should be set to 5	Yes
`channel`	`Channel`	Channel through which the ad was delivered	Yes
`imageSlots`	`String[]`	Activate the offer associated with an Ad	No
`categoryId`	`String`	Park an offer, hiding it from the customer	No
`curationId`	`String`	Signal that a viewable impression has taken place	No
`displayPosition`	`Integer`	Event sent when the user is shown offers at session start	Yes

Channel

Value	Type	Event description
`Email`	`String`	Email advertising channel
`SMS`	`String`	Text messaging channel
`MMS`	`String`	Multimedia text messaging channel
`OLB`	`String`	Online Banking, the typical online banking website channel
`MobileWeb`		Mobile Online Banking, the mobile specific online banking
`MobileWeb`	`String`	Native mobile device applications channel
`MobileWallet`		Mobile Wallet application channel

Section

Value	Event description
`Email`	Activatable email
`SMS`	Text messaging channel
`MMS`	Multimedia text messaging channel
`Transaction`	Underneath or relative to a specific debit/credit transaction
`Summary`	A section which displays a summary of the customer’s rewards and/or offers
`Dashboard`	A section featuring the rewards program’s education, instructions, or other things for interfacing with the rewards program other than viewing offer details and rewards
`Landing`	Customer landing page for a website or web application
`OnboardingPage`	Rewards program onboarding page
`LatestOffers`	Latest Offers section
`ExpiringSoon`	Expiring Soon section
`RewardSummaryListView`	Reward Summary list view
`FeaturedOffers`	Featured Offers section
`Rewards`	A Rewards page that shows rewards you have been paid
`WidgetAccountOverview`	Account Overview area of the widget
`WidgetDebit`	Debit area of the widget
`WidgetCredit`	Credit area of the widget
`Map`	A map view such as MapQuest