Skip to main content

Elevate integration and customerKey guidance

In Elevate, the customerKey is the unique identifier for a visitor on the website. A customerKey is required for every request to the Elevate API, whether for notifications or queries. To link a visitor in Elevate to an Engage contact, the customerKey should be stored in the discoveryKey contact attribute within Engage. This enables cross-platform understanding of the visitor and enhances personalization capabilities for both Elevate and Engage.

Visitor identification

The website is the first touchpoint for a visitor and plays a critical role in identifying the visitor and assigning the customerKey. When a visitor can be identified and linked to an existing customerKey, they can benefit from personalized content based on historical data. With customerKey/discoveryKey, historical sessions in Elevate can be linked to customer data in Engage.

Achieving a high identification rate on the website is key for effective personalization and relevance. Voyado highly recommends utilizing Engage's softId in newsletters. By using softId, all visitors from Engage newsletters can be identified when they visit the website. Links within the newsletter are decorated with an encrypted URL parameter. This parameter contains data that identifies the visitor and can be used to ensure the correct customerKey is set.

Key considerations

  • Ensure that Engage is updated with the discoveryKey for all members (visitors who have an account and can sign in to the website).

  • Ensure that discoveryKeys are unique for all members in Engage. Members with duplicate discoveryKeys will not benefit from personalization.

  • Ensure that Elevate is called with the existing customerKey when the visitor is identified.

Integration flow

New visitor

New_visitor-20250325-144047.png

Step

Action

The visitor enters

  • Generate a new customerKey

  • Save customerKey in a cookie

The visitor browses (e.g. category pages, product pages)

  • Read customerKey from cookie

  • Call Elevate API queries with customerKey

The visitor clicks (e.g. navigation links, add to cart, add favorite)

  • Read customerKey from cookie

  • Call Elevate API notifications with customerKey

The visitor signs up

  • Read customerKey from cookie

  • Create user account with customerKey

  • Call Engage API to create new contact with discoveryKey

  • Update user account with contactId from Engage

This should create a mapping between the user account, the Elevate customerKey, and the Engage contactId.

Returning visitor

Returning_visitor-20250325-144137.png

Step

Action

The visitor enters

  • Read customerKey from cookie

The visitor browses (e.g. category pages, product pages)

  • Read customerKey from cookie

  • Call Elevate API queries with customerKey

The visitor clicks (e.g. navigation links, add to cart, add favorite)

  • Read customerKey from cookie

  • Call Elevate API notifications with customerKey

The visitor signs in

  • Read customerKey from user account

  • Call Engage API to update contact with discoveryKey

  • Update cookie with customerKey

The visitor is identified, and the existing customerKey from the user account may differ from the customerKey in the cookie. Therefore, it is important to use the customerKey from the user account when calling the Engage API and to update the cookie accordingly.

Newsletter visitor

Newsletter_visitor-20250325-144011.png

Step

Action

The visitor enters

  • Decode softId and identify visitor

  • Read discoveryKey/customerKey from decoded softId or from the user account

  • Update cookie with customerKey

The visitor browses (e.g. category pages, product pages)

  • Read customerKey from cookie

  • Call Elevate API queries with customerKey

The visitor clicks (e.g. navigation links, add to cart, add favorite)

  • Read customerKey from cookie

  • Call Elevate API notifications with customerKey

The visitor signs in

  • Read customerKey from user account

  • Call Engage API to update contact with discoveryKey

  • Update cookie with customerKey