Download the PHP package justbetter/laravel-magento-webhooks without Composer
On this page you can find all versions of the php package justbetter/laravel-magento-webhooks. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download justbetter/laravel-magento-webhooks
More information about justbetter/laravel-magento-webhooks
Files in justbetter/laravel-magento-webhooks
Package laravel-magento-webhooks
Short Description A Laravel package to listen to webhooks dispatched from mageplaza/webhooks.
License MIT
Homepage https://github.com/justbetter/laravel-magento-webhooks
Informations about the package laravel-magento-webhooks
Laravel Magento Webhooks
This package has an endpoint to receive events from the Mageplaza Webhooks module. It can be configured to dispatch Laravel events when a specific event in Magento has been triggered.
Also check out our other Laravel Magento packages! We also have a Magento Client to easily connect Laravel to Magento!
Installation
Install the composer package.
Setup
Publish the configuration of the package.
Run the migration for the event logs.
Configuration
The events
array located in your configuration can be used to add events.
By default, no middleware is present on the webhook url. This can be changed by adding your own middleware to
the middleware
array, like authentication.
Schedule clean up command
In order to keep the database from filling up, schedule the CleanLogsCommand
in your Kernel.
This command supports usage of a custom date. You can pass a date as a parameter which will clean logs from before this date. This date defaults to one month prior.
Magento Webhook Configuration
The following configuration can be used in order to successfully work with webhooks.
Key | Value |
---|---|
Payload URL | http://localhost/magento/webhook |
Method | POST |
Content Type | application/json |
You can configure the body any way you like as long as an event
key is present. The event
can be named anything.
Adding events
Adding an event in Laravel can be easily done in a few steps.
Create an event
Create a new event in Laravel and be sure to extend our WebhookEvent
.
This way, you will have a constructor for $event
and $data
.
Update your configuration
Open your magento-webhooks
configuration and add an event.
Note: Be sure that the event
MyWebhookEvent
matches yourjson
configuration above.
Create a listener
Run the following command to generate an event listener.
Register your event and listener
Update your EventServiceProvider
to add your event and listener.
Testing
In order to test the package functionalities, run the following command:
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Ramon Rietdijk
- All Contributors
License
The MIT License (MIT). Please see License File for more information.