woocommerce_webhook_payload filter-hookWC 2.2.0

Filters the webhook payload before delivery.

Usage

add_filter( 'woocommerce_webhook_payload', 'wp_kama_woocommerce_webhook_payload_filter', 10, 4 );

/**
 * Function for `woocommerce_webhook_payload` filter-hook.
 * 
 * @param mixed  $payload     Payload data.
 * @param string $resource    Resource type (e.g. 'order').
 * @param mixed  $resource_id Resource ID.
 * @param int    $webhook_id  Webhook ID.
 *
 * @return mixed
 */
function wp_kama_woocommerce_webhook_payload_filter( $payload, $resource, $resource_id, $webhook_id ){

	// filter...
	return $payload;
}
$payload(mixed)
Payload data.
$resource(string)
Resource type (e.g. 'order').
$resource_id(mixed)
Resource ID.
$webhook_id(int)
Webhook ID.

Changelog

Since 2.2.0 Introduced.

Where the hook is called

WC_Webhook::build_payload()
woocommerce_webhook_payload
woocommerce/includes/class-wc-webhook.php 460
return apply_filters( 'woocommerce_webhook_payload', $payload, $resource, $resource_id, $this->get_id() );

Where the hook is used in WooCommerce

woocommerce/src/Internal/Admin/Agentic/AgenticWebhookManager.php 75
add_filter( 'woocommerce_webhook_payload', array( $this, 'customize_webhook_payload' ), 10, 4 );