Send Full Product Details over WooCommerce Webhook Action Hook

WooCommerce has a webhook feature that allows you to send product data to a webhook url when a certain product status is made. The configuration of the webhooks is at WooCommerce>Settings>Advanced>Webhooks

The product states to choose from to fire the webhook are referred to as Topics and include states like Order Created, Order Updated and Order Deleted.

Firing Webhook with custom WooCommerce Action

Also in the above list is an option for an Action which allows for an Action Event (hook) to be added which allows you to fire the webhook when a WooCommerce hook is fired.

So in the above an action is selected as a Topic then a WooCommerce hook is added – in the example it is :

woocommerce_order_status_processing

Here I want to send the order details only when the order has a state of processing, you can choose from a wide range of hooks, depending when you want to send the data.

The webhook will fire when the action is fired, but one of the main drawbacks of using a WooCommerce custom action is that only a small part of the product data is sent to the webhook url

So in the Raw Content section only the action name and order number are returned.

Function to send all product details

To get around this limitation there is a function that can be added via the themes functions.php file or as a plugin.

	<?php
	/**
	* Plugin Name: Woo Custom Webhook
	* Plugin URI: https://wpbeaches.com/send-full-product-details-over-woocommerce-webhook-action-hook/
	* Description: Custom WooCommerce Webhook Action
	* Author URI: https://github.com/woocommerce/woocommerce/issues/20336#issuecomment-829510702
	* Version: 0.1.0
	*/
	/**
	* Set the proper resource payload for a custom action webhook
	*
	* @param int $target_webhook_id
	* @param string $desired_resource 'order', 'product', 'coupon', or 'customer'
	*/
	function set_resource_for_webhook_payload_by_webhook_id($target_webhook_id, $desired_resource) {
	// Set the desired_resource payload for this webhook ('order', 'product', 'coupon', 'customer')
	add_filter('woocommerce_webhook_resource', function($resource, $webhook_id) use ($target_webhook_id, $desired_resource) {
	if($webhook_id == $target_webhook_id) {
	return $desired_resource;
	}
	return $resource;
	}, 10, 2);
	// Need to ensure our event (i.e., action) is seen as valid, as we've changed the default 'action.' prefix for the topic above
	add_filter('woocommerce_valid_webhook_events', function($valid_events) use ($target_webhook_id) {
	try {
	$topic = wc_get_webhook($target_webhook_id)->get_topic();
	list($resource, $event) = explode('.', $topic);
	if(!empty($event)) {
	$valid_events[] = $event;
	}
	return $valid_events;
	} catch (Exception $e) {
	return $valid_events;
	}
	}, 10);
	}
	// Change the Webhook ID to suit and data source of order, product, coupon or customer
	add_action('init', function(){
	set_resource_for_webhook_payload_by_webhook_id( 1, 'order' );
	});

view raw webhook.php hosted with ❤ by GitHub

Using this function and changing the webhook ID and data source will now return the full data to the webhook.

Now the full order details are sent.

I am not the author of this code the source is stated in the code gist, however I have used and verify it works, the webhook testing I used is done at https://webhook.site