The Webhooks facade

Everything goes through one facade, RoundlyConsulting\Webhooks\Facades\Webhooks (global alias Webhooks), over the WebhooksManager. Flat verbs send; for($owner) scopes everything to one owner; inbound() and outbound() manage each direction:

use RoundlyConsulting\Webhooks\DataTransferObjects\PruneOptions;
use RoundlyConsulting\Webhooks\Facades\Webhooks;

// Sending
Webhooks::send($endpoint, 'invoice.paid', ['invoice' => 42]);               // one endpoint
Webhooks::send($endpoint, 'invoice.paid', $payload, id: 'invoice-42-paid'); // idempotent
Webhooks::broadcast('system.maintenance', $payload);                        // owner-less endpoints only
Webhooks::for($team)->broadcast('invoice.paid', $payload);                  // every subscribed endpoint of $team

// The two directions — app-wide, or scoped to one owner
$created = Webhooks::inbound()->create(handler: 'billing');
$endpoints = Webhooks::for($team)->outbound()->endpoints();

// Registries, retention and testing
Webhooks::schemes()->extend('github', GitHubScheme::class);
Webhooks::handlers()->register('billing', BillingWebhookHandler::class);
$result = Webhooks::prune(new PruneOptions(dryRun: true));
$fake = Webhooks::fake();

Manager methods

Once Webhooks::fake() has run, the fake’s sent(), broadcasts(), redelivered(), replayed() and every assert…() are callable on the facade too — see Testing.

inbound() — InboundWebhooks

outbound() — OutboundWebhooks

for($owner) — a boundary

Webhooks::for($owner) returns OwnerWebhooks with inbound(), outbound(), broadcast(string $eventType, $payload) and owner(). Its sub-accessors refuse another owner’s endpoint or delivery with EndpointNotFoundException, as if it did not exist; create() sets the owner, and find(), endpoints() and deliveries() see only that owner’s rows. The HasWebhooks trait’s webhooks() returns the same handle.

schemes() and handlers() — the registries

A scheme closure is a factory (it returns the scheme); a handler closure is the handler. Classes resolve through the container, so constructor injection works. Both registries are process-wide: register in a service provider’s boot() and they hold for every request, every job a queue worker runs and every Octane request. A registration made inside a request or job lasts for the rest of the process too, like Gate::define(). forget() removes a run-time registration; a configured one stays.

The route macro

Route::webhooks(string $prefix = 'webhooks', array $middleware = []): Route mounts the inbound pipeline on a route of your own — see Receiving webhooks.

Data objects

In RoundlyConsulting\Webhooks\DataTransferObjects, all final readonly:

Enums

In RoundlyConsulting\Webhooks\Enums, string-backed, with translated labels (webhooks::enums.*) and the enums-for-laravel helpers — label(), labels(), values(), options(), fromLabel(), is(). Values are the snake_case of the case name: