Notifications
Notifications should be fired when a prefetched mbox or view has been visited or rendered to the end user.
In order for notifications to be fired off for the right mbox or view, be sure to keep track of the corresponding eventToken for each mbox or view. Notifications with the correct eventToken for the corresponding mboxes or views are required to be fired in order for reporting to be reflected correctly.
Notifications for Prefetched Mboxes
One or multiple notifications can be sent via a single delivery call. Determine whether the metric that needs to be tracked is either a click or display for each mbox so that the type of the notification can be reflected correctly. Also, pass in an id for each notification so that one can determine whether a notification was sent correctly thru the Adobe Target Delivery API. The timestamp is also important to be forwarded to Target to indicate when the click or display occurred for a given mbox for reporting purposes.
curl -X POST \
'https://demo.tt.omtrdc.net/rest/v1/delivery?client=demo&sessionId=10abf6304b2714215b1fd39a870f01afc#1555632114' \
-H 'Content-Type: application/json' \
-H 'cache-control: no-cache' \
-d '{
"id": {
"tntId": "abcdefghijkl00023.1_1"
},
"context": {
"channel": "web",
"browser" : {
"host" : "demo"
},
"address" : {
"url" : "http://demo.dev.tt-demo.com/demo/store/index.html"
},
"screen" : {
"width" : 1200,
"height": 1400
}
},
"notifications": [
{
"id" : "SummerOfferNotification",
"timestamp" : 1555705311051,
"type" : "display",
"mbox" : {
"name" :"SummerOffer"
},
"tokens" : [
"GcvBXDhdJFNR9E9r1tgjfmqipfsIHvVzTQxHolz2IpSCnQ9Y9OaLL2gsdrWQTvE54PwSz67rmXWmSnkXpSSS2Q"
]
},
{
"id" : "SummerShoesOfferNotification",
"timestamp" : 1555705311051,
"type" : "display",
"mbox" : {
"name" :"SummerShoesOffer"
},
"tokens" : [
"GcvBXDhdJFNR9E9r1tgjfmqipfsIHvVzTQxHolz2IpSCnQ9Y9OaLL2gsdrWQTvE54PwSz67rmXWmSnkXpSSS2Q"
]
},
{
"id" : "SummerDressOfferNotification",
"timestamp" : 1555705311051,
"type" : "display",
"mbox" : {
"name" :"SummerDressOffer"
},
"tokens" : [
"GcvBXDhdJFNR9E9r1tgjfmqipfsIHvVzTQxHolz2IpSCnQ9Y9OaLL2gsdrWQTvE54PwSz67rmXWmSnkXpSSS2Q"
]
}
]
}'
The example call above will result in a response that indicates the notifications request was successfully processed.
{
"status": 200,
"requestId": "36014eed-4772-4c48-a9e2-e532762b6a85",
"client": "demo",
"id": {
"tntId": "abcdefghijkl00023.28_20"
},
"edgeHost": "mboxedge28.tt.omtrdc.net",
"notifications": [
{
"id": "SummerOfferNotification"
},
{
"id": "SummerDressOfferNotification"
},
{
"id": "SummerShoesOfferNotification"
}
]
}
If all the notifications sent to Target are correctly processed, they will appear in the notifications array in the response. However, if a notifications id is missing, that particular notification did not go through. In this scenario, a retry logic could be put into place until a successful notification response is retrieved. Ensure the retry logic has a timeout specified so the API call does not block and cause performance delays.
Notifications for Prefetched Views
One or multiple notifications can be sent via a single delivery call. Determine whether the metric that needs to be tracked is either a click or display for each mbox so that the type of the notification can be reflected correctly. Also, pass in an id for each notification so that one can determine whether a notification was sent correctly thru the Adobe Target Delivery API. The timestamp is also important to be forwarded to Target to indicate when the click or display occurred for a given view for reporting purposes.
curl -X POST \
'https://demo.tt.omtrdc.net/rest/v1/delivery?client=demo&sessionId=d359570e04f14e1faeeba02d6ab9914e' \
-H 'Content-Type: application/json' \
-H 'cache-control: no-cache' \
-d '{
"id": {
"tntId": "84e8d0e211054f18af365d65f45e902b.28_131"
},
"context": {
"channel": "web",
"browser": {
"host": "target.enablementadobe.com"
},
"address": {
"url": "https://target.enablementadobe.com/react/demo/#/"
}
},
"notifications": [{
"id": "228",
"type": "display",
"timestamp": 1556226121884,
"tokens": ["N3C13I0M2PH8iaKtONJlFJNWHtnQtQrJfmRrQugEa2qCnQ9Y9OaLL2gsdrWQTvE54PwSz67rmXWmSnkXpSSS2Q=="],
"view": {
"name": "checkout-express",
}
},
{
"id": "5",
"type": "display",
"timestamp": 1556226121884,
"tokens": ["N3C13I0M2PH8iaKtONJlFJNWHtnQtQrJfmRrQugEa2qCnQ9Y9OaLL2gsdrWQTvE54PwSz67rmXWmSnkXpSSS2Q=="],
"view": {
"name": "home",
}
},
{
"id": "6",
"type": "display",
"timestamp": 1556226121884,
"tokens": ["N3C13I0M2PH8iaKtONJlFJNWHtnQtQrJfmRrQugEa2qCnQ9Y9OaLL2gsdrWQTvE54PwSz67rmXWmSnkXpSSS2Q=="],
"view": {
"name": "products",
}
}
]
}'
The example call above will result in a response that indicates the notifications request was successfully processed.
{
"status": 200,
"requestId": "85cc7394-c19a-4398-9b8b-bbee1e4c4579",
"client": "demo",
"id": {
"tntId": "84e8d0e211054f18af365d65f45e902b.28_131"
},
"edgeHost": "mboxedge28.tt.omtrdc.net",
"notifications": [
{
"id": "5"
},
{
"id": "6"
},
{
"id": "228"
}
]
}
If all the notifications sent to Target are correctly processed, they will appear in the notifications array in the response. However, if a notifications id is missing, that particular notification did not go through. In this scenario, a retry logic could be put into place until a successful notification response is retrieved. Ensure the retry logic has a timeout specified so the API call does not block and cause performance delays.