PHPackages jmsfwk/lumen-webhook-server - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [DevOps & Deployment](/categories/devops) 4. / 5. jmsfwk/lumen-webhook-server ActiveLibrary[DevOps & Deployment](/categories/devops) jmsfwk/lumen-webhook-server =========================== Send webhooks in Lumen apps 1.0.1(6y ago)11.3k4[1 PRs](https://github.com/jmsfwk/lumen-webhook-server/pulls)MITPHPPHP ^7.3 Since Jun 25Pushed 4y agoCompare [ Source](https://github.com/jmsfwk/lumen-webhook-server)[ Packagist](https://packagist.org/packages/jmsfwk/lumen-webhook-server)[ Docs](https://github.com/jsmfwk/lumen-webhook-server)[ RSS](/packages/jmsfwk-lumen-webhook-server/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (4)Dependencies (4)Versions (5)Used By (0) Send webhooks from Lumen apps ============================= [](#send-webhooks-from-lumen-apps) [![Latest Version on Packagist](https://camo.githubusercontent.com/b73bf80fb40913781e5f618360cc7ecd80cbef5abeb68273dd4f8a4371b660bc/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6a6d7366776b2f6c756d656e2d776562686f6f6b2d7365727665722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/jmsfwk/lumen-webhook-server)[![Build Status](https://camo.githubusercontent.com/7a1089b9398f0b201086442c25b5f72a1d5d77d7763f55e1120dc9ab5de495f0/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f6a6d7366776b2f6c756d656e2d776562686f6f6b2d7365727665722f6d61737465722e7376673f7374796c653d666c61742d737175617265)](https://travis-ci.org/jmsfwk/lumen-webhook-server)[![Total Downloads](https://camo.githubusercontent.com/040e29fece9ca3fdf6739469cbe923c4970ca08eb2b56e3dfdd4e372fdeba00a/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6a6d7366776b2f6c756d656e2d776562686f6f6b2d7365727665722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/jmsfwk/lumen-webhook-server) This package adapts [spatie/laravel-webhook-server](https://github.com/spatie/laravel-webhook-server) for use with Lumen. Installation ------------ [](#installation) You can install the package via composer: ``` composer require jmsfwk/lumen-webhook-server ``` Add the service provider to your `app.php` file: ``` $app->register(Jmsfwk\WebhookServer\WebhookServerServiceProvider::class); ``` By default, the package uses queues to retry failed webhook requests. Be sure to set up a real queue other than `sync` in non-local environments. Usage ----- [](#usage) This is the simplest way to call a webhook: ``` WebhookCall::create() ->url('https://other-app.com/webhooks') ->payload(['key' => 'value']) ->useSecret('sign-using-this-secret') ->dispatch(); ``` This will send a post request to `https://other-app.com/webhooks`. The body of the request will be JSON encoded version of the array passed to `payload`. The request will have a header called `Signature` that will contain a signature the receiving app can use [to verify](https://github.com/spatie/laravel-webhook-server#how-signing-requests-works) the payload hasn't been tampered with. If the receiving app doesn't respond with a response code starting with `2`, the package will retry calling the webhook after 10 seconds. If that second attempt fails, the package will attempt to call the webhook a final time after 100 seconds. Should that attempt fail, the `FinalWebhookCallFailedEvent` will be raised. ### How signing requests works [](#how-signing-requests-works) When setting up, it's common to generate, store, and share a secret between your app and the app that wants to receive webhooks. Generating the secret could be done with `Illuminate\Support\Str::random()`, but it's entirely up to you. The package will use the secret to sign a webhook call. By default, the package will add a header called `Signature` that will contain a signature the receiving app can use the payload hasn't been tampered with. This is how that signature is calculated: ``` // payload is the array passed to the `payload` method of the webhook // secret is the string given to the `signUsingSecret` method on the webhook. $payloadJson = json_encode($payload); $signature = hash_hmac('sha256', $payloadJson, $secret); ``` ### Customizing signing requests [](#customizing-signing-requests) If you want to customize the signing process, you can create your own custom signer. A signer is any class that implements `Spatie\WebhookServer\Signer`. This is what that interface looks like. ``` namespace Spatie\WebhookServer\Signer; interface Signer { public function signatureHeaderName(): string; public function calculateSignature(array $payload, string $secret): string; } ``` After creating your signer, you can specify it's class name in the `signer` key of the `webhook-server` config file. Your signer will then be used by default in all webhook calls. You can also specify a signer for a specific webhook call: ``` WebhookCall::create() ->signUsing(YourCustomSigner::class) ... ->dispatch(); ``` If you want to customize the name of the header, you don't need to use a custom signer, but you can change the value in the `signature_header_name` in the `webhook-server` config file. ### Retrying failed webhooks [](#retrying-failed-webhooks) When the app to which we're sending the webhook fails to send a response with a `2xx` status code the package will consider the call as failed. The call will also be considered failed if the remote app doesn't respond within 3 seconds. You can configure that default timeout in the `timeout_in_seconds` key of the `webhook-server` config file. Alternatively, you can override the timeout for a specific webhook like this: ``` WebhookCall::create() ->timeoutInSeconds(5) ... ->dispatch(); ``` When a webhook call fails, we'll retry the call two more times. You can set the default amount of times we retry the webhook call in the `tries` key of the config file. Alternatively, you can specify the number of tries for a specific webhook like this: ``` WebhookCall::create() ->maximumTries(5) ... ->dispatch(); ``` To not hammer the remote app we'll wait some time between each attempt. By default, we wait 10 seconds between the first and second attempt, 100 seconds between the third and the fourth, 1000 between the fourth and the fifth and so on. The maximum amount of seconds that we'll wait is 100 000, which is about 27 hours. This behavior is implemented in the default `ExponentialBackoffStrategy`. You can define your own backoff strategy by creating a class that implements `Spatie\WebhookServer\BackoffStrategy\BackoffStrategy`. This is what that interface looks like: ``` namespace Spatie\WebhookServer\BackoffStrategy; interface BackoffStrategy { public function waitInSecondsAfterAttempt(int $attempt): int; } ``` You can make your custom strategy the default strategy by specifying it's fully qualified class name in the `backoff_strategy` of the `webhook-server` config file. Alternatively, you can specify a strategy for a specific webhook like this. ``` WebhookCall::create() ->useBackoffStrategy(YourBackoffStrategy::class) ... ->dispatch(); ``` Under the hood, the retrying of the webhook calls is implemented using [delayed dispatching](https://laravel.com/docs/master/queues#delayed-dispatching). Amazon SQS only has support for a small maximum delay. If you're using Amazon SQS for your queues, make sure you do not configure the package in a way so there are more than 15 minutes between each attempt. ### Customizing the HTTP verb [](#customizing-the-http-verb) By default, all webhooks will use the `post` method. You can customize that by specifying the HTTP verb you want in the `http_verb` key of the `webhook-server` config file. You can also override the default for a specific call by using the `useHttpVerb` method. ``` WebhookCall::create() ->useHttpVerb('get') ... ->dispatch(); ``` ### Adding extra headers [](#adding-extra-headers) You can use extra headers by adding them to the `headers` key in the `webhook-server` config file. If you want to add additional headers for a specific webhook, you can use the `withHeaders` call. ``` WebhookCall::create() ->withHeaders([ 'Another Header' => 'Value of Another Header' ]) ... ->dispatch(); ``` ### Verifying the SSL certificate of the receiving app [](#verifying-the-ssl-certificate-of-the-receiving-app) When using an URL that starts with `https://` the package will verify if the SSL certificate of the receiving party is valid. If it is not, we will consider the webhook call failed. We don't recommend this, but you can turn off this verification by setting the `verify_ssl` key in the `webhook-server` config file to `false`. You can also disable the verification per webhook call with the `doNotVerifySsl` method. ``` WebhookCall::create() ->doNotVerifySsl() ... ->dispatch(); ``` ### Adding meta information [](#adding-meta-information) You can add extra meta information to the webhook. This meta information will not be transmitted, and it will only be used to pass to [the events this package fires](#events). This is how you can add meta information: ``` WebhookCall::create() ->meta($arrayWithMetaInformation) ... ->dispatch(); ``` ### Adding tags [](#adding-tags) If you're using [Laravel Horizon](https://laravel.com/docs/5.8/horizon) for your queues, you'll be happy to know that we support [tags](https://laravel.com/docs/5.8/horizon#tags). To add tags to the underlying job that'll perform the webhook call, simply specify them in the `tags` key of the `webhook-server` config file or use the `withTags` method: ``` WebhookCall::create() ->withTags($tags) ... ->dispatch(); ``` ### Events [](#events) The package fires these events: - `WebhookCallSucceededEvent`: the remote app responded with a `2xx` response code. - `WebhookCallFailedEvent`: the remote app responded with a non `2xx` response code, or it did not respond at all - `FinalWebhookCallFailedEvent`: the final attempt to call the webhook failed. All these events have these properties: - `httpVerb`: the verb used to perform the request - `webhookUrl`: the URL to where the request was sent - `payload`: the used payload - `headers`: the headers that were sent. This array includes the signature header - `meta`: the array of values passed to the webhook with [the `meta` call](#adding-meta-information) - `tags`: the array of [tags](#adding-tags) used - `attempt`: the attempt number - `response`: the response returned by the remote app. Can be an instance of `\GuzzleHttp\Psr7\Response` or `null`. Testing ------- [](#testing) ``` composer test ``` Changelog --------- [](#changelog) Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. Contributing ------------ [](#contributing) Please see [CONTRIBUTING](CONTRIBUTING.md) for details. ### Security [](#security) If you discover any security-related issues, please email instead of using the issue tracker. Credits ------- [](#credits) - [Freek Van der Herten](https://github.com/freekmurze) - [James Fenwick](https://github.com/jmsfwk) - [All Contributors](../../contributors) Support Spatie -------------- [](#support-spatie) Spatie is a web design agency based in Antwerp, Belgium. You'll find an overview of all their open source projects [on their website](https://spatie.be/opensource). If you also depend on their contributions? Reach out and support them on [Patreon](https://www.patreon.com/spatie). License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. ### Health Score 29 — LowBetter than 60% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity19 Limited adoption so far Community8 Small or concentrated contributor base Maturity57 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~31 days Total 4 Last Release 2415d ago Major Versions 0.1.1 → 1.0.02019-09-27 ### Community Maintainers ![](https://www.gravatar.com/avatar/dc09fcfd6faa66d9704a251380f31449bbe2dd2bd64bf15ee6864a2a6e2658fe?d=identicon)[jmsfwk](/maintainers/jmsfwk) --- Top Contributors [![jmsfwk](https://avatars.githubusercontent.com/u/9892048?v=4)](https://github.com/jmsfwk "jmsfwk (10 commits)") --- Tags lumenwebhooksserverwebhooklumen-webhook-server ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/jmsfwk-lumen-webhook-server/health.svg) ``` [![Health](https://phpackages.com/badges/jmsfwk-lumen-webhook-server/health.svg)](https://phpackages.com/packages/jmsfwk-lumen-webhook-server) ``` ### Alternatives [spatie/laravel-webhook-server Send webhooks in Laravel apps 1.1k8.8M22](/packages/spatie-laravel-webhook-server)[pragmarx/health Laravel Server & App Health Monitor and Notifier 2.0k1.0M2](/packages/pragmarx-health)[felixfbecker/language-server-protocol PHP classes for the Language Server Protocol 22476.7M6](/packages/felixfbecker-language-server-protocol)[clue/socket-raw Simple and lightweight OOP wrapper for PHP's low-level sockets extension (ext-sockets). 35111.1M48](/packages/clue-socket-raw)[voryx/thruway Thruway WAMP router core 6771.0M17](/packages/voryx-thruway)[php-mcp/server PHP SDK for building Model Context Protocol (MCP) servers - Create MCP tools, resources, and prompts 828280.5k25](/packages/php-mcp-server) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)