WebEngage Integration
In this article we will show you how to set up the WebEngage Integration on your Nector dashboard.
Visit the Integrations Page. Under Email & WhatsApp Marketing inside the Integrations page, look for WebEngage.
Click on Configure to open up the WebEngage integration page.
First to enable the integration, you need to get the license code, private API key and server prefix from your WebEngage dashboard.
Login to your WebEngage dashboard.
From the left side menu, go to Data Platform Integrations
Scroll down to find the REST API section, and click on View. See below image for reference
You will find your license code and API key on this page.
Copy the details on to your Nector dashboard
Open your WebEngage dashboard. If your WebEngage dashboard URL starts with dashboard.webengage.com, then it means you're using our Global Data Center. Select "api" as the server prefix.
If your WebEngage dashboard URL starts with dashboard.in.webengage.com, then it means you're using our India Data Center. Select "api.in" as the server prefix.
After that Under Choose Common property, select Email as the mode of communication
Choose Common Property - This refers to the user property of Nector which will be used when sending the event.
Finally, click on Initialize button to button to enable the integration. Once it is enabled, you will see the below view.
Events can be sent to WebEngage when certain things happen on Nector. You can then setup automations on WebEngage, which can be triggered when the event occurs on Nector. For example, when a customer is rewarded with wallet coins, an event can be sent to WebEngage, which in turn will trigger an automation that sends an email to the customer.
Switch to the Events tab and click on Create An Event. It opens up to the Events page with the Send Events tab. Now you have to select the event on which you want to notify the external integration.
There are many events supported on Nector. If you don't know which to choose, here are the two events that are most relevant and commonly used:
Wallet Coins Rewarded: This event will be sent whenever wallet coins are rewarded on nector.
Coupon Is Created: This event will be sent whenever a customer uses his wallet coins to get a discount/coupon code on nector.
For example,
To send an Wallet Reward Event to WebEngage whenever wallet coins are rewarded to a customer on nector, you would create the event as shown below.
Click on "+" button to create an event.
For "Event" option, select Wallet Coins Rewarded
For "Send event to" option, by default WebEngage will be selected.
Once you have entered all the details, click on the Create button in the popup. The event will be created as below.
In order to make this event available in your WebEngage dashboard, you need to send a test event from Nector as shown below. After this, you can setup the flow on WebEngage using this event as the trigger.
Click on the Event you just created
You can send a test event by clicking on Send Test Event.
A popup opens, enter the email id where you want to send the test email.
Kindly note, the Email id of customer to whom email has to be sent needs to exist in the Customers database of your store.
After you are done setting up events to be sent to WebEngage from Nector, you can create jounreys on WebEngage in response to the Events. For this, read the steps below:
Go to your Webengage dashboard. Look for Journeys and click on it.
Click on "+" to create a new Journey. Drag and Drop the Occurence of an Event into the flow.
Click on When user does an event. In this example since we have created an event for wallet reward, we will be choosing the "walletreward_create" trigger from the options.
Inorder to make the trigger available in your WebEngage dashboard, a sample event needs to be sent from nector. This sample event can be sent to WebEngage simply by adding some coins to an account on Nector. To reward coins manually refer to this article Manually reward coins to customers
If you would like to create Flows for a separate event, kindly contact the Nector team, by referring here
Click on Save. Drag and Drop the Send Email into the flow.
Click on Send Email and then fill up the email as necessary for your message. You can also add custom keywords in the message by clicking on the profile image and adding variables. Refer to the second example.
Finally click on Save & Continue. In the main page click on PUBLISH NOW.
Your journey will be successfully set as Live.
Events can also be sent for other things like when a new customer is referred, for coin expiry notification, for review request, and more. To learn how to setup these events, look into those respective articles.
For a list of events and the data associated with each event, please refer this article for more info: https://nector.crisp.help/en/article/event-details-sent-to-external-integrations
Events
Event details sent to External Integrations
Setting up the Integration
Visit the Integrations Page. Under Email & WhatsApp Marketing inside the Integrations page, look for WebEngage.
Click on Configure to open up the WebEngage integration page.
First to enable the integration, you need to get the license code, private API key and server prefix from your WebEngage dashboard.
Getting your license code and API key
Login to your WebEngage dashboard.
From the left side menu, go to Data Platform Integrations
Scroll down to find the REST API section, and click on View. See below image for reference
You will find your license code and API key on this page.
Copy the details on to your Nector dashboard
Getting your server prefix
Open your WebEngage dashboard. If your WebEngage dashboard URL starts with dashboard.webengage.com, then it means you're using our Global Data Center. Select "api" as the server prefix.
If your WebEngage dashboard URL starts with dashboard.in.webengage.com, then it means you're using our India Data Center. Select "api.in" as the server prefix.
After that Under Choose Common property, select Email as the mode of communication
Choose Common Property - This refers to the user property of Nector which will be used when sending the event.
Finally, click on Initialize button to button to enable the integration. Once it is enabled, you will see the below view.
Sending Events To WebEngage
Events can be sent to WebEngage when certain things happen on Nector. You can then setup automations on WebEngage, which can be triggered when the event occurs on Nector. For example, when a customer is rewarded with wallet coins, an event can be sent to WebEngage, which in turn will trigger an automation that sends an email to the customer.
Add new event
Switch to the Events tab and click on Create An Event. It opens up to the Events page with the Send Events tab. Now you have to select the event on which you want to notify the external integration.
There are many events supported on Nector. If you don't know which to choose, here are the two events that are most relevant and commonly used:
Wallet Coins Rewarded: This event will be sent whenever wallet coins are rewarded on nector.
Coupon Is Created: This event will be sent whenever a customer uses his wallet coins to get a discount/coupon code on nector.
For example,
To send an Wallet Reward Event to WebEngage whenever wallet coins are rewarded to a customer on nector, you would create the event as shown below.
Click on "+" button to create an event.
For "Event" option, select Wallet Coins Rewarded
For "Send event to" option, by default WebEngage will be selected.
Once you have entered all the details, click on the Create button in the popup. The event will be created as below.
Sending Test Event
In order to make this event available in your WebEngage dashboard, you need to send a test event from Nector as shown below. After this, you can setup the flow on WebEngage using this event as the trigger.
Click on the Event you just created
You can send a test event by clicking on Send Test Event.
A popup opens, enter the email id where you want to send the test email.
Kindly note, the Email id of customer to whom email has to be sent needs to exist in the Customers database of your store.
Setting up the journeys on WebEngage
After you are done setting up events to be sent to WebEngage from Nector, you can create jounreys on WebEngage in response to the Events. For this, read the steps below:
Go to your Webengage dashboard. Look for Journeys and click on it.
Click on "+" to create a new Journey. Drag and Drop the Occurence of an Event into the flow.
Click on When user does an event. In this example since we have created an event for wallet reward, we will be choosing the "walletreward_create" trigger from the options.
Inorder to make the trigger available in your WebEngage dashboard, a sample event needs to be sent from nector. This sample event can be sent to WebEngage simply by adding some coins to an account on Nector. To reward coins manually refer to this article Manually reward coins to customers
If you would like to create Flows for a separate event, kindly contact the Nector team, by referring here
Click on Save. Drag and Drop the Send Email into the flow.
Click on Send Email and then fill up the email as necessary for your message. You can also add custom keywords in the message by clicking on the profile image and adding variables. Refer to the second example.
Finally click on Save & Continue. In the main page click on PUBLISH NOW.
Your journey will be successfully set as Live.
Events can also be sent for other things like when a new customer is referred, for coin expiry notification, for review request, and more. To learn how to setup these events, look into those respective articles.
For a list of events and the data associated with each event, please refer this article for more info: https://nector.crisp.help/en/article/event-details-sent-to-external-integrations
Related Articles
Events
Event details sent to External Integrations
Updated on: 14/05/2024
Thank you!