Platform API — Webhooks

naftiko: 1.0.0-alpha2
info:
  label: Platform API — Webhooks
  description: 'Platform API — Webhooks. 4 operations. Lead operation: List webhook consumers. Self-contained Naftiko capability
    covering one Codat business surface.'
  tags:
  - Codat
  - Webhooks
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CODAT_API_KEY: CODAT_API_KEY
capability:
  consumes:
  - type: http
    namespace: platform-webhooks
    baseUri: https://api.codat.io
    description: Platform API — Webhooks business capability. Self-contained, no shared references.
    resources:
    - name: webhooks
      path: /webhooks
      operations:
      - name: listwebhookconsumers
        method: GET
        description: List webhook consumers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createwebhookconsumer
        method: POST
        description: Create webhook consumer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: webhooks-integrationKeys-zapier
      path: /webhooks/integrationKeys/zapier
      operations:
      - name: rotatezapierkey
        method: POST
        description: Rotate Zapier key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: webhooks-webhookId
      path: /webhooks/{webhookId}
      operations:
      - name: deletewebhookconsumer
        method: DELETE
        description: Delete webhook consumer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.CODAT_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: platform-webhooks-rest
    port: 8080
    description: REST adapter for 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: listwebhookconsumers
        description: List webhook consumers
        call: platform-webhooks.listwebhookconsumers
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createwebhookconsumer
        description: Create webhook consumer
        call: platform-webhooks.createwebhookconsumer
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/webhooks/integrationkeys/zapier
      name: webhooks-integrationkeys-zapier
      description: REST surface for webhooks-integrationKeys-zapier.
      operations:
      - method: POST
        name: rotatezapierkey
        description: Rotate Zapier key
        call: platform-webhooks.rotatezapierkey
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/webhooks/{webhookid}
      name: webhooks-webhookid
      description: REST surface for webhooks-webhookId.
      operations:
      - method: DELETE
        name: deletewebhookconsumer
        description: Delete webhook consumer
        call: platform-webhooks.deletewebhookconsumer
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: platform-webhooks-mcp
    port: 9090
    transport: http
    description: MCP adapter for Platform API — Webhooks. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-webhook-consumers
      description: List webhook consumers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-webhooks.listwebhookconsumers
      outputParameters:
      - type: object
        mapping: $.
    - name: create-webhook-consumer
      description: Create webhook consumer
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: platform-webhooks.createwebhookconsumer
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: rotate-zapier-key
      description: Rotate Zapier key
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: platform-webhooks.rotatezapierkey
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-webhook-consumer
      description: Delete webhook consumer
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: platform-webhooks.deletewebhookconsumer
      outputParameters:
      - type: object
        mapping: $.