juststeveking/webhooks

The simplest way to start sending webhooks in PHP.

0.0.2 2023-03-19 19:33 UTC

Requires

• php: ^8.2
• php-http/discovery: ^1.15.2
• thecodingmachine/safe: ^2.4

Requires (Dev)

• laravel/pint: ^1.6
• nyholm/psr7: ^1.5.1
• pestphp/pest: ^1.22.6
• php-http/mock-client: ^1.5
• phpstan/phpstan: ^1.10.7
• symfony/http-client: ^6.2
• thecodingmachine/phpstan-safe-rule: ^1.2

Suggests

• nyholm/psr7: A fantastic PSR-7 library that also supports PSR-17
• symfony/http-client: A PSR-18 compliant HTTP Client that will work out of the box.

MIT

• Steve McDougall

README

The simplest way to start sending webhooks in PHP.

Installation

You can install this library using composer:

composer require juststeveking/webhooks

The next step is to install a OSR compliant package to do the request itself, you will need:

• PSR 7 Request Library
• PSR17 Request and Stream Factories
• PSR18 Http Client

This package will auto-discover these packages you have installed for you, so you not need to wire anything up.

Usage

This package is super simple to get started with, all you need to do is build one class and you can start sending webhooks.

use JustSteveKing\Webhooks\Webhook;

class YourWebhook extends Webhook
{
    public function headers(): array
    {
        $signature = hash_hmac(
            algo: 'sha256',
            data: \Safe\json_encode(
                value: $this->buildPayload(),
                flags: JSON_THROW_ON_ERROR,
            ),
            key: 'Your signing key goes here',
        );

        return [
            'Content-Type' => 'application/json',
            'Signature' => $signature,
        ];
    }

    public function buildPayload(): array
    {
        return [
            'foo' => 'bar',
        ];
    }

    public function url(): string
    {
        return 'Your URL goes here.';
    }

    public function method(): Method
    {
        return Method::POST;
    }

    public function plugins(): array
    {
        return [];
    }
}

The HTTP Client used for sending your HTTP requests supports plugins, you can see how these work here.

Tests

There is a composer script available to run the tests:

composer test

However, if you are unable to run this please use the following command:

./vendor/bin/pest

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.