The JS API can be used to register callbacks to hook into the popup events. To register listener to a callback, use api.listen(callbackId, callbackFunction) function.
Email Given Callback
Whenever customer has input their email address into a Nosto behavioral pop-up that asked whether they want to subscribe to an email newsletter.
Whether the user gave their consent to subscribing to a newsletter. E.g. either the popup prompting for the email address input was worded similarly to “Please enter your email address to subscribe to our newsletter:” or there was an explicit checkbox that the user checked to give their consent.
Popup Opened Callback
1
api.listen("popupOpened",function(popupEvent){
2
if(popupEvent.error){
3
console.error(popupEvent.error);
4
}else{
5
console.log(popupEvent.campaignId);
6
console.log(popupEvent.type);
7
}
8
});
Copied!
Fields
Field
Type
Reason
campaignId
String
The identifier of the popup campaign
type
String
The trigger-type of the popup campaign
error
String
Description of the error in the case the pop-up failed to open.
Popup Ribbon Callback
The customer can minimize a Nosto behavioral pop-up into a ribbon to be shown at the edge of the viewport. The pop-up is also changed to be shown in its minimized ribbon form after a page load is done after a pop-up has been shown.
This callback will be called whenever the ribbon is rendered onto screen after a page load.
The customer can minimize a Nosto behavioral pop-up into a ribbon to be shown at the edge of the viewport. This callback will be called when the customer clicks the minimize button on the pop-up.
1
api.listen("popupMinimized",function(popupEvent){
2
console.log(popupEvent.campaignId);
3
});
Copied!
Fields
Field
Type
Reason
campaignId
String
The identifier of the popup campaign
Popup Maximised Callback
The customer can minimize a Nosto behavioral pop-up into a ribbon to be shown at the edge of the viewport. When they click on this ribbon, the pop-up will be maximized again to be shown in full size. This callback will be called when the customer clicks the ribbon to maximize the pop-up.
1
api.listen("popupMaximized",function(popupEvent){
2
console.log(popupEvent.campaignId);
3
});
Copied!
Fields
Field
Type
Reason
campaignId
String
The identifier of the popup campaign
Popup Closed Callback
The customer can click a “close permanently” button or link in a Nosto behavioral pop-up to dismiss the pop-up permanently. This callback is called when the customer clicks on that button or link.
1
api.listen("popupClosed",function(popupEvent){
2
console.log(popupEvent.campaignId);
3
});
Copied!
Fields
Field
Type
Reason
campaignId
String
The identifier of the popup campaign
Coupon Given Callback
The callback will be called when a customer clicks a button inside a Nosto behavioral pop-up to get their discount coupon code.
1
api.listen("couponGiven",function(couponEvent){
2
if(couponEvent.error){
3
console.error(couponEvent.error);
4
}else{
5
console.log(couponEvent.campaignId);
6
console.log(couponEvent.couponCode);
7
console.log(couponEvent.origin);
8
}
9
});
Copied!
Fields
Field
Type
Reason
campaignId
String
The identifier of the popup campaign.
couponCode
String
The trigger-type of the popup campaign.
origin
String
Where the coupon code originated from. Always popup.
error
String
Description of the error in the case the pop-up failed to open.
Cart Abandonment Callback
The callback will be called when a customer clicks a button inside a Nosto abandoned cart pop-up to get an abandoned cart email.