Download the PHP package butterfly-team/magento-order-event-dispatcher without Composer
On this page you can find all versions of the php package butterfly-team/magento-order-event-dispatcher. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download butterfly-team/magento-order-event-dispatcher
More information about butterfly-team/magento-order-event-dispatcher
Files in butterfly-team/magento-order-event-dispatcher
Package magento-order-event-dispatcher
Short Description This Magento 2 module allows you to trigger order-related events for an existing order via a URL. This is useful when you manually create orders in the Magento database and want to trigger events for processing workflows such as inventory updates, email notifications, and more.
License GPL-3.0-only
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package magento-order-event-dispatcher
Magento 2 Order Event Dispatcher Module
This Magento 2 module allows you to trigger order-related events for an existing order via a URL. This is useful when you manually create orders in the Magento database and want to trigger events for processing workflows such as inventory updates, email notifications, and more.
Features
- Trigger Magento 2 order events for an existing order ID via a URL.
- Supports events:
sales_order_place_after,checkout_submit_all_after,sales_order_save_after. - Secured with a secret key to ensure only authorized requests can trigger the events.
Install/update using Composer
Composer is a dependency management tool for PHP. It allows you to declare the libraries your project depends on, and it will manage the installation or update of these libraries.
Prerequisites
Make sure Composer is properly installed in your environment. Learn more at https://getcomposer.org.
Install/Update
-
In your Magento root directory, run the following command to add the module via Composer:
- Then, update your Magento setup:
Uninstalling the Module
To remove the module installed via Composer, use these commands:
- In your Magento root directory:
Securing the Endpoint with a Secret Key
To secure the endpoint, configure a secret key in Magento’s core_config_data table:
-
Add the secret key in the Magento admin:
- Go to Stores > Configuration > Advanced > Developer.
- Set a value under the configuration path:
butterfly/order_event_dispatcher/secret_key.
Alternatively, add the key directly to the database:
- Replace
your_secret_key_herewith a secure, unique key.
Usage
To trigger order events for an existing order, use the following URL structure in your browser or API client:
Replace <ORDER_ID> with the actual order ID in the Magento database and your_secret_key_here with your configured secret key. The module will respond with a JSON message indicating the success or failure of the event dispatch.
Example
For an order with ID 1, access:
Events Triggered
sales_order_place_after: Dispatched after an order is placed.checkout_submit_all_after: Dispatched after checkout submission.sales_order_save_after: Dispatched after an order is saved.
You can customize which events are triggered in the Dispatch.php controller file.
Troubleshooting
-
Ensure the module is enabled:
- Check Magento logs (
var/log/system.logandvar/log/exception.log) for any errors.
License
This module is open-source and free to use. Feel free to modify it to suit your needs.
