Zoko Integration
In this article we will show you how to set up the Zoko Integration on your Nector dashboard.
Visit the Integrations Page. Under WhatsApp Marketing inside the Integrations page, look for Zoko.
Click on Configure to open up the Zoko integration page.
First to enable the integration, you need to get the API key from Zoko dashboard
Login to your Zoko dashboard
From the left side menu, Dev Tools section, click on API keys
You will find API key on this page. See the below image for reference.
Copy the API Key
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 Zoko.
The first step is to get the whatsapp template id in Zoko and then create the corresponding event in Nector dashboard.
Visit your Zoko dashboard
From the top menu, click on Apps.
And open the Templates app
Click on the template that you would like to use, and you will find the template id. See below image for reference.
Remember the template id and use it in the Nector dashboard while creating an event for Zoko integration.
Go to the Zoko 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 Zoko 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 Zoko will be selected.
Now while creating Events for Whatsapp messages, you will get two additional fields.
Zoko Template Id - Here you will have to add a Template Id (which can be obtained from your Zoko dashboard, as shown above for the associated event on this page.
Select the Nector properties to use in your Zoko template in the exact order - You need to mention the variables/properties you have used normally following properties are used, 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. Under WhatsApp Marketing inside the Integrations page, look for Zoko.
Click on Configure to open up the Zoko integration page.
First to enable the integration, you need to get the API key from Zoko dashboard
Getting your API key
Login to your Zoko dashboard
From the left side menu, Dev Tools section, click on API keys
You will find API key on this page. See the below image for reference.
Copy the API Key
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 Zoko.
The first step is to get the whatsapp template id in Zoko and then create the corresponding event in Nector dashboard.
How to get the template id from Zoko dashboard
Visit your Zoko dashboard
From the top menu, click on Apps.
And open the Templates app
Click on the template that you would like to use, and you will find the template id. See below image for reference.
Remember the template id and use it in the Nector dashboard while creating an event for Zoko integration.
Add New Event
Go to the Zoko 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 Zoko 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 Zoko will be selected.
Now while creating Events for Whatsapp messages, you will get two additional fields.
Zoko Template Id - Here you will have to add a Template Id (which can be obtained from your Zoko dashboard, as shown above for the associated event on this page.
Select the Nector properties to use in your Zoko template in the exact order - You need to mention the variables/properties you have used normally following properties are used, 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: 17/05/2024
Thank you!