Shopify Admin REST API — Webhooks

naftiko: 1.0.0-alpha2
info:
  label: Shopify Admin REST API — Webhooks
  description: 'Shopify Admin REST API — Webhooks. 3 operations. Lead operation: List Webhooks. Self-contained Naftiko capability
    covering one Shopify Admin business surface.'
  tags:
  - Shopify Admin
  - Webhooks
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SHOPIFY_ADMIN_API_KEY: SHOPIFY_ADMIN_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-webhooks
    baseUri: https://{store_name}.myshopify.com/admin/api/2024-10
    description: Shopify Admin REST API — Webhooks business capability. Self-contained, no shared references.
    resources:
    - name: webhooks.json
      path: /webhooks.json
      operations:
      - name: listwebhooks
        method: GET
        description: List Webhooks
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createwebhook
        method: POST
        description: Create Webhook
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: webhooks-webhook_id}.json
      path: /webhooks/{webhook_id}.json
      operations:
      - name: deletewebhook
        method: DELETE
        description: Delete Webhook
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: webhook_id
          in: path
          type: integer
          description: The ID of the webhook
          required: true
    authentication:
      type: apikey
      key: X-Shopify-Access-Token
      value: '{{env.SHOPIFY_ADMIN_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: rest-webhooks-rest
    port: 8080
    description: REST adapter for Shopify Admin REST API — Webhooks. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/webhooks-json
      name: webhooks-json
      description: REST surface for webhooks.json.
      operations:
      - method: GET
        name: listwebhooks
        description: List Webhooks
        call: rest-webhooks.listwebhooks
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createwebhook
        description: Create Webhook
        call: rest-webhooks.createwebhook
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/webhooks/webhook-id-json
      name: webhooks-webhook-id-json
      description: REST surface for webhooks-webhook_id}.json.
      operations:
      - method: DELETE
        name: deletewebhook
        description: Delete Webhook
        call: rest-webhooks.deletewebhook
        with:
          webhook_id: rest.webhook_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-webhooks-mcp
    port: 9090
    transport: http
    description: MCP adapter for Shopify Admin REST API — Webhooks. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-webhooks
      description: List Webhooks
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-webhooks.listwebhooks
      outputParameters:
      - type: object
        mapping: $.
    - name: create-webhook
      description: Create Webhook
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-webhooks.createwebhook
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-webhook
      description: Delete Webhook
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-webhooks.deletewebhook
      with:
        webhook_id: tools.webhook_id
      outputParameters:
      - type: object
        mapping: $.