README

Simple and powerful implementation of Webhooks.

Installation

You can install the package via composer:

composer require viezel/webhooks

You can publish and run the migrations with:

php artisan vendor:publish --provider="Viezel\Webhooks\WebhooksServiceProvider" --tag="migrations"
php artisan migrate

Add routes to your application. Below is a typical route configuration with auth, api prefix and naming.

Route::middleware('auth:api')->prefix('api')->as('webhooks.api.')->group(function() {
    Route::get('hooks', Viezel\Webhooks\Controllers\API\ListWebhooks::class)->name('list');
    Route::get('hooks/events', Viezel\Webhooks\Controllers\API\ListWebhookEvents::class)->name('events');
    Route::post('hooks', Viezel\Webhooks\Controllers\API\CreateWebhook::class)->name('create');
    Route::delete('hooks/{id}', Viezel\Webhooks\Controllers\API\DeleteWebhook::class)->name('delete');
});

Usage

First, register Events in your application that should be exposed as Webhooks. To do so, your Events should implement the ShouldDeliverWebhooks interface.

The interface has two methods, getWebhookName for giving the webhook a unique name, and getWebhookPayload to define the data send with the webhook.

The following example shows how a Post Updated Event and its implementation:

use App\Models\Post;
use Viezel\Webhooks\Contracts\ShouldDeliverWebhooks;

class PostUpdatedEvent implements ShouldDeliverWebhooks
{
    public function __construct(Post $post)
    {
        $this->post = $post;
    }

    public function getWebhookName(): string
    {
        return 'post:updated';
    }

    public function getWebhookPayload(): array
    {
        return [
            'post' => $this->post->toArray(),
            'extra' => [
                'foo' => 'bar'
            ]       
        ];
    }
}

Next you need to register all your events with the WebhookRegistry. This is typically done in the boot method of a ServiceProvider.

public function boot()
{
    WebhookRegistry::listen(PostUpdatedEvent::class);
}

To check everything works as expected, go visit the webhooks events route. The default route is: /api/hooks/events. It depends how you register the webhook routes.

{
    "events": [
        "post:updated"
    ],
    "url": "https://another-app.com/some/callback/route"
}

Delete a webhook

DELETE https://myapp.test/api/hooks/{id}

Testing

composer test

Credits

License

The MIT License (MIT). Please see License File for more information.

viezel / webhooks

Maintainers

Details