WooCommerce · JSON Structure

Woocommerce Rest Api Webhook Structure

A WooCommerce webhook configuration.

Type: object Properties: 9
eCommerceOpen SourceOrdersProductsWordPress

Webhook is a JSON Structure definition published by WooCommerce, describing 9 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id name status topic resource event delivery_url date_created date_modified

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/woocommerce/refs/heads/main/json-structure/woocommerce-rest-api-webhook-structure.json",
  "name": "Webhook",
  "description": "A WooCommerce webhook configuration.",
  "type": "object",
  "properties": {
    "id": {
      "type": "int32",
      "description": "Webhook unique identifier.",
      "example": 1
    },
    "name": {
      "type": "string",
      "description": "Friendly name for the webhook.",
      "example": "Example Name"
    },
    "status": {
      "type": "string",
      "description": "Webhook status. Options: active, paused, disabled.",
      "enum": [
        "active",
        "paused",
        "disabled"
      ],
      "example": "active"
    },
    "topic": {
      "type": "string",
      "description": "Webhook topic that determines which events trigger the webhook (e.g. order.created, product.updated).",
      "example": "string-value"
    },
    "resource": {
      "type": "string",
      "description": "Resource type associated with the topic (e.g. order, product).",
      "example": "string-value"
    },
    "event": {
      "type": "string",
      "description": "Event action associated with the topic (e.g. created, updated).",
      "example": "string-value"
    },
    "delivery_url": {
      "type": "uri",
      "description": "URL that receives the webhook HTTP POST payload.",
      "example": "https://example.com/path"
    },
    "date_created": {
      "type": "datetime",
      "description": "Date the webhook was created.",
      "example": "2026-05-03T14:30:00Z"
    },
    "date_modified": {
      "type": "datetime",
      "description": "Date the webhook was last modified.",
      "example": "2026-05-03T14:30:00Z"
    }
  }
}