Skip to content
English - United Kingdom
Contact us
  • There are no suggestions because the search field is empty.

Magento Integration

Important:

  1. You need to install Mageplaza_Core module.
  2. We recommend you to duplicate your live store on a staging/test site and try installation on it in advance
  3. Backup magento files and the store database
  4. It's very important to backup all of themes and extensions in Magento before installation, especially when you are working on a live server. We strongly recommend you to do not omit this step.

 

Step 1: Install Mageplaza_Core

How to install & upgrade Mageplaza_Core

We recommend you to install Mageplaza_Core module via composer. It is easy to install, update and maintaince.

Run the following command in Magento 2 root folder:

Install

composer require mageplaza/module-core

php bin/magento setup:upgrade

php bin/magento setup:static-content:deploy

php

Upgrade

composer update mageplaza/module-core

php bin/magento setup:upgrade

php bin/magento setup:static-content:deploy

php

Copy and paste

If you don't want to install via composer, you can use this way.

  1. Download the latest version here. (This will trigger a zip file download)
  2. Extract master.zip file to app/code/Mageplaza/Core; You should create a folder path app/code/Mageplaza/Core if it doesn't exist.
  3. Go to Magento root folder and run upgrade command line to install Mageplaza_Core:

php bin/magento setup:upgrade

php bin/magento setup:static-content:deploy

php

Then...

  1. Install webhook extension with Composer

Mageplaza Webhook extension

IMPORTANT NOTE: The solution presented below is only applied for free extensions. Now, you can install Mageplaza paid extensions via composer too. To read the full instruction, please follow this guide: HOW TO INSTALL MAGENTO EXTENSIONS VIA COMPOSER.

  1. Run the following command in Magento 2 root folder:

composer require mageplaza/magento-2-blog-extension

php bin/magento setup:upgrade

php bin/magento setup:di:compile

php bin/magento setup:static-content:deploy

php

You may get this message:

Go to Access Keys page and Create A New Access Key.

Configuration

Login to the Magento Admin, choose Store > Settings > Configuration > Mageplaza Extensions > Webhook.

Name

Description

Enable

Choose “Yes” to enable this module or “No” to disable it.

Abandoned Cart After

Set the hours for Abandoned Cart. We recommend the period time as 1, 6, 1012,24.

Keep Logs

Enter the number of keep logs. It will auto-delete the logs if it reaches to thselected number and keeps the number of selected logs. It will make the logs clear everyday.

Alert on Error

Choose “Yes” to send the notification when sending an email. To avoid sending themail to the spambox, you should install SMTP extension.
   

 

Step 2: Schedule Cron job

Name

Description

Schedule For Cron

Select the time to synchronizely send data:it.

Disable

Will send the data right after the event occurs. For example: Create Hook with New order, after each new order, the data will be synchronized to the app. You can see the list that has been submitted at Logs.

Every Minute

Data will be synchronized every minute.

Daily

Data is synchronized every day.

Weekly

Data will be synchronized on Monday every week.

Monthly

Data will be synchronized every month on the first day of each month.

Start Time

Only show this field when selecting Daily/Weekly/Monthly.
   

 

Step 3: Manage Hook

Grid

From the Admin Panel, go to System > Webhook > Manage Hooks.

For Add New button, you can choose Trigger type to Create New Hook and activate the data to the server.

Create a Hook

From the Admin Panel, go to System > Webhook > Manage Hooks, choose Add New button in the right corner with some options as New Order, New Product, Update Product, Delete Product, etc

 

Step 4: General

Name

Description

Name

Enter the name of the Hook. This name will display when sending the email to customers.

Status

Choose “Enable” to use Hook.

Store View

Choose Store View so that Hook is displayed. With unselected Store View, Hook will not appear.

Priority

Only show this field when selecting Daily/Weekly/Monthly. The smaller the Hook priority, the higher its priority. O is the highest priority.
   

 

Step 5: Actions

Name

Description

Payload URL

https://staging-api.onetribeglobal.com/direct/webhook/magento/order/bOpxVgsXVmsaBdpvadvHMCx

Method

Choose POST.

Authentication

Leave unselected.

Content Type

Choose application/json. Body variables as JSON. Body: With the Method as POST you need to add the content into Content field to send a request. Click Insert Variable to choose the variable.
   

You then need to add the following variables to the Content field:

  • Time/Date
  • Order ID
  • Order Value before shipping
  • Products ID
  • Product Name
  • Product Category
  • Currency

 

Step 6: Logs

Here saved the change logs of the synchronization process of each Hook.

Name, Status, Entity, Message, etc. When you click on any file, it will auto-open that file.

View Log

Click View, it will redirect the email receiver to the Logs page in order to view the detailed logs. Here you can check if the webhook is performing as expected.

When you have added your Webhook please confirm it works by clicking 'Check Integration' below:

Update Integration