Download the PHP package doohlabs/yii2-webhooks without Composer
On this page you can find all versions of the php package doohlabs/yii2-webhooks. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
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 yii2-webhooks
Yii2 Webhooks
Extension for creating and using web-hooks in yii2.
Description
Add webhooks and attach them to ActiveRecord objects' events to trigger HTTP requests to external systems
(3rd party services, your own applications etc.).
Use case example
Let's assume that inside your project you have an Example class which extends ActiveRecord.
If you want to trigger a webhook every time a new Example record is created, you will create a new Webhook record,
and assign it to your Example class.
You do this by setting the event attribute of the Webhook record to value of app\models\Example::EVENT_AFTER_CREATE.
You also set the webhook url and method values. For example http://api.service.com and POST.
Now, every time a new Example record is created inside your project, your api service receives an
http request with the Example object attributes.
Installation
The preferred way to install this extension is through composer.
Run composer installation.
Setup
Run the migration. It creates the webhook and _webhooklog tables.
The extension needs to be bootstrapped:
Add the module to the config:
Usage
Webhooks
Create a new webhook by navigating to the webhooks module: index.php?r=webhooks/webhook/create
You can use the predefined events from BaseActiveRecord class, e.g. EVENT_AFTER_INSERT or you can use your own events, e.g. app\models\Example::EVENT_EXAMPLE.
The model must implement \doohlabs\webhooks\interfaces\WebhookModelInterface.
User generated events
When triggering your custom event, make sure you send the instantiated model like in the following code:
Logger
Extension logs every triggered webhook with its http request and response.
Logs are available at index.php/webhooks?r=/webhook-log/index
Implementing your own EventDispatcher
You can add your own implementation of the event dispatcher to fit your needs. It must implement EventDispatcherInterface.
Config needs to be updated accordingly:
Implementing your own Webhook
TBD
Screenshots
Contributing
Your local setup should have this repository and an existing yii2 project (preferably a clean yii2 template).
Link the repo to your project by adding it to your project's composer.json file:
Install it to the project using composer:
composer require --prefer-dist doohlabs/yii2-webhooks "*"
You can edit the files from within you project, directly in your vendor folder, for it is much more convenient that way.
Credits
This extension is maintained by Doohlabs.
The original extension was created and is maintained by Bornfight.
License
MIT
