Skip to main content
All CollectionsEcommerce IntegrationMiva
BayEngage & MIVA Integration
BayEngage & MIVA Integration
Danielle From BayEngage avatar
Written by Danielle From BayEngage
Updated over a year ago

If you would like to integrate BayEngage with your Miva Store, please follow along. Let me walk you through the steps one by one.

But before we begin with the integration, make sure you have the ‘BayEngage for Miva’ Module ready beforehand. You can get it by contacting the BayEngage team (support@targetbay.com). If you have it already, lets continue.

  • To start with, keep your Miva store logged in.

  • You would need to go to your Settings -> User Management

  • Head to the Users page -> Groups tab and click on Add Group

  • Give your group a name. Something like BayEngage will do. (Just for your identification) Also add a description before you click Save.

  • Check the box against the newly created group and click on Privileges then set the privileges for the BayEngage app. (BayEngage will need view privileges to work seamlessly. So please toggle ON View privileges in every row)

  • Now close privileges and uncheck the group to see the API tokens option. Click on it and press the Add API token button.

  • You will be asked to provide a Name for the token. (again, something like BayEngage should be fine)

  • Type in 0.0.0.0/0 for Allowed IP Address.

  • You will also need to ensure that the Signature and Timestamp are both set to Required.

  • Before you leave, copy the Endpoint URL, Access Token and the Signature (Generate a new signature and then copy) and keep them handy. You will need it later. Now click on Save.

  • On the security warning prompt, click on Yes

  • To add the token that we just created to a group, you will need to select the check box and click on Groups

  • Find the group that we created earlier and Toggle ON in the assigned column to assign the token. Now click Close.

  • Now we will again need to go to Settings -> Domain Settings -> Modules and Click on Add Module.

  • Click on Upload to choose the module from your system.

  • Select the BayEngage for Miva Module provided to you by the BayEngage team earlier and click on Upload. Finally click on Add to add the module.

  • To finish the installation process, head over to Settings -> Modules

  • Find the BayEngage module and click on Install.

  • You will now be redirected to Settings -> Order fulfillment settings -> BayEngage. Leave that page for now. (we will come back to this page later.

  • Now, on a seperate tab, go to https://app.bayengage.com/signup/ and create a new BayEngage account.

  • On the Connect Store page, select MIVA and provide the required values for the respective fields then click Continue

    • You can find the above values from,

      • Website Address: Settings -> Domain Settings -> Site configuration

      • Store Code: Settings -> Store Details

    • Incase you have misplaced the Following,

      • API URL: Settings -> User Management -> API Tokens -> Endpoint URL

      • Access Token: Settings -> User Management -> API Tokens -> Access Token

      • Signing Key: Settings -> User Management -> API Tokens -> Signature

    • Now, head over to Settings -> Account Settings in your BayEngage account. Find and copy the API Key.

  • Head back to your Miva store and go to Settings -> Order fulfillment settings.

  • Paste the API key in the input and hit Save.

  • On the left navigation, find User Interface and navigate to that page.

  • Head to User Interfaces -> CSS/JavaScript Resources and click on JavaScript Resource tab.

  • Following that, Click on the Add JavaScript Resource button

  • On doing so, a new row will be added to the end of the list. Provide your JavaScript resource a new Code as 'bayengage' and choose 'External File' for Type.

  • For the File Path, enter ' https://sf.bayengage.com/sf.js?t=<API_KEY> ' by replacing <API_KEY> with the API Key that you recently copied from your BayEngage Account (Settings -> Account Settings) and hit Save Changes. (Make sure the Global and Active options are Toggled On). Click on 'Save Changes'

  • To finish, select the newly added JavaScript Resource by checking the box and clicking on the three dots for more menu. Choose Resource Group from the dropdown and Toggle On the head_tag.

  • Annnnd we are officially Done. Phew! Great Job!

Note:

Data sync: BayEngage makes webhooks calls to your store in the following events.

  1. BayEngage syncs your customer data whenever

    1. A new customer is created

    2. Customer data is edited

    3. A customer is deleted

  2. BayEngage syncs your order data whenever

    1. A new order is created

    2. Order data is edited

    3. An order is deleted

  3. BayEngage syncs your product data whenever

    1. A new product is created

    2. Product data is edited

    3. A product is deleted

  4. BayEngage syncs your category data whenever

    1. A new category is created

    2. Category data is edited

    3. A category is deleted

  5. BayEngage syncs your cart data whenever

    1. A new cart is created

    2. Cart data is edited

    3. A cart is deleted

Did this answer your question?