WooCommerce · Schema

WebhookInput

Input for creating or updating a webhook.

eCommerceOpen SourceOrdersProductsWordPress

Properties

Name	Type	Description
name	string	Friendly webhook name.
status	string	Webhook status.
topic	string	Event topic that triggers the webhook (e.g. order.created).
delivery_url	string	URL to receive POST notifications.
secret	string	Secret key used to generate the HMAC-SHA256 payload signature included in the X-WC-Webhook-Signature header.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/woocommerce/refs/heads/main/json-schema/woocommerce-rest-api-webhook-input-schema.json",
  "title": "WebhookInput",
  "description": "Input for creating or updating a webhook.",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Friendly webhook name.",
      "example": "Example Name"
    },
    "status": {
      "type": "string",
      "description": "Webhook status.",
      "enum": [
        "active",
        "paused",
        "disabled"
      ],
      "example": "active"
    },
    "topic": {
      "type": "string",
      "description": "Event topic that triggers the webhook (e.g. order.created).",
      "example": "string-value"
    },
    "delivery_url": {
      "type": "string",
      "format": "uri",
      "description": "URL to receive POST notifications.",
      "example": "https://example.com/path"
    },
    "secret": {
      "type": "string",
      "description": "Secret key used to generate the HMAC-SHA256 payload signature included in the X-WC-Webhook-Signature header.",
      "example": "string-value"
    }
  }
}