Gupshup Integration
In this article we will show you how to set up the Gupshup Integration on your Nector dashboard.
Visit the Integrations Page. Click on WhatsApp Marketing in the side-bar. Scroll below to look for Gupshup in that section.
Click on Configure to open up the Gupshup integration page.
First to enable the integration, you need to get the API key & the source mobile number from your Gupshup dashboard.
Login to your gupshup dashboard.
Click on your account name in the top right corner.
You will find the API Key there. See the below image for reference.
Copy the API key on to the nector dashboard
Under Source Number, enter the whatsapp mobile number from which messages will be sent. Enter the number along with the country code. Example: an indian mobile number will be 91XXXXXXXXXX
Paste this in the API Key field in Nector dashboard. Under Choose Common property, select Mobile 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.
Whatsapp messages can be sent to customers for various events that occur on Nector. For example: When a customer is rewarded with some wallet coins, you can send a whatsapp message via Gupshup.
The first step is to create a whatsapp template in Gupshup and then create the corresponding event in Nector dashboard.
Go to your gupshup dashboard.
Click on the Whatsapp link in the header to open your Whatsapp dashboard.
Select the app you have created. See the below image for reference
Click on the Templates tab.
And copy the name of the template which is in blue color. See the below image for reference.
Remember the template name and use it in the Nector dashboard while creating an event for Gupshup integration.
Go to the Gupshup Integration Page.
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 Gupshup 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 Gupshup will be selected.
Now while creating Events for Whatsapp messages, you will get two additional fields.
Gupshup Template Name - Here you will have to add a Template Name (which can be obtained from your Gupshup dashboard, as shown above for the associated event on this page.
Select the Nector properties to use in your Gupshup template in the exact order - You need to mention the variables/properties that you are using in your whatsapp template. Usually the following properties need to be selected, in the same order it is used in the template:
user_name : this refers to the name of the customer
amount : this refers to the number of wallet coins rewarded
So, your Template Settings would look something like this:
Once you have entered all the details, click on the Create button in the popup.
It is useful to send a test event as in the case of whatsapp, you can check if the whatsapp messages are being sent properly to the customer.
Click on the Event you just created
You can send a test event by clicking on Send Test Event.
A popup opens, enter the mobile number where you want to send the test message.
Kindly note, the Mobile number of customer to whom event has to be sent needs to exist in the Customers database of your store.
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. Click on WhatsApp Marketing in the side-bar. Scroll below to look for Gupshup in that section.
Click on Configure to open up the Gupshup integration page.
First to enable the integration, you need to get the API key & the source mobile number from your Gupshup dashboard.
Getting your API key & source mobile number
Login to your gupshup dashboard.
Click on your account name in the top right corner.
You will find the API Key there. See the below image for reference.
Copy the API key on to the nector dashboard
Under Source Number, enter the whatsapp mobile number from which messages will be sent. Enter the number along with the country code. Example: an indian mobile number will be 91XXXXXXXXXX
Paste this in the API Key field in Nector dashboard. Under Choose Common property, select Mobile 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 Whatsapp Messages
Whatsapp messages can be sent to customers for various events that occur on Nector. For example: When a customer is rewarded with some wallet coins, you can send a whatsapp message via Gupshup.
The first step is to create a whatsapp template in Gupshup and then create the corresponding event in Nector dashboard.
Creating a Whatsapp Template in Gupshup dashboard
Go to your gupshup dashboard.
Click on the Whatsapp link in the header to open your Whatsapp dashboard.
Select the app you have created. See the below image for reference
Click on the Templates tab.
And copy the name of the template which is in blue color. See the below image for reference.
Remember the template name and use it in the Nector dashboard while creating an event for Gupshup integration.
Add New Event
Go to the Gupshup Integration Page.
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 Gupshup 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 Gupshup will be selected.
Now while creating Events for Whatsapp messages, you will get two additional fields.
Gupshup Template Name - Here you will have to add a Template Name (which can be obtained from your Gupshup dashboard, as shown above for the associated event on this page.
Select the Nector properties to use in your Gupshup template in the exact order - You need to mention the variables/properties that you are using in your whatsapp template. Usually the following properties need to be selected, in the same order it is used in the template:
user_name : this refers to the name of the customer
amount : this refers to the number of wallet coins rewarded
So, your Template Settings would look something like this:
Once you have entered all the details, click on the Create button in the popup.
Sending Test Event
It is useful to send a test event as in the case of whatsapp, you can check if the whatsapp messages are being sent properly to the customer.
Click on the Event you just created
You can send a test event by clicking on Send Test Event.
A popup opens, enter the mobile number where you want to send the test message.
Kindly note, the Mobile number of customer to whom event has to be sent needs to exist in the Customers database of your store.
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: 21/05/2024
Thank you!