PolyAPI Platform API — Webhooks

naftiko: 1.0.0-alpha2
info:
  label: PolyAPI Platform API — Webhooks
  description: 'PolyAPI Platform API — Webhooks. 6 operations. Lead operation: PolyAPI List webhooks. Self-contained Naftiko
    capability covering one Polyapi business surface.'
  tags:
  - Polyapi
  - Webhooks
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    POLYAPI_API_KEY: POLYAPI_API_KEY
capability:
  consumes:
  - type: http
    namespace: platform-webhooks
    baseUri: https://na1.polyapi.io
    description: PolyAPI Platform API — Webhooks business capability. Self-contained, no shared references.
    resources:
    - name: webhooks
      path: /webhooks
      operations:
      - name: listwebhooks
        method: GET
        description: PolyAPI List webhooks
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createwebhook
        method: POST
        description: PolyAPI 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-webhookId
      path: /webhooks/{webhookId}
      operations:
      - name: getwebhook
        method: GET
        description: PolyAPI Get a webhook
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatewebhook
        method: PATCH
        description: PolyAPI 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: PolyAPI Delete a webhook
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: webhooks-webhookId-trigger
      path: /webhooks/{webhookId}/trigger
      operations:
      - name: triggerwebhook
        method: POST
        description: PolyAPI Trigger a webhook
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.POLYAPI_API_KEY}}'
  exposes:
  - type: rest
    namespace: platform-webhooks-rest
    port: 8080
    description: REST adapter for PolyAPI Platform 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: PolyAPI List webhooks
        call: platform-webhooks.listwebhooks
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createwebhook
        description: PolyAPI Create a webhook
        call: platform-webhooks.createwebhook
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/webhooks/{webhookid}
      name: webhooks-webhookid
      description: REST surface for webhooks-webhookId.
      operations:
      - method: GET
        name: getwebhook
        description: PolyAPI Get a webhook
        call: platform-webhooks.getwebhook
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatewebhook
        description: PolyAPI Update a webhook
        call: platform-webhooks.updatewebhook
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletewebhook
        description: PolyAPI Delete a webhook
        call: platform-webhooks.deletewebhook
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/webhooks/{webhookid}/trigger
      name: webhooks-webhookid-trigger
      description: REST surface for webhooks-webhookId-trigger.
      operations:
      - method: POST
        name: triggerwebhook
        description: PolyAPI Trigger a webhook
        call: platform-webhooks.triggerwebhook
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: platform-webhooks-mcp
    port: 9090
    transport: http
    description: MCP adapter for PolyAPI Platform API — Webhooks. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: polyapi-list-webhooks
      description: PolyAPI List webhooks
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-webhooks.listwebhooks
      outputParameters:
      - type: object
        mapping: $.
    - name: polyapi-create-webhook
      description: PolyAPI Create a webhook
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: platform-webhooks.createwebhook
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: polyapi-get-webhook
      description: PolyAPI Get a webhook
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-webhooks.getwebhook
      outputParameters:
      - type: object
        mapping: $.
    - name: polyapi-update-webhook
      description: PolyAPI Update a webhook
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: platform-webhooks.updatewebhook
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: polyapi-delete-webhook
      description: PolyAPI Delete a webhook
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: platform-webhooks.deletewebhook
      outputParameters:
      - type: object
        mapping: $.
    - name: polyapi-trigger-webhook
      description: PolyAPI Trigger a webhook
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: platform-webhooks.triggerwebhook
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.