🆕Add an ESP
This document explains the procedure for adding an ESP on Lemnisk CDP on your own.
Lemnisk offers you the capability of adding an Email vendor API on your own on the platform, saving a good chunk of engineering effort and time that goes into the integration; enabling the marketer take campaigns live faster than ever. This capability also allows any marketer to set up a private ESP on the CDP.
This feature will help marketers configure the External API-led Email provider APIs by just providing the authorization keys, and mapping the designated Email fields to the payload.
Pre-requisites
The vendor's API that works with -
HTTP POST.
JSON payload.
The authentication mechanism and credentials that is a static key and not a refresh key.
Configuration Steps
To set up an Email API, it is mandatory to map atleast 3 configuration values: “To”, “Subject” and "Sender Email". Subject and Sender Email is to be provided at engagement level.
Ensure you assign the authorisation keys and other essential global constants in the respective places in the API. Usually, these are configured in the URL parameters or header parameters.
To configure a field at engagement level, assign that key with "Custom Field" and then provide a static value or define it at engagement-level by entering the variable name in curly braces like {{Custom Value}}.
A default value is not mandatory, but recommended when the value does not change frequently. This value will be displayed again those parameters when creating engagements. You can also assign a Macro value to fields by type.
Setup new Email client
Step 1: Go to > Campaigns > Channels > Email
Step 2: Click on the "+" Icon in the top row of the window.
Step 3: Select "+ Add Client" from the list of clients.
Step 4: Enter your client name in the given input box.(Ensure you put the business name of the vendor. This is for the sanity of the records)
Step 5: Name your configuration in the given input box.
Configure your Email client
Step 1: Basic details
Name of configuration: The name you entered in the previous step will be displayed here
Description: Add a description for your the new Email client.
Step 2: API Details
You can set up the Vendor API in the same way as you set up an External API with a global payload.
HTTP Method: Select the HTTP method as POST or GET.
API URL: Provide the API URL.
Alternatively, You can simply import the cURL of the API and skip to the next step! Let's understand how "Detect from cURL" works.
Clicking the +detect from URL button will pop up the following window.
Once you enter the curl, it will automatically fetches the Headers and Payload from the API and populate in the relevant fields and the tree-view will occur based on the values in the payload.
Step 3: Map API Keys to Email Fields
Now, select the Email Configuration fields and map the mandatory values To* and Message Body* to the appropriate keys in the API Body.
Custom Field: You can add custom values to the Configuration by assigning variables in curly braces {{Example}}.
Send Test Email
Navigate to > Test API.
Assign working values like Email Body, Subject, Recipient Email to the payload wherever applicable and click "test".
You will receive the success confirmation as shown below once your API is validated.
This is the same functionality we implemented in External API. Click here to know in detail.
Response and Webhooks
The response and Webhooks screen is where you will map the relevant path of the unique ID in the response body to the internal MessageID identifier which helps Lemnisk identify every message trigger and account for the delivery reports.
Navigate to > Response and Webhooks.
Enter values to the payload and Click " Test Configuration".
You will receive the confirmation once your API is validated.
Select the mapping key to map the Unique message ID.
Click on Save Configuration to successfully save the message_ID path of the response.
Congratulations! You've successfully added the Email provider's API in the system and you can now create engagements to start your Email campaigns.
Last updated