New Packages for Sending and Receiving Webhooks

Published on by

New Packages for Sending and Receiving Webhooks image

Spatie released two new packages aimed at helping developers send and receive webhooks in Laravel: laravel-webhook-server and laravel-webhook-client. If you either need to provide webhooks to consumers of your application or if you need to consume them yourself, consider using these packages either independently or in tandem.

We’ll take a quick look at both packages to give you a high-level overview and then send you on your way to the GitHub repos!

Laravel Webhook Server

In his recent blog post Sending and receiving webhooks in Laravel apps, Freek had the following to say about the capabilities of the server package:

laravel-webhook-server allows you to configure and send webhooks in a Laravel app easily. So you’ll install this into the app that wants to notify other apps that something has happened. The package has support for signing calls, retrying calls, and backoff strategies.

While we won’t go into details about each of these features, know that the server package has everything you need to support sending webhooks to other applications. At a high level, here’s an example from the documentation:

WebhookCall::create()
->url('https://other-app.com/webhooks')
->payload(['key' => 'value'])
->useSecret('sign-using-this-secret')
->dispatch();

You can customize the signing process by creating a custom signer with an interface provided by Spatie’s package (see the Spatie\WebhookServer\Signer\Signer interface).

Laravel Webhook Client

On the other side of the webhook process, you will sometimes be the consumer of others’ webhooks. Spatie provides a companion (or it can be used as a stand-alone) package for receiving webhooks. According to Freek’s post, the package includes support for verifying, storing, and processing payloads in a queue:

laravel-webhook-client has support for verifying signed calls, storing payloads, and processing the payloads in a queued job.

As with the webhook server package, the client package supports customization of the signature validation via the SignatureValidator interface provided by the package.

The client package uses a database to store and process webhooks. Using a job class, you can handle valid webhooks:

namespace App\Jobs;
 
use \Spatie\WebhookClient\ProcessWebhookJob;
 
class ProcessWebhookJob extends SpatieProcessWebhookJob
{
public function handle()
{
// $this->webhookCall // contains an instance of `WebhookCall`
 
// perform the work here
}

The package even has support for processing incoming webhook requests for multiple applications. The readme has an example configuration and router configuration for routing webhooks from multiple applications.

Learn More

I would highly recommend going over Freek’s blog post Sending and receiving webhooks in Laravel apps to learn more details about these packages. Both packages look, and I can’t wait to try them on my applications! Excellent work and congratulations to the Spatie team on these useful open-source applications!

You can learn more about these packages, get full installation instructions, and view the source code on GitHub at spatie/laravel-webhook-server and spatie/laravel-webhook-client.

Paul Redmond photo

Staff writer at Laravel News. Full stack web developer and author.

Filed in:
Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

image
No Compromises

Join the Mastering Laravel community to level up your skills and get trusted advice

Visit No Compromises
Laravel Forge logo

Laravel Forge

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Forge
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
No Compromises logo

No Compromises

Joel and Aaron, the two seasoned devs from the No Compromises podcast, are now available to hire for your Laravel project. ⬧ Flat rate of $7500/mo. ⬧ No lengthy sales process. ⬧ No contracts. ⬧ 100% money back guarantee.

No Compromises
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
Bacancy logo

Bacancy

Supercharge your project with a seasoned Laravel developer with 4-6 years of experience for just $2500/month. Get 160 hours of dedicated expertise & a risk-free 15-day trial. Schedule a call now!

Bacancy
Lucky Media logo

Lucky Media

Bespoke software solutions built for your business. We ♥ Laravel

Lucky Media
Lunar: Laravel E-Commerce logo

Lunar: Laravel E-Commerce

E-Commerce for Laravel. An open-source package that brings the power of modern headless e-commerce functionality to Laravel.

Lunar: Laravel E-Commerce
LaraJobs logo

LaraJobs

The official Laravel job board

LaraJobs
Larafast: Laravel SaaS Starter Kit logo

Larafast: Laravel SaaS Starter Kit

Larafast is a Laravel SaaS Starter Kit with ready-to-go features for Payments, Auth, Admin, Blog, SEO, and beautiful themes. Available with Vue and Livewire stacks.

Larafast: Laravel SaaS Starter Kit
SaaSykit: Laravel SaaS Starter Kit logo

SaaSykit: Laravel SaaS Starter Kit

SaaSykit is a Laravel SaaS Starter Kit that comes with all features required to run a modern SaaS. Payments, Beautiful Checkout, Admin Panel, User dashboard, Auth, Ready Components, Stats, Blog, Docs and more.

SaaSykit: Laravel SaaS Starter Kit
Rector logo

Rector

Your partner for seamless Laravel upgrades, cutting costs, and accelerating innovation for successful companies

Rector

The latest

View all →
Asserting a JSON Response Structure in Laravel image

Asserting a JSON Response Structure in Laravel

Read article
Backpack turns 8 years old, celebrates with 40% discount image

Backpack turns 8 years old, celebrates with 40% discount

Read article
Create a DateTime from a Timestamp With this New Method Coming to PHP 8.4 image

Create a DateTime from a Timestamp With this New Method Coming to PHP 8.4

Read article
Neovim Plugin to for Navigating Laravel and Livewire Components image

Neovim Plugin to for Navigating Laravel and Livewire Components

Read article
Laravel Herd v1.7 is out with updates to the dump UI image

Laravel Herd v1.7 is out with updates to the dump UI

Read article
Share Error Package for Laravel's New Exception Page image

Share Error Package for Laravel's New Exception Page

Read article