WooCommerce REST API — Webhooks

naftiko: 1.0.0-alpha2
info:
  label: WooCommerce REST API — Webhooks
  description: 'WooCommerce REST API — Webhooks. 5 operations. Lead operation: WooCommerce List All Webhooks. Self-contained
    Naftiko capability covering one Woocommerce business surface.'
  tags:
  - Woocommerce
  - Webhooks
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WOOCOMMERCE_API_KEY: WOOCOMMERCE_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-webhooks
    baseUri: https://example.com/wp-json/wc/v3
    description: WooCommerce REST API — Webhooks business capability. Self-contained, no shared references.
    resources:
    - name: webhooks
      path: /webhooks
      operations:
      - name: listwebhooks
        method: GET
        description: WooCommerce List All Webhooks
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: status
          in: query
          type: string
          description: 'Filter webhooks by status. Options: all, active, paused, disabled.'
      - name: createwebhook
        method: POST
        description: WooCommerce Create a Webhook
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: webhooks-id
      path: /webhooks/{id}
      operations:
      - name: getwebhook
        method: GET
        description: WooCommerce Retrieve a Webhook
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatewebhook
        method: PUT
        description: WooCommerce Update a Webhook
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletewebhook
        method: DELETE
        description: WooCommerce Delete a Webhook
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: basic
      username: '{{env.WOOCOMMERCE_USER}}'
      password: '{{env.WOOCOMMERCE_PASS}}'
  exposes:
  - type: rest
    namespace: rest-webhooks-rest
    port: 8080
    description: REST adapter for WooCommerce REST API — Webhooks. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/webhooks
      name: webhooks
      description: REST surface for webhooks.
      operations:
      - method: GET
        name: listwebhooks
        description: WooCommerce List All Webhooks
        call: rest-webhooks.listwebhooks
        with:
          status: rest.status
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createwebhook
        description: WooCommerce Create a Webhook
        call: rest-webhooks.createwebhook
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/webhooks/{id}
      name: webhooks-id
      description: REST surface for webhooks-id.
      operations:
      - method: GET
        name: getwebhook
        description: WooCommerce Retrieve a Webhook
        call: rest-webhooks.getwebhook
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatewebhook
        description: WooCommerce Update a Webhook
        call: rest-webhooks.updatewebhook
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletewebhook
        description: WooCommerce Delete a Webhook
        call: rest-webhooks.deletewebhook
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-webhooks-mcp
    port: 9090
    transport: http
    description: MCP adapter for WooCommerce REST API — Webhooks. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: woocommerce-list-all-webhooks
      description: WooCommerce List All Webhooks
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-webhooks.listwebhooks
      with:
        status: tools.status
      outputParameters:
      - type: object
        mapping: $.
    - name: woocommerce-create-webhook
      description: WooCommerce Create a Webhook
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-webhooks.createwebhook
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: woocommerce-retrieve-webhook
      description: WooCommerce Retrieve a Webhook
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-webhooks.getwebhook
      outputParameters:
      - type: object
        mapping: $.
    - name: woocommerce-update-webhook
      description: WooCommerce Update a Webhook
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-webhooks.updatewebhook
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: woocommerce-delete-webhook
      description: WooCommerce Delete a Webhook
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-webhooks.deletewebhook
      outputParameters:
      - type: object
        mapping: $.