Setting up the Web Push Channel List

Web Push apps that work with Responsys are associated with a Web Push Channel List. The list:

  • Contains a list of all your Website Visitor profiles

  • Includes a relationship to your contact list for known user matching

  • Facilitates targeting of both “known” and “unknown” users all within a single program

  • Enables marketers to message users across channels

About the Match Key

Responsys uses the USER_IDENTIFIER_ parameter as the match key to uniquely identify "known users" of your website to associate the website visitor to a known profile record in the Web Push Channel List. This helps with such Responsys tasks as enabling filtering by known user, user login status, and personalization.

How the match key is chosen

Coordinate with the Marketing team regarding which field to use. Only one field may be used as the match key across your app users, and it cannot be changed later.

Setting a match key requires coordination between the Marketer and the Web Push App Developer.

A Marketer should be able to decide the best field for the match key. He or she should relay that back to the Web Push App Developer so they set the right value for match key from within the website code. Within the website code, this field is referred to as USER_IDENTIFIER_.

When the Account Admin creates the Web Push Channel List to receive the app data, the admin should set one of the following to be the match key:

  • CUSTOMER_ID_

  • EMAIL_ADDRESS_

  • MOBILE_NUMBER_

An image of match key options

We recommend choosing the dominant identifier in the Contacts Profile List, to maximize the conversion of unknown devices to known users. The project team should also consider data security. For example, Customer ID is more secure than an email address.

NOTES:

Please use caution when choosing a match key. It cannot be reset to another value once set. For example, you cannot choose to change the match key to CUSTOMER_ID_ after you have set it to EMAIL_ADDRESS_.

We do not recommend choosing EMAIL_SHA256_HASH_ or EMAIL_MD5_HASH_ as the match key for the user identifier. Doing so can cause confusion when an Web Push Channel List record is created and a Profile List record does not currently exist for the email address. MD5/SHA are one-way keys. Therefore, the system will be unable to use the incoming USER_IDENTIFIER value to populate the EMAIL_ADDRESS_ field in a new Profile List record. (Merging with existing Profile List records is unaffected.) Not having a plain-text email address in a Profile List record is a problem, because Responsys users typically search for Profile List records by plain-text email address. Being unable to locate a record may cause confusion. For more details, see the FAQ item Should I use SHA256 or MD5HASH as the match key.

Setting up the Web Push Channel List

Before you begin

A Marketer or an Account Admin should consider the following before setting up the Web Push Channel List:

  1. Verify the Contact Profile List. We recommend using the same list that is used to send Email and/or SMS campaigns. This enables the Marketer to include the Web Push messaging formats in their multi-channel campaign.

  2. Ensure the match key is known by both the Marketing team and Web Developer so they set the right value for match key from within the website code.

  3. Verify the Web Push App exists - Before Step 2, ensure that the Web Push app is set up in Responsys. Responsys Account Admins do this by logging onto the App Developer Console and verifying the web app that you are trying to set up is available on the Manage Apps page.

  4. Ensure your Account is enabled for Web Push Channel Lists. This can be done using the following steps:

    1. Log in to Responsys.

    2. From the navigation menu, select Data > Manage Lists.

    3. Select one of your Profile Lists.

    4. Under the List Information section, you should see an option called Create Web Push Channel List, as shown below.

      Note: If you do not see this option, please create a support ticket to enable the Web Push Channel for your account.

      An image of Enabling the Web Push Channel for your account

Step 1 - Create the Web Push Channel List

  1. Log in to Responsys.

  2. From the navigation menu, select Data > Manage Lists.

    An image of Finding Manage Lists in the navigation menu

  3. Select the Profile List. We recommend using the same list that your account uses to send Email and/or SMS campaigns. This enables the Marketers to include the Web Push messaging formats in their multi-channel campaigns.

  4. Under the List Information section, click Create Web Push Channel List.

    An image of Responsys Manage Lists Page

  5. Enter a name for the Web Push Channel List. By default, this is set to a concatenated string of your Profile List name and the literal “_WEBPUSH”.

    An image of Entering a name for the Web Push Channel Lis

  6. Select a Folder Name. By default, the folder is set to the same folder as your Profile List.

  7. The third field, with the label Map user identifier of the Web Push Channel recipient to: is the match key. As discussed in Item #2 in the “Before you begin” section above, select the match key that corresponds to the user identifier used in the web app code:

    • EMAIL_ADDRESS_

    • MOBILE_NUMBER_

    • CUSTOMER_ID_

    • EMAIL_SHA256_HASH_

    • EMAIL_MD5_HASH_

  8. Click Save.

Step 2 - Associate the Web Push Channel List to your app

  1. From the navigation menu, select Account.

  2. On the Account Management page, locate the Campaign Management section, and then select Manage Web Push App Configurations.

  3. On the Manage Mobile App Configurations page, select the App Name of the Web Push app you want to configure.

  4. Click on the “+” button to display the detailed view of the app.

  5. Click Edit Profile List. This should open up a dialog that displays the Profile List and the Web Push Channel List. Select the Profile List, and the corresponding Web Push Channel List will be automatically displayed.

    An image of editing profile list

  6. Select the Web Push Channel List to associate to your Web Push app.

  7. Click Save.

Web Push Channel List standard fields

To see a list of the system-defined list fields for the Web Push Channel List, refer to the Oracle Responsys Help Center.