Knock API — Workflow recipient runs

naftiko: 1.0.0-alpha2
info:
  label: Knock API — Workflow recipient runs
  description: 'Knock API — Workflow recipient runs. 2 operations. Lead operation: List workflow recipient runs. Self-contained
    Naftiko capability covering one Knock business surface.'
  tags:
  - Knock
  - Workflow recipient runs
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    KNOCK_API_KEY: KNOCK_API_KEY
capability:
  consumes:
  - type: http
    namespace: knock-workflow-recipient-runs
    baseUri: https://api.knock.app
    description: Knock API — Workflow recipient runs business capability. Self-contained, no shared references.
    resources:
    - name: v1-workflow_recipient_runs
      path: /v1/workflow_recipient_runs
      operations:
      - name: listworkflowrecipientruns
        method: GET
        description: List workflow recipient runs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: after
          in: query
          type: string
          description: The cursor to fetch entries after.
        - name: before
          in: query
          type: string
          description: The cursor to fetch entries before.
        - name: page_size
          in: query
          type: integer
          description: The number of items per page (defaults to 50).
        - name: workflow
          in: query
          type: string
          description: Limits the results to workflow recipient runs for the given workflow key.
        - name: status[]
          in: query
          type: array
          description: Limits the results to workflow recipient runs with the given status.
        - name: tenant
          in: query
          type: string
          description: Limits the results to workflow recipient runs for the given tenant.
        - name: has_errors
          in: query
          type: boolean
          description: Limits the results to workflow recipient runs that have errors.
        - name: recipient
          in: query
          type: string
          description: Limits the results to workflow recipient runs for the given recipient. Accepts a user ID string or
            an object reference with `id` and `collection`.
        - name: starting_at
          in: query
          type: string
          description: Limits the results to workflow recipient runs started after the given date.
        - name: ending_at
          in: query
          type: string
          description: Limits the results to workflow recipient runs started before the given date.
    - name: v1-workflow_recipient_runs-id
      path: /v1/workflow_recipient_runs/{id}
      operations:
      - name: getworkflowrecipientrun
        method: GET
        description: Get a workflow recipient run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The unique identifier for the workflow recipient run (per-recipient).
          required: true
    authentication:
      type: bearer
      token: '{{env.KNOCK_API_KEY}}'
  exposes:
  - type: rest
    namespace: knock-workflow-recipient-runs-rest
    port: 8080
    description: REST adapter for Knock API — Workflow recipient runs. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/workflow-recipient-runs
      name: v1-workflow-recipient-runs
      description: REST surface for v1-workflow_recipient_runs.
      operations:
      - method: GET
        name: listworkflowrecipientruns
        description: List workflow recipient runs
        call: knock-workflow-recipient-runs.listworkflowrecipientruns
        with:
          after: rest.after
          before: rest.before
          page_size: rest.page_size
          workflow: rest.workflow
          status[]: rest.status[]
          tenant: rest.tenant
          has_errors: rest.has_errors
          recipient: rest.recipient
          starting_at: rest.starting_at
          ending_at: rest.ending_at
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/workflow-recipient-runs/{id}
      name: v1-workflow-recipient-runs-id
      description: REST surface for v1-workflow_recipient_runs-id.
      operations:
      - method: GET
        name: getworkflowrecipientrun
        description: Get a workflow recipient run
        call: knock-workflow-recipient-runs.getworkflowrecipientrun
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: knock-workflow-recipient-runs-mcp
    port: 9090
    transport: http
    description: MCP adapter for Knock API — Workflow recipient runs. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-workflow-recipient-runs
      description: List workflow recipient runs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: knock-workflow-recipient-runs.listworkflowrecipientruns
      with:
        after: tools.after
        before: tools.before
        page_size: tools.page_size
        workflow: tools.workflow
        status[]: tools.status[]
        tenant: tools.tenant
        has_errors: tools.has_errors
        recipient: tools.recipient
        starting_at: tools.starting_at
        ending_at: tools.ending_at
      outputParameters:
      - type: object
        mapping: $.
    - name: get-workflow-recipient-run
      description: Get a workflow recipient run
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: knock-workflow-recipient-runs.getworkflowrecipientrun
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.