parcellab/magento-2-webhook

Magento 2 Webhook Extension for parcelLab

2.4.23 2024-05-02 22:34 UTC

Requires

• liquid/liquid: ^1.4.42
• mageplaza/module-core: ^1.5.3

Conflicts

• mageplaza/module-webhook: >=0.0.1

MIT

• parcelLab
• Mageplaza

README

Please note: This extension is a fork of the excellent Magento 2 Webhook by Mageplaza published under MIT license on Github (see fork source). This fork simply eases to simplify setup for integration with parcelLab by providing appropriate defaults.

🚨 Compatibility notice:

For Magento < 2.6 use plugin version 2.4.21

For Magento >= 2.6 use plugin version 2.4.23 or later

Install & Setup Guide

Important: If you have Mageplaza Webhook already installed, DO NOT INSTALL this extension and follow our setup guide instead: Setup Guide with Mageplaza Webhook

Run the following command in Magento 2 root folder:

composer require parcellab/magento-2-webhook
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

After successful installation and deploy log in to your Admin Backend of Magento.

Navigate to System > parcelLab Webhook > Configuration:

Open the section General:

In this screen, you will have to enter your parcelLab API credentials. Generate a new parcelLab API Token with write access in the parcelLab Portal and enter this token together with your parcelLab User ID:

The extension might be disabled by default system setting. Make sure, setting Enable is set to Yes. You might have to remove the flag to use the system setting 1️⃣ and then switch the setting 2️⃣.

This is the correct setting:

Navigate to System > parcelLab Webhook > Manage Events:

You'll find the 2 required events already preconfigured:

If you have entered your parcelLab credentials earlier, you are okay to activate the events:

🎉 Your integration is done! 🎉

FAQs:

Q: Can I add more events?

A: Due to the tailored use of this extension, the number of events is limited. For more flexible webhooks please use the fork source Magento 2 Webhook by Mageplaza.

Q: Error Mageplaza_Core has been already defined

A: Find the solution here

Q: My site is down, what should I do?

A: Please follow this guide: https://www.mageplaza.com/blog/magento-site-down.html

Q: Where do I find transfer logs?

Navigate to System > parcelLab Webhook > Transfer Logs:

You'll find a list of recent transfers and can view details like so:

Please share both the Response as well as the Request Body when requesting support:

Q: I am unsure whether I have "Magento 2 Webhook" by Mageplaza installed, how can I check?

Run php bin/magento module:status and check whether Mageplaza_Webhook is listed. If it is, please don't install this extension but rather follow our Setup Guide with Mageplaza Webhook.

Q: I already have "Magento 2 Webhook" by Mageplaza installed, how can I integrate with parcelLab?

The easiest way is to follow our setup guide for this extension, which will take you less than 15 minutes to complete:

Setup Guide with Mageplaza Webhook

Credit

This extension is a fork of the excellent Magento 2 Webhook by Mageplaza published under MIT license on Github (see fork source).

It also uses mageplaza/module-core and liquid/liquid