API Reference — subpackage_webhooks

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_webhooks
  description: 'API Reference — subpackage_webhooks. 7 operations. Lead operation: List Webhooks. Self-contained Naftiko capability
    covering one Polytomic business surface.'
  tags:
  - Polytomic
  - subpackage_webhooks
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    POLYTOMIC_API_KEY: POLYTOMIC_API_KEY
capability:
  consumes:
  - type: http
    namespace: polytomic-subpackage-webhooks
    baseUri: https://app.polytomic.com
    description: API Reference — subpackage_webhooks business capability. Self-contained, no shared references.
    resources:
    - name: api-webhooks
      path: /api/webhooks
      operations:
      - name: list
        method: GET
        description: List Webhooks
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
      - name: create
        method: POST
        description: Create Webhook
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-webhooks-id
      path: /api/webhooks/{id}
      operations:
      - name: get
        method: GET
        description: Get Webhook
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
      - name: update
        method: PUT
        description: Update Webhook
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: delete
        method: DELETE
        description: Delete Webhook
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
    - name: api-webhooks-id-disable
      path: /api/webhooks/{id}/disable
      operations:
      - name: disable
        method: POST
        description: Disable Webhook
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
    - name: api-webhooks-id-enable
      path: /api/webhooks/{id}/enable
      operations:
      - name: enable
        method: POST
        description: Enable Webhook
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
    authentication:
      type: bearer
      token: '{{env.POLYTOMIC_API_KEY}}'
  exposes:
  - type: rest
    namespace: polytomic-subpackage-webhooks-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_webhooks. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/webhooks
      name: api-webhooks
      description: REST surface for api-webhooks.
      operations:
      - method: GET
        name: list
        description: List Webhooks
        call: polytomic-subpackage-webhooks.list
        with:
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: create
        description: Create Webhook
        call: polytomic-subpackage-webhooks.create
        with:
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/webhooks/{id}
      name: api-webhooks-id
      description: REST surface for api-webhooks-id.
      operations:
      - method: GET
        name: get
        description: Get Webhook
        call: polytomic-subpackage-webhooks.get
        with:
          id: rest.id
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: update
        description: Update Webhook
        call: polytomic-subpackage-webhooks.update
        with:
          id: rest.id
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: Delete Webhook
        call: polytomic-subpackage-webhooks.delete
        with:
          id: rest.id
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/webhooks/{id}/disable
      name: api-webhooks-id-disable
      description: REST surface for api-webhooks-id-disable.
      operations:
      - method: POST
        name: disable
        description: Disable Webhook
        call: polytomic-subpackage-webhooks.disable
        with:
          id: rest.id
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/webhooks/{id}/enable
      name: api-webhooks-id-enable
      description: REST surface for api-webhooks-id-enable.
      operations:
      - method: POST
        name: enable
        description: Enable Webhook
        call: polytomic-subpackage-webhooks.enable
        with:
          id: rest.id
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: polytomic-subpackage-webhooks-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_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: polytomic-subpackage-webhooks.list
      with:
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.
    - name: create-webhook
      description: Create Webhook
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: polytomic-subpackage-webhooks.create
      with:
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-webhook
      description: Get Webhook
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: polytomic-subpackage-webhooks.get
      with:
        id: tools.id
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.
    - name: update-webhook
      description: Update Webhook
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: polytomic-subpackage-webhooks.update
      with:
        id: tools.id
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-webhook
      description: Delete Webhook
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: polytomic-subpackage-webhooks.delete
      with:
        id: tools.id
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.
    - name: disable-webhook
      description: Disable Webhook
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: polytomic-subpackage-webhooks.disable
      with:
        id: tools.id
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.
    - name: enable-webhook
      description: Enable Webhook
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: polytomic-subpackage-webhooks.enable
      with:
        id: tools.id
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.