Spur Integration
In this article we will show you how to set up the Spur Integration on your Nector dashboard.
Visit the Integrations Page. Click on WhatsApp Marketing in the side-bar. Scroll below to look for Spur in that section.
Click on Configure to open up the Spur integration page.
First to enable the integration, you need to get the API key from Spur dashboard
Go to Spur dashboard
On the side-bar look for Settings and click on it.
Go to the API Docs page as shown below
Copy the API Token shown in the image above.
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 Spur.
The first step is to create a whatsapp template in Spur and then create the corresponding event in Nector dashboard.
Visit your Spur dashbord
Go to the Marketing Tools & select Message Templates click on any template to find the template name. See the below image for reference
Click on Create Template if you would like to create a brand new template
In the Body you can write your custom message and also add variables using the Add Variable button
Remember the template name and use it in the Nector dashboard while creating an event for Spur integration.
Go to the Spur 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 Spur 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 Spur will be selected.
Now while creating Events for Whatsapp messages, you will get two additional fields.
Spur Template Name - Here you will have to add a Template Name (which can be obtained from your Spur dashboard, as shown above for the associated event on this page.
Select the Nector properties to use in your Spur template - You need to mention the variables/properties that you are using in your whatsapp template. As per the example template that we created in the previous section, 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. The event will be created as below.
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 Spur in that section.
Click on Configure to open up the Spur integration page.
First to enable the integration, you need to get the API key from Spur dashboard
Getting your API key
Go to Spur dashboard
On the side-bar look for Settings and click on it.
Go to the API Docs page as shown below
Copy the API Token shown in the image above.
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 Spur.
The first step is to create a whatsapp template in Spur and then create the corresponding event in Nector dashboard.
Creating a Whatsapp Template in Spur dashboard
Visit your Spur dashbord
Go to the Marketing Tools & select Message Templates click on any template to find the template name. See the below image for reference
Click on Create Template if you would like to create a brand new template
In the Body you can write your custom message and also add variables using the Add Variable button
Remember the template name and use it in the Nector dashboard while creating an event for Spur integration.
Add New Event
Go to the Spur 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 Spur 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 Spur will be selected.
Now while creating Events for Whatsapp messages, you will get two additional fields.
Spur Template Name - Here you will have to add a Template Name (which can be obtained from your Spur dashboard, as shown above for the associated event on this page.
Select the Nector properties to use in your Spur template - You need to mention the variables/properties that you are using in your whatsapp template. As per the example template that we created in the previous section, 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. The event will be created as below.
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!