BusinessOnBot Integration
In this article we will show you how to set up the BusinessOnBot Integration on your Nector dashboard.
Visit the Integrations Page. Click on WhatsApp Marketing in the side-bar. Scroll below to look for BusinessOnBot in that section.
Click on Configure to open up the BusinessOnBot integration page.
First to enable the integration, you need to get the Platform from the BusinessOnBot dashboard
Go to your BusinessOnBot dashboard page and from the url extract the first name, for eg. if your dashboard url is https://abcdef.mybusinessonbot.com/ then the platform should be should be abcdef
Now paste it in your 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 BusinessOnBot.
The first step is to create a whatsapp template in BusinessOnBot and then create the corresponding event in Nector dashboard.
Visit your BusinessOnBot dashboard. Click on Settings in the side-bar, look for the Whatsapp Templates section and click on it.
Click on the Create Template button to create a new Template. A pop up opens choose Standard and click on Create button.
In the new page, under Category, choose Utility option and enter your desired template name in Name. Then click on the Continue button.
In this new page, enter the body of the text, you can also use Add variable to add variables in your text message, and then add Samples for those variables through Add Sample button. Optionally, you can also add header, footer and buttons in your text message
If you are adding a sample you will see a popup like this for entering the values of your variables. Enter the values and click on Done button.
Click on Save and Submit button. Your new template is visible on the list of Whatsapp templates.
Remember the template name and use it while creating an automation on BusinessOnBot integration.
Visit your BusinessOnBot dashboard. Click on Smart Automation in the side-bar.
In the new page, click on Create Automation at the top.
The configuration settings page for creating the Automation opens. Enter the Automation Name, Automation Description and under Choose Trigger Event select the Custom webhook option.
Scroll below if you want to enter any custom variables, make sure to enter the same variable names while configuring on the Nector dashboard. Click on Next button
In the next page, keep the time delay as it is but for Target Customers click on All Customers
Incase you want to send it to only selected set of customers click on, Custom Customers and enter the conditions based on which only the custom set of customers will be sent the message. Click on Next option to move to the next page.
In this page, under Select message type, choose Template option and under Select Template option, enter the template name that you had created here, enter the variables that you have set up to be used in your message on the same order.
Finally click on Deploy Automation button. Your Automation will be created as shown below.
Click on the grey hyperlink button to copy the URL of the automation as it will be required for creating events.
Go to the BusinessOnBot 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 BusinessOnBot whenever wallet coins are rewarded to a customer on Nector, you would create the event as shown below.
For "Nector event" option, select Wallet Coins Rewarded
For "Send event to" option, by default BusinessOnBot will be selected.
Now while creating Events for Whatsapp messages, you will get two additional fields.
BusinessOnBot Webhook URL - Here, you need to paste the URL that you copied of the automation that was created before.
Select the Nector properties to use in your BusinessOnBot 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:
amount : this refers to the number of wallet coins rewarded
user_balance : this refers to the total number of wallet coins that the customer has
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.
Smart automation on BusinessOnBot allows only one message to be sent to a customer in 24 hours.”
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 BusinessOnBot in that section.
Click on Configure to open up the BusinessOnBot integration page.
First to enable the integration, you need to get the Platform from the BusinessOnBot dashboard
Getting the Platform name
Go to your BusinessOnBot dashboard page and from the url extract the first name, for eg. if your dashboard url is https://abcdef.mybusinessonbot.com/ then the platform should be should be abcdef
Now paste it in your 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 BusinessOnBot.
The first step is to create a whatsapp template in BusinessOnBot and then create the corresponding event in Nector dashboard.
Creating a Whatsapp Template in BusinessOnBot dashboard
Visit your BusinessOnBot dashboard. Click on Settings in the side-bar, look for the Whatsapp Templates section and click on it.
Click on the Create Template button to create a new Template. A pop up opens choose Standard and click on Create button.
In the new page, under Category, choose Utility option and enter your desired template name in Name. Then click on the Continue button.
In this new page, enter the body of the text, you can also use Add variable to add variables in your text message, and then add Samples for those variables through Add Sample button. Optionally, you can also add header, footer and buttons in your text message
If you are adding a sample you will see a popup like this for entering the values of your variables. Enter the values and click on Done button.
Click on Save and Submit button. Your new template is visible on the list of Whatsapp templates.
Remember the template name and use it while creating an automation on BusinessOnBot integration.
Creating an Automation on BusinessOnBot dashboard
Visit your BusinessOnBot dashboard. Click on Smart Automation in the side-bar.
In the new page, click on Create Automation at the top.
The configuration settings page for creating the Automation opens. Enter the Automation Name, Automation Description and under Choose Trigger Event select the Custom webhook option.
Scroll below if you want to enter any custom variables, make sure to enter the same variable names while configuring on the Nector dashboard. Click on Next button
In the next page, keep the time delay as it is but for Target Customers click on All Customers
Incase you want to send it to only selected set of customers click on, Custom Customers and enter the conditions based on which only the custom set of customers will be sent the message. Click on Next option to move to the next page.
In this page, under Select message type, choose Template option and under Select Template option, enter the template name that you had created here, enter the variables that you have set up to be used in your message on the same order.
Finally click on Deploy Automation button. Your Automation will be created as shown below.
Click on the grey hyperlink button to copy the URL of the automation as it will be required for creating events.
Add New Event
Go to the BusinessOnBot 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 BusinessOnBot whenever wallet coins are rewarded to a customer on Nector, you would create the event as shown below.
For "Nector event" option, select Wallet Coins Rewarded
For "Send event to" option, by default BusinessOnBot will be selected.
Now while creating Events for Whatsapp messages, you will get two additional fields.
BusinessOnBot Webhook URL - Here, you need to paste the URL that you copied of the automation that was created before.
Select the Nector properties to use in your BusinessOnBot 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:
amount : this refers to the number of wallet coins rewarded
user_balance : this refers to the total number of wallet coins that the customer has
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.
Smart automation on BusinessOnBot allows only one message to be sent to a customer in 24 hours.”
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: 09/07/2024