Knock · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Knock Workflows Workflow recipient runs API

3 actions 3 updates phrasing extends openapi/knock-app-workflow-recipient-runs-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Knock's API. It is a proposal applied on top of the contract, not a document Knock publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/v1/workflow_recipient_runs/{id}'].get

$.paths['/v1/workflow_recipient_runs'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Knock Workflows Workflow recipient runs API
  version: 1.0.0
extends: openapi/knock-app-workflow-recipient-runs-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/v1/workflow_recipient_runs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workflow run for one recipient
      effect: read
      questions:
      - How do I debug what happened when a workflow ran for one recipient?
      - Can I see the events of a single recipient run?
      instructions:
      - text: Get workflow recipient run {id}.
        slots:
          id: path.id
      - text: Show the events of recipient run {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/workflow_recipient_runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List workflow recipient runs
      effect: read
      questions:
      - Which workflow runs errored for recipients recently?
      - Can I filter recipient runs by workflow, status or recipient?
      instructions:
      - text: List workflow recipient runs.
      - text: List recipient runs of workflow {workflow} with errors {has_errors}.
        slots:
          workflow: query.workflow
          has_errors: query.has_errors
      - text: Show runs for recipient {recipient} between {starting_at} and {ending_at}.
        slots:
          recipient: query.recipient
          starting_at: query.starting_at
          ending_at: query.ending_at
      method: generated
      generated: '2026-10-01'