WooCommerce · Schema

WebhookInput

Input for creating or updating a webhook.

E-CommerceOpen-SourceOrderProductWordPress

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

woocommerce-rest-api-webhook-input-schema.json Raw ↑
{
  "$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"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/woocommerce-rest-api-webhook-input"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.