What is External Lexpad and how do I use it? MAX

Using External Lexpad

MAX customers can leverage a tool called External Lexpad, which, when combined with automation events, allows for the creation of custom scenarios that are not achievable with standard tools. This tool is particularly useful for customers who do not use any of the common e-commerce platforms we integrate with, or for those who need to create workflows and messages beyond the capabilities of these integrations. Examples of scenarios built by our customers using External Lexpad include:

• A company in the hospitality industry sending messages for abandoned hotel reservations.
• A gaming company sending available point balance to users in their rewards program.
• A travel company sending vouchers based on user location.
• A real estate company sending offers based on user location.

Important Considerations

• Developer Requirement: You will need a developer familiar with API and JSON. While our Customer Solutions Architects can assist with the process, technical expertise is required on the customer’s side.
• Responsibilities: Customer Solution Architects assist with setting up the flow, testing the message, checking the endpoint, retrieving information, combining necessary data in the database, and structuring the JSON if needed. However, they are not responsible for the final content and outcome of the message. Clients should thoroughly test workflows before launching.

Endpoint Requirements

External Lexpad needs an endpoint that meets the following criteria:

• The WebService must respond within 4 seconds.
• The response size cannot exceed 32KB.
• Lexpad must be in JSON format using the UTF-8 character set.
• The top-level structure must be a JSON object. Arrays or bare values are not allowed.
• The endpoint must be accessible by the IPs listed here: IP Ranges.

We need to be provided with the endpoint details to establish the connection. Additionally, you must inform us about every message you want to connect.

Message Guidelines

The message should be an automation message, as the process of adding the External Lexpad is manual. Some exceptions can be made for newsletters. However, please notify us at least 24 hours before the message is scheduled to be sent. Documentation on the syntax for dynamic content used in External Lexpad is available here: External Lexpad Documentation.

Automation Workflow

There are no specific rules for the workflow as long as the message is sent using one. The only limitation is that a message cannot use both External Lexpad and variables from events or e-commerce elements simultaneously, as those use the internal Lexpad. Below is an example of a possible workflow:

Lexpad Assistance

• Please provide a message or a message template with placeholders for the External Lexpad values. If placeholders are not clear, provide detailed instructions on where each value should be mapped.
• Provide the endpoint details that should be connected to the message.
• If limiting IP addresses accessing the endpoint, provide a sample JSON response as a text file. This helps Customer Solutions Architects set up and test the dynamic content.
• We will add a test email address to a list in your account and your JSON response should be sent for this address.
• If the Lexpad returns a list of items (e.g., offers), the sample response should contain multiple values to ensure proper rendering.
• If including images (e.g., thumbnails for offers), provide image links in the JSON response along with the desired dimensions.

Processing Time

Editing the message may take approximately 2 working days, depending on workload. Customer Solution Architects may ask questions or make suggestions during this process. While they strive to ensure the message functions correctly, customers should test the message to confirm it displays as expected before sending it to their contacts.