PHPackages ohdearapp/laravel-ohdear-webhooks - 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. [Logging & Monitoring](/categories/logging) 4. / 5. ohdearapp/laravel-ohdear-webhooks ActiveLibrary[Logging & Monitoring](/categories/logging) ohdearapp/laravel-ohdear-webhooks ================================= Handle Oh Dear webhook calls in a Laravel app 2.0.1(8mo ago)2224.4k—6%82MITPHPPHP ^8.2CI passing Since Nov 2Pushed 8mo ago3 watchersCompare [ Source](https://github.com/ohdearapp/laravel-ohdear-webhooks)[ Packagist](https://packagist.org/packages/ohdearapp/laravel-ohdear-webhooks)[ Docs](https://github.com/ohdear/laravel-ohdear-webhooks)[ RSS](/packages/ohdearapp-laravel-ohdear-webhooks/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (10)Dependencies (6)Versions (20)Used By (2) Handle Oh Dear! webhooks in a Laravel application ================================================= [](#handle-oh-dear-webhooks-in-a-laravel-application) [![Latest Version on Packagist](https://camo.githubusercontent.com/c4512669b0c9a5a593088d923247f82e7381cb71a4f5d35882c0abd382789145/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6f68646561726170702f6c61726176656c2d6f68646561722d776562686f6f6b732e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/ohdearapp/laravel-ohdear-webhooks)[![Total Downloads](https://camo.githubusercontent.com/12201a1ae7ad544df336cae213e3bceef8d50deee9b6a961a7191f62cfced120/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6f68646561726170702f6c61726176656c2d6f68646561722d776562686f6f6b732e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/ohdearapp/laravel-ohdear-webhooks) [Oh Dear](https://ohdear.app) can notify your application of events using webhooks. This package can help you handle those webhooks. Out of the box it will verify the Oh Dear signature of all incoming requests. You can easily define jobs or events that should be dispatched when specific events hit your app. This package will not handle what should be done after the webhook request has been validated and the right job or event is called. Installation ------------ [](#installation) ``` $ composer require ohdearapp/laravel-ohdear-webhooks ``` The service provider will automatically register itself. You must publish the config file with: ``` $ php artisan vendor:publish --provider="OhDear\LaravelWebhooks\OhDearWebhooksServiceProvider" --tag="config" ``` This is the contents of the config file that will be published at `config/ohdear-webhooks.php`: ``` return [ /* * Oh dear will sign webhooks using a secret. You can find the secret used at the webhook * configuration settings: /team-settings/notifications#webhooks */ 'signing_secret' => env('OH_DEAR_SIGNING_SECRET'), /* * Here you can define the job that should be run when a certain webhook hits your . * application. * * You can find a list of Oh dear webhook types here: * https://ohdear.app/docs/integrations/webhooks#webhook-events */ 'jobs' => [ // 'uptimeCheckFailed' => \App\Jobs\LaravelWebhooks\HandleFailedUptimeCheck::class, // 'uptimeCheckRecovered' => \App\Jobs\LaravelWebhooks\HandleRecoveredUptimeCheck::class, // ... ], ]; ``` In the `signing_secret` key of the config file you specify your signing secret. You can find the correct at the team webhooks settings on [the notification settings screen](/team-settings/notifications). Finally, take care of the routing: At the Oh Dear notification settings you must configure at what url Oh Dear webhooks should hit your app. In the routes file of your app you must pass that route to `Route::ohDearWebhooks`: ``` Route::ohDearWebhooks('webhook-route-configured-at-the-ohdear-dashboard'); ``` Behind the scenes this will register a `POST` route to a controller provided by this package. Because Oh Dear has no way of getting a csrf-token, you must add that route to the `except` array of the `VerifyCsrfToken` middleware: ``` protected $except = [ 'webhook-route-configured-at-the-ohdear-dashboard', ]; ``` Usage ----- [](#usage) Oh Dear will send out webhooks for several event types. You can find the full list of events types in the [Oh Dear documentation](events). Oh Dear will sign all requests hitting the webhook url of your app. This package will automatically verify if the signature is valid. If it is not, the request was probably not sent by Oh Dear. Unless something wrong, this package will respond with a `200` to webhook requests. Sending a `200` will prevent Oh Dear from resending the same event again. If the signature is not valid a `OhDear\OhDearWebhooks\WebhookFailed` exception will be thrown. There are two ways this package enables you to handle webhook requests: you can opt to queue a job or listen to the events the package will fire. ### Handling webhook requests using jobs [](#handling-webhook-requests-using-jobs) If you want to do something when a specific event type comes in you can define a job that does the work. Here's an example of such a job: ``` namespace App\Jobs; use Illuminate\Bus\Queueable; use Illuminate\Queue\SerializesModels; use Illuminate\Queue\InteractsWithQueue; use Illuminate\Contracts\Queue\ShouldQueue; use OhDear\LaravelWebhooks\OhDearWebhookCall; class HandleFailedUptimeCheck implements ShouldQueue { use InteractsWithQueue, Queueable, SerializesModels; /** @var \OhDear\LaravelWebhooks\OhDearWebhookCall */ public $webhookCall; public function __construct(OhDearWebhookCall $webhookCall) { $this->webhookCall = $webhookCall; } public function handle() { // do your work here // you can access the payload of the webhook call with $this->webhookCall->payload } } ``` We highly recommend that you make this job queueable, because this will minimize the response time of the webhook requests. This allows you to handle more oh dear webhook requests and avoid timeouts. After having created your job you must register it at the `jobs` array in the `ohdear-webhooks.php` config file. The key should be the name of the [oh dear event type](events). The value should be the fully qualified classname. ``` // config/ohdear-webhooks.php 'jobs' => [ 'uptimeCheckFailed' => \App\Jobs\ohdearWebhooks\HandleFailedUptimeCheck::class, 'uptimeCheckRecovered' => \App\Jobs\ohdearWebhooks\HandleRecoveredUptimeCheck::class, ], ``` ### Handling webhook requests using events [](#handling-webhook-requests-using-events) Instead of queueing jobs to perform some work when a webhook request comes in, you can opt to listen to the events this package will fire. Whenever a valid request hits your app, the package will fire a `ohdear-webhooks::` event. The payload of the events will be the instance of `OhDearWebhookCall` that was created for the incoming request. Let's take a look at how you can listen for such an event. In the `EventServiceProvider` you can register listeners. ``` /** * The event listener mappings for the application. * * @var array */ protected $listen = [ 'ohdear-webhooks::uptimeCheckFailed' => [ App\Listeners\MailOperators::class, ], ]; ``` Here's an example of such a listener: ``` namespace App\Listeners; use Illuminate\Contracts\Queue\ShouldQueue; use OhDear\LaravelWebhooks\OhDearWebhookCall; class MailOperators implements ShouldQueue { public function handle(OhDearWebhookCall $webhookCall) { // do your work here // you can access the payload of the webhook call with `$webhookCall->payload` } } ``` We highly recommend that you make the event listener queueable, as this will minimize the response time of the webhook requests. This allows you to handle more Oh Dear webhook requests and avoid timeouts. The above example is only one way to handle events in Laravel. To learn the other options, [read the Laravel documentation on handling events](https://laravel.com/docs/5.5/events). ### Using the OhDearWebhookCall [](#using-the-ohdearwebhookcall) Like mentioned above your events or jobs will receive an instance of `OhDear\LaravelWebhooks\OhDearWebhookCall`. You can access the raw payload by calling: ``` $ohDearWebhookCall->payload; // returns an array; ``` Or you can opt to get more specific information: ``` $ohDearWebhookCall->type(); // returns the type of the webhook (eg: 'uptimeCheckFailed'); $ohDearWebhookCall->monitor(); // returns an array with all the attribute of the monitor; $ohDearWebhookCall->run(); // returns an array with all the attribute of the run; $ohDearWebhookCall->dateTime(); // returns an string with a dateTime (Ymdhis) when Oh Dear generated this webhook call; ``` 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) - [Mattias Geniar](https://github.com/mattiasgeniar) - [All Contributors](../../contributors) License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. ### Health Score 55 — FairBetter than 98% of packages Maintenance61 Regular maintenance activity Popularity38 Limited adoption so far Community24 Small or concentrated contributor base Maturity84 Battle-tested with a long release history Bus Factor1 Top contributor holds 84.7% 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 ~159 days Recently: every ~320 days Total 19 Last Release 244d ago Major Versions 0.0.2 → 1.0.02018-01-08 1.4.4 → 2.0.02025-08-26 PHP version history (6 changes)0.0.1PHP ^7.0 1.1.0PHP ^7.2 1.4.0PHP ^7.3 1.4.1PHP ^8.0|^7.3 1.4.4PHP ^8.3 2.0.0PHP ^8.2 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/32144649?v=4)[Oh Dear](/maintainers/ohdearapp)[@ohdearapp](https://github.com/ohdearapp) --- Top Contributors [![freekmurze](https://avatars.githubusercontent.com/u/483853?v=4)](https://github.com/freekmurze "freekmurze (83 commits)")[![mattiasgeniar](https://avatars.githubusercontent.com/u/407270?v=4)](https://github.com/mattiasgeniar "mattiasgeniar (7 commits)")[![JulianaChiabai](https://avatars.githubusercontent.com/u/91732345?v=4)](https://github.com/JulianaChiabai "JulianaChiabai (2 commits)")[![eric-famiglietti](https://avatars.githubusercontent.com/u/751204?v=4)](https://github.com/eric-famiglietti "eric-famiglietti (2 commits)")[![tgabi333](https://avatars.githubusercontent.com/u/187022?v=4)](https://github.com/tgabi333 "tgabi333 (1 commits)")[![eimantaaas](https://avatars.githubusercontent.com/u/3778741?v=4)](https://github.com/eimantaaas "eimantaaas (1 commits)")[![Lloople](https://avatars.githubusercontent.com/u/5665466?v=4)](https://github.com/Lloople "Lloople (1 commits)")[![clarkeash](https://avatars.githubusercontent.com/u/1612186?v=4)](https://github.com/clarkeash "clarkeash (1 commits)") --- Tags certificatemonitoringohdearssluptimewebhooksmonitoringohdearuptimelaravel-ohdear-webhooks ### Code Quality TestsPest ### Embed Badge ![Health badge](/badges/ohdearapp-laravel-ohdear-webhooks/health.svg) ``` [![Health](https://phpackages.com/badges/ohdearapp-laravel-ohdear-webhooks/health.svg)](https://phpackages.com/packages/ohdearapp-laravel-ohdear-webhooks) ``` ### Alternatives [scoutapp/scout-apm-laravel Scout Application Performance Monitoring Agent - https://scoutapm.com 23831.3k](/packages/scoutapp-scout-apm-laravel)[ohdearapp/ohdear-cli A standalone CLI tool for Oh Dear monitoring. 1371.3k](/packages/ohdearapp-ohdear-cli) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)