frootbox / webhooks
Webhooks for the Frootbox CMS: tell other services about changes, signed after Standard Webhooks and sent in the background
Package info
github.com/frootbox-packages/webhooks
Type:frootbox-extension
pkg:composer/frootbox/webhooks
Requires
- php: >=8.5
- frootbox/core: ^0.1
- frootbox/database: ^0.1
- psr/http-message: ^2.0
- psr/http-server-handler: ^1.0
- symfony/http-client: ^8.1
Requires (Dev)
None
Suggests
- frootbox/backend: The screen to set up webhooks and see their deliveries
Provides
None
Conflicts
None
Replaces
None
This package is auto-updated.
Last update: 2026-11-04 22:33:52 UTC
README
Webhooks for the Frootbox CMS: tell other services about changes, signed after Standard Webhooks and sent through the queue.
- An admin sets up an address and the actions it hears about, by name
(
page.publish) or pattern (page.*,frootbox/news/*):frootbox/webhooks/webhook.create,.update,.delete,.pause,.resume,.rotate-secret,.test - After every action that matches, a delivery goes into the queue. The
body is
{"type", "timestamp", "data": {"action", "entry", "actor", "input", "result"}}; sensitive input is***, of the result only a number, a boolean or theidof an object goes out - Each delivery has the headers
webhook-id,webhook-timestampandwebhook-signature, is tried 8 times over about 18 hours and kept for 30 days (frootbox/webhooks/delivery.list,delivery.retry) - A webhook without success for 5 days is paused
- Only
https://and addresses on the internet, also after DNS; in developmenthttp://and local addresses work too - The screen "Webhooks" in the backend
To check a webhook on the receiving side, use any library for Standard
Webhooks, or Frootbox\Core\Security\StandardWebhooks::verify() in
another Frootbox.
MIT licensed.
Source and issues
This package is developed in the Frootbox monorepo and mirrored here read-only. Questions, bugs and ideas go there, see the documentation.