Webhooks

Webhooks let your WooCommerce store send automatic event notifications to a URL of your choice. This guide explains what webhooks are, how to create and manage them in WooCommerce, and how to review webhook logs for troubleshooting.

What are webhooks

↑ Back to top

A webhook is an event notification sent to a URL of your choice. You (or your developer) can configure a webhook that is triggered by events on one site to invoke behavior on another site.

Webhooks are useful for integrating your store with third-party services or other external APIs that support them.

Webhooks in WooCommerce

↑ Back to top

WooCommerce can trigger webhook notifications each time you add, edit, or delete orders, products, coupons, or customers, when purchases are made, and more.

Scope of support:

We are unable to provide support for customizations under our Support Policy. If you need to customize a snippet or extend its functionality, we recommend working with a Woo Agency Partner or a WooCommerce developer on Codeable.

You can also use webhooks with WooCommerce actions. For example, you can create a webhook that fires every time a product is added to the shopping cart by using the action woocommerce_add_to_cart.

Webhooks also enable third-party apps to integrate with WooCommerce.

Create a webhook

↑ Back to top

To create a new webhook, follow these steps:

Go to WooCommerce > Settings > Advanced > Webhooks.
Select Add webhook. The Webhook data form appears.

Fill in the following fields:
- Name — Enter a description for the webhook. If you leave this blank, the name defaults to “Webhook created on [date and time].” You can update the name later.
- Status — Set to Active to deliver notifications, Paused to stop delivery temporarily, or Disabled to stop delivery due to failures.
- Topic — Select the event that triggers the webhook. Options include events linked to coupons, customers, orders, products, and Action. Additional topics may appear depending on the extensions active on your site.
  - Custom Topic — This option is for advanced users only. You can introduce custom topics with the woocommerce_webhook_topic_hooks filter.
- Action Event — When you select Action as the topic, this field appears. Enter the action that triggers the webhook (for example, woocommerce_add_to_cart fires when a customer adds a product to the cart).
- Delivery URL — Enter the URL where the webhook payload is delivered.
- Secret — Enter a secret key used to generate a hash of the delivered webhook. The hash is included in the request headers. If you leave this blank, it defaults to the current API user’s consumer secret.
Click Save webhook.

Note: The first time you save a webhook with the Active status, WooCommerce sends a ping to the Delivery URL.

Automatic disabling

↑ Back to top

WooCommerce automatically disables a webhook after more than five consecutive delivery failures. A failure is any response that is not a 2xx, 301, or 302 HTTP status code. For example, 4xx or 5xx responses count as failures.

To increase or decrease the failure threshold, you can use the woocommerce_max_webhook_delivery_failures filter.

Edit and delete webhooks

↑ Back to top

You can edit or delete existing webhooks from the webhooks list at WooCommerce > Settings > Advanced > Webhooks.

Find the webhook you want to modify.
Hover over the webhook name to reveal the ID, Edit, and Delete permanently options.
Click Delete permanently to remove the webhook, or click Edit to update the webhook settings and then click Save webhook.

To delete multiple webhooks at once, select them using the checkboxes and choose Delete permanently from the Bulk actions dropdown.

Webhook logs

↑ Back to top

WooCommerce saves logs of all events that trigger a webhook. You can use these logs to verify delivery and review the response from the receiving server, which simplifies integration and debugging.

To view webhook logs:

Go to WooCommerce > Status > Logs.
If your site has many log files, select webhooks-delivery from the All sources dropdown to filter the list.
Use the search box in the top right to search the content of log files.

Questions and support

↑ Back to top

Do you still have questions and need assistance?

This documentation is about the free, core WooCommerce plugin, for which support is provided in our community forums on WordPress.org. By searching this forum, you’ll often find that your question has been asked and answered before.

If you haven’t created a WordPress.org account to use the forums, here’s how.

If you’re looking to extend the core functionality shown here, we recommend reviewing available extensions in the WooCommerce Marketplace.
Need ongoing advanced support or a customization built for WooCommerce? Hire a Woo Agency Partner.
Are you a developer building your own WooCommerce integration or extension? Check our Developer Resources.

If you weren’t able to find the information you need, please use the feedback thumbs below to let us know.