Introduction
MoEngage <> Inkit
Integration
library_add_check |
Prerequisites 1. Ensure you have access to your Inkit dashboard. 2. Ensure that you have the following details: Inkit API key - This key is found on your Inkit Dashboard will enable you to connect your Inkit account with MoEngage Inkit template ID - This key is found within the URL for each template, enabling you to send your template to MoEngage. For example, within the URL https://app.inkit.io/#/templates/design/bd9b0b8c-c47b-40ae-8787-80dd76f6d2bb, the Template ID is bd9b0b8c-c47b-40ae-8787-80dd76f6d2bb. Http header - Found on your Inkit account, you will combine this with your Inkit API Key to authorize the connection as a key-value pair within your MoEngage template. |
Step 1: Create an Inkit template
On the Inkit platform, create a template to be used in your MoEngage campaign. Select the Inkit API as documented here which you want to use - Send out Postcards or Letters
Step 2: Create connector campaign on MoEngage
To create a connector campaign on MoEngage,
1. Navigate to Create Campaign >> Connectors >> Custom
2. On step 2 of the campaign, select -
a) URL details
Key | Value |
---|---|
Method | POST |
Webhook URL |
https://internal.inkit.io/integrations/webhook |
b) Headers
Add the following two headers -
Key | Value |
---|---|
Authorization | Basic
|
Request Body | application/json |
c) Request Body
Ensure that your jinja matches the proper custom attributes associated with the required and optional fields listed below. You can use MoEngage's Tracked Standard or Localization attributes or use Tracked custom attributes to any request.
{
"api_token": "<INKIT_API_TOKEN>",
"template_id": "<INKIT_TEMPLATE_ID>",
"first_name": "{{UserAttribute['First Name']}}",
"last_name": "{{UserAttribute['Last Name']}}",
"email": "{{UserAttribute['Email']}}",
"company": "{{UserAttribute['Company Name']}}",
"phone": "{{UserAttribute['Phone Number']}}",
"address_line_1": "{{UserAttribute['Address Line 1']}}",
"address_line_2": "{{UserAttribute['Address Line 2']}}",
"address_city": "{{UserAttribute['City']}}",
"address_state": "{{UserAttribute['Address State']}}",
"address_zip": "{{UserAttribute['Address Zip']}}",
"address_country": "{{UserAttribute['Country']}}",
"source": "MoEngage"
}
Step 3: Test your configuration
At this point, your campaign should be ready to test and send. You can also test your connector configuration using the Test functionality available on Step 2 of Create Connector Campaign
Check the Inkit dashboard once you test the configuration or trigger the campaign. If your test is successful, your set-up is good to go. You can go ahead and Publish the campaign.