Tag: fix

WooCommerce delayed webhooks using actions scheduler

Recently been contacted by a user who needed the ability to delay the WooCommerce webhooks by x time, this would allow other processes happening on the site to finish instead of firing the webhook straight away, for example waiting for the payment process to finalise. Delaying webhooks is not common practice, however some time special case arises!

Take a look at actions scheduler if you wish to read more into the scheduler system used by WooCommerce.

Code

The following code allows you to delay several WooCommerces webhooks by a set duration (seconds) and also run in two modes.

Single Webhook, creates 1 single webhook but delayed by x seconds.
Multi Webhook, creates 2 webhooks, the normal webhook created by WooCommerce and a second repeat webhook which runs x seconds later.

function filter_woocommerce_webhook_deliver_async($true, $instance, $arg) {
    // Replace default schedule action? (single web hook fired, with delay)
    // Or schedule a seperate delayed action (default webhook fied with a second delayed web hook)
    $singleWebhook = false;
    
    // Target webhook topics
    $targetWebhookTopics = [
        ‘order.updated’,
    ];
    
    // Delay time in seconds
    $delayTime = 300;
    
    // If order.update, we want to create a seperate delayed webhook via schedule actions
    if (in_array($instance->get_topic(), $targetWebhookTopics)) {
        $payload = [‘webhook_id’ => $instance->get_id(), arg => $arg];
        $group = $singleWebhook ? ‘woocommerce-webhooks’ : ‘woocommerce-webhooks-delayed’;
        
        // Schedule a single action to run in 5 minutes, to cause the order.update to fire (delayed)
        // Make sure to run as_next_scheduled_action so multiple instances are not scheduled if one is already scheduled
        if (as_next_scheduled_action(‘woocommerce_deliver_webhook_async’, $payload, $group) === false) {
            as_schedule_single_action(time() + $delayTime, ‘woocommerce_deliver_webhook_async’, $payload, $group);
        }
    }
    
    return $true;
};
add_filter(‘woocommerce_webhook_deliver_async’, ‘filter_woocommerce_webhook_deliver_async’, 10, 3);

function filter_woocommerce_webhook_deliver_async($true, $instance, $arg) {

// Replace default schedule action? (single web hook fired, with delay)

// Or schedule a seperate delayed action (default webhook fied with a second delayed web hook)

$singleWebhook = false;

// Target webhook topics

$targetWebhookTopics = [

‘order.updated’,

];

// Delay time in seconds

$delayTime = 300;

// If order.update, we want to create a seperate delayed webhook via schedule actions

if (in_array($instance–>get_topic(), $targetWebhookTopics)) {

$payload = [‘webhook_id’ => $instance–>get_id(), arg => $arg];

$group = $singleWebhook ? ‘woocommerce-webhooks’ : ‘woocommerce-webhooks-delayed’;

// Schedule a single action to run in 5 minutes, to cause the order.update to fire (delayed)

// Make sure to run as_next_scheduled_action so multiple instances are not scheduled if one is already scheduled

if (as_next_scheduled_action(‘woocommerce_deliver_webhook_async’, $payload, $group) === false) {

as_schedule_single_action(time() + $delayTime, ‘woocommerce_deliver_webhook_async’, $payload, $group);

}

return $true;

};

add_filter(‘woocommerce_webhook_deliver_async’, ‘filter_woocommerce_webhook_deliver_async’, 10, 3);

This code is provided as it and may require changes to work for your needs.

12th November 2020

WooCommerce fix slow or delayed webhooks and achieve instant webhook firing

I’ve recently been working on a project which synced data between WooCommerce and an internal warehouse system, I was utilising the WooCommerce webhooks to achieve near real time syncing between the two systems, without having the creating API scripts to poll for data on a regular basis.

The Problem?

There was a delay ranging from couple seconds to 1 minute, WooCommerce uses a system called actions scheduler, this is an improved wordpress cron, allowing background processing to occur within WordPress for single or recurring actions. This is great and what WooCommerce utilises for its web hook system, however it is backed by the word press cron and the next load of scheduled actions will run on the next cron run (every 1 minute).

For this project, I needed the web hooks to fire as soon as the button was clicked, and a possible delay up to 1 minute was to long.

Fix

Disable async web hooks, web hooks will not fire as soon as they are created as part of the browser request.

/*
 * WooCommerce Disable async webhook delivery
 */
function custom_woocommerce_disable_async_webhook() {
	return false;
}
add_filter(‘woocommerce_webhook_deliver_async’, ‘custom_woocommerce_disable_async_webhook’);

* WooCommerce Disable async webhook delivery

function custom_woocommerce_disable_async_webhook() {

return false;

}

add_filter(‘woocommerce_webhook_deliver_async’, ‘custom_woocommerce_disable_async_webhook’);

I would recommend you test your site after doing this change, for example order webhooks will fire when a customer creates a new order, which could lead to a slow user experience.

1st October 2019