Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

WooCommerce Webhook Events

WooCommerce delivers real-time event notifications via HTTP POST webhooks for orders, products, customers, coupons, and subscriptions lifecycle changes. Webhooks are configured in the WooCommerce admin or via the REST API and deliver JSON payloads signed with HMAC-SHA256.

WooCommerce Webhook Events is one of 21 APIs that WooCommerce publishes on the APIs.io network, described by an AsyncAPI event-driven specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Events and Webhooks. The published artifact set on APIs.io includes API documentation, an AsyncAPI specification, and 1 JSON Schema.

This event API exposes 1 operation across 1 channel, and defines 22 schemas. It is described by AsyncAPI 2.6.0, at version v3.

The API connects through a single server, https://{store-domain} (https).

1 operations 1 channels 22 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
v3
Server
https://{store-domain} (https)
Resource Areas
1

Channels & Operations 1

Across 1 channel, the API surfaces 1 operation. Each is listed below with its action, channel, parameters, and response codes.

Channels 1
PUB
/webhook
Receive a WooCommerce webhook event notification
receiveWebhookEvent body

Messages & Schemas 22

The contract defines 22 schemas that model the data carried by its messages. The most detailed are OrderPayload (21 properties), ProductPayload (18 properties), CouponPayload (16 properties), CustomerPayload (14 properties). Each schema is shown below with its type and property counts.

OrderCreated
message
Triggered when a new order is placed in the store.
OrderUpdated
message
Triggered when an existing order is modified.
OrderDeleted
message
Triggered when an order is moved to the trash.
OrderRestored
message
Triggered when an order is recovered from the trash.
ProductCreated
message
Triggered when a new product is published or saved in the store.
ProductUpdated
message
Triggered when an existing product is modified.
ProductDeleted
message
Triggered when a product is moved to the trash.
ProductRestored
message
Triggered when a product is recovered from the trash.
CustomerCreated
message
Triggered when a new customer account is registered.
CustomerUpdated
message
Triggered when a customer account is modified.
CustomerDeleted
message
Triggered when a customer account is deleted.
CouponCreated
message
Triggered when a new coupon is created.
CouponUpdated
message
Triggered when a coupon is modified.
CouponDeleted
message
Triggered when a coupon is moved to the trash.
CouponRestored
message
Triggered when a coupon is recovered from the trash.
CustomAction
message
Triggered by a custom WordPress or WooCommerce action hook.
Address
object
Billing or shipping address.
11 properties
MetaData
object
Custom metadata key-value entry.
3 properties
OrderPayload
object
Order webhook payload mirroring the WooCommerce REST API v3 order resource.
21 properties
ProductPayload
object
Product webhook payload mirroring the WooCommerce REST API v3 product resource.
18 properties
CustomerPayload
object
Customer webhook payload mirroring the WooCommerce REST API v3 customer resource.
14 properties
CouponPayload
object
Coupon webhook payload mirroring the WooCommerce REST API v3 coupon resource.
16 properties

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

woocommerce-webhooks-asyncapi.yml Raw ↑

Other APIs WooCommerce publishes across the network.

WooCommerce GraphQL API
WooCommerce Cart API
WooCommerce Checkout API
WooCommerce Coupons API
WooCommerce Customers API
WooCommerce Order Notes API
WooCommerce Order Refunds API
WooCommerce Orders API
WooCommerce Payment Gateways API
WooCommerce Product Attributes API
WooCommerce Product Categories API
WooCommerce Product Reviews API