Download the PHP package citation-media/wp-webhook-framework without Composer
On this page you can find all versions of the php package citation-media/wp-webhook-framework. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download citation-media/wp-webhook-framework
More information about citation-media/wp-webhook-framework
Files in citation-media/wp-webhook-framework
Package wp-webhook-framework
Short Description Entity-level webhook framework for WordPress using Action Scheduler.
License GPL-2.0-or-later
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package wp-webhook-framework
title: WP Webhook Framework description: Entity-level webhooks for WordPress with scheduled and immediate delivery modes, retries, and failure monitoring.
WP Webhook Framework
Entity-level webhooks for WordPress using Action Scheduler with optional immediate delivery mode. Sends POSTs for create/update/delete of posts, terms, and users. Meta changes trigger the entity update. ACF updates include field context. Features intelligent failure monitoring with email notifications, automatic blocking, and comprehensive filtering options.
Features
- Delivery mode control - Choose scheduled async delivery (default) or immediate synchronous first attempt
- Action Scheduler dispatch - 5s delay for queued webhooks with deduplication
- Automatic deduplication - Dispatcher-level on action+entity+id and meta-level per-request dedup for plugin hooks (ACF, Meta Box, etc.)
- Entity-aware delivery payloads - Derives post_type, taxonomy, and roles at send time
- Send-time enrichment - Adds REST URLs when available
- ACF integration - Adds field key/name context to meta changes
- Registry pattern - Extensible webhook system with custom configurations
- Notification system - Opt-in email alerts for failures, extensible notification handlers
- Failure monitoring - Automatic blocking after consecutive failures
- Comprehensive filtering - Control payloads, URLs, headers, and meta keys
Quick Start
Installation
Requirements
| Requirement | Version |
|---|---|
| WordPress | 6.7 or newer |
| PHP | 8.1 or newer |
| Action Scheduler | 3.7 or newer (declared as a Composer dependency) |
WordPress 6.7 is a hard requirement: the dispatcher signals every delivery and
configuration failure by throwing WP_Exception,
which was added to core in 6.7.0. On older releases those throw sites raise an
uncatchable Error: Class "WP_Exception" not found instead.
Action Scheduler comes bundled and is loaded by Service_Provider::register() — no separate plugin activation needed. If other plugins ship their own copy, Action Scheduler's version manager initialises the newest one.
:::caution
Call Service_Provider::register() while your plugin file loads, not from inside plugins_loaded. Action Scheduler registers itself on plugins_loaded at priority 0, so registering later loads it too late to initialise.
:::
Basic Setup
Service_Provider::register() is idempotent, so separate plugins can call it independently while sharing the same library checkout.
:::tip If you are using a prefixer make sure to exclude this library. Due the strong typings used it will break plugins :::
See Configuration for detailed configuration options.
Usage Examples
Register Built-in Webhooks
No webhooks are active by default. Register what you need via the action:
See Custom Webhooks for creating your own webhooks.
Immediate Delivery Mode
Immediate mode sends the first attempt in the current request. If it fails, retries are still queued asynchronously with exponential backoff.
Filter Payloads
See Hooks and Filters for all available hooks and filters.
Architecture Overview
Core Components
- Service_Provider - Singleton that bootstraps the framework
- Webhook_Registry - Manages webhook instances and initialization
- Webhook (abstract) - Base class for all webhooks
- Dispatcher - Schedules and sends HTTP requests via Action Scheduler
- Entity Handlers - Prepare payloads for posts, terms, users, and meta
Data Flow:
Webhook Statefulness
Webhook instances are singletons and must remain stateless. Never store per-emission data as instance properties. Configuration (URL, timeout, headers) is set during init(). Payloads and dynamic data are passed directly to emit().
See Webhook Statefulness for detailed explanation and examples.
Payload Structure
Example post webhook payload:
Persisted fields (event-time):
- Meta:
meta_type,meta_key - Meta:
acf_field_key,acf_field_name(if ACF field)
Derived fields (when available at send time):
- Post:
post_type - Term:
taxonomy - User:
roles[] rest_url
Failure Monitoring
- Email notifications on first failure after retries exhausted (opt-in via
notifications(['blocked'])) - Automatic blocking after 10 consecutive failures within 1 hour
- Auto-unblock after 1 hour
- Success resets failure count and blocked status
See Failure Handling for configuration and customization.
Code Quality
- PHPCS Compliant - WordPress coding standards (WPCS 3.1)
- Type Safe - PHPStan level 6 static analysis
- i18n Ready - All user-facing strings internationalized
- Filterable - Extensive WordPress filter integration
- Well Documented - Comprehensive inline documentation
Commands
Documentation
- Configuration - Webhook configuration methods, registry setup, and options
- Custom Webhooks - Creating custom webhooks, plugin integrations (WooCommerce, CF7, Gravity Forms)
- Hooks and Filters - All available hooks and filters with examples
- Failure Handling - Failure monitoring, retry mechanism, and blocking behavior
- Notifications - Notification system, opt-in pattern, and custom handlers
- Testing - wp-env application test suite, fixture plugins, and validation workflow
- Webhook Statefulness - Webhook statelessness rules and best practices
