Event callbacks (Preferences)

Sourcepoint provides callbacks that you can define within the Preferences messaging code. Please refer to the tables below for more information.

• Optional callbacks
• Example

Optional callbacks

The following callbacks can be utilized by your organization to include custom code to be executed in response to keys events in the Preferences messaging flow (e.g. the end-user clicks the cancel button in your Preferences message). A description of the event callback and data returned is described below.

• onMessageReady
• onPrefCancel
• onMessageReceiveData
• onSPReady
• onError

onMessageReady

Event callback fires when a message is about to display. This callback returns the message_type:

onMessageReady: function (message_type) {
   console.log('message_type: ' + message_type)
}

onPrefCancel

Event callback fires when a user clicks the Preferences message's cancel button. This callback returns the message_type:

onPrefCancel: function (message_type) {
   console.log('message_type: ' + message_type)
}

onMessageReceiveData

This event will always fire and sends data about the message and campaign to the callback.

The callback data returns the following information:

data object

onMessageReceiveData: function (message_type, data) {
   console.log('message_type' + message_type);
   console.log('prtnUUID: ' + data.prtnUUID);
   console.log('messageId: ' + data.messageId);
   console.log('messageDescription: ' + data.messageDescription);
   console.log('bucket: ' + data.bucket);
   console.log('categoryId: ' + data.categoryId);
   console.log('subCategoryId: ' + data.subCategoryId);
   console.log(JSON.stringify(data));
}

onSPReady

Event callback fires when the Preferences message is ready to be displayed on the page.

onSPReady: function () {
   console.log('onSPReady')
}

onError

Event callback fires when an error occurs. This callback function returns message_type, errorCode and errorObject:

onError: function (message_type, errorCode, errorObject, userReset){
   console.log('message_type: ' + message_type);
   console.log('errorCode: ' + errorCode);
   console.log(errorObject);
   console.log('userReset: ' + userReset);
}

The list of error codes passed that can be passed to the onError callback are:

Example

...
<script>
    window._sp_queue = [];
    window._sp_ = {
        config: {
            accountId: ACCOUNT_ID,
            baseEndpoint: 'https://cdn.privacy-mgmt.com',
            preferences: { 
                id: 'test@demo.com'
            },
            propertyHref: 'https://yourexamplehere.com',
            events: {
                onMessageReady: function (message_type) {
                    console.log('message_type: ' + message_type)
                 },
                onPrefCancel: function (message_type) {
                    console.log('message_type: ' + message_type)
                 },
                onMessageReceiveData: function (message_type, data) {
                    console.log('message_type' + message_type);
                    console.log('prtnUUID: ' + data.prtnUUID);
                    console.log('messageId: ' + data.messageId);
                    console.log('messageDescription: ' + data.messageDescription);
                    console.log('bucket: ' + data.bucket);
                    console.log('categoryId: ' + data.categoryId);
                    console.log('subCategoryId: ' + data.subCategoryId);
                    console.log(JSON.stringify(data));
                 },
                onSPReady: function () {
                    console.log('onSPReady')
                 },
                onError: function (message_type, errorCode, errorObject, userReset){
                    console.log('message_type: ' + message_type);
                    console.log('errorCode: ' + errorCode);
                    console.log(errorObject);
                    console.log('userReset: ' + userReset);
                 }, 
          }
      }
  }
</script>
...