WooCommerce · JSON Structure

Woocommerce Rest Api Webhook Input Structure

Input for creating or updating a webhook.

Type: object Properties: 5
E-CommerceOpen-SourceOrderProductWordPress

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

Properties

name status topic delivery_url secret

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-input-structure.json",
  "name": "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": "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 Structure 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 json structure

4 MCP tools reach this
  • find_json_structuresBrowse and filter every JSON Structure 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 Structure
curl "https://apis.io/api/v1/json-structures/woocommerce-rest-api-webhook-input-structure"
All json structure
curl "https://apis.io/api/v1/json-structures?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.