Download the PHP package sweettooth/magento2-module-webhook without Composer
On this page you can find all versions of the php package sweettooth/magento2-module-webhook. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download sweettooth/magento2-module-webhook
More information about sweettooth/magento2-module-webhook
Files in sweettooth/magento2-module-webhook
Package magento2-module-webhook
Short Description Webhooks for Magento 2
License MIT
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 magento2-module-webhook
Note: This is alpha software and not to be used in production until v1.0.0
Webhooks for Magento 2
This module provides webhooks for Magento 2 events. Inspired by Alan Kent's's Webhooks in Magento 2 blog post which mentions a rough timeline for getting webhooks in Magento 2 core:
Better support for webhooks is on the backlog, but currently not guaranteed for Magento 2 GA.
We're hopeful the community can help push this effort forward through this module.
Getting Started
Install via composer
Add SweetTooth_Webhook to your app/etc/config.php
Run database migrations
Supported Webhooks
Available now
- Customer updated
- Customer deleted
- Order updated
- Order deleted
- Product updated
- Product deleted
TODO
- Customer created
- Order created
- Product created
- CRUD operations for other resources
Roadmap and areas for discussion
Async webhooks (RFC)
Without async webhooks, this module is pretty much a no-go for production shops - the dependency on third party systems is just too risky to do synchronously. The best practice for performing tasks asynchronously is to queue it up on a memory store (redis, memcache, etc) and have a background worker pick up the job and perform it, meanwhile the synchronous request returns immediately. Since there's no native queueing for Magento 2, our best bet might be to use the database as a 'queue' ("Blasphemy!" you say. Chill, magento already does this in the newsletter module) then use the cron to pick up the jobs every minute.
Serialization (RFC)
Right now serializing the payload of the webhook is super basic, just calling getData() on the model. This is all kinds of bad because it will expose sensitive information like password hashes and such. A better strategy would be to create a serializer for each resource. An even better strategy is if we could re-use the serializer for the REST API so our webhook data has an identical json structure to the API. Boom.
Extensibility
It would be really cool to make this module extendible so other modules could add events that can be webhook'd
Creating webhooks through the API
This is a really legit use case. An app that has API access to a shop may want to register webhooks to receive CRUD events on specific resources that they would otherwise need to poll for every x hours. Both Shopify and Bigcommerce have this endpoint and it's lovely.
Data formats
We should probably support XML someday. sigh
Contributing
Submit a pull request!
All versions of magento2-module-webhook with dependencies
magento/module-backend Version 1.0.0-beta
magento/module-store Version 1.0.0-beta
magento/framework Version 1.0.0-beta
magento/magento-composer-installer Version *