Knock · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Knock Notify Workflow Triggers API

3 actions 3 updates phrasing extends openapi/knock-app-workflow-triggers-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/notify/cancel'].post
$.paths['/v1/notify'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Knock Notify Workflow Triggers API
  version: 1.0.0
extends: openapi/knock-app-workflow-triggers-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/notify/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a triggered workflow via notify
      effect: destructive
      questions:
      - How do I cancel a notification I triggered through the notify endpoint?
      - Can I stop a queued workflow using its cancellation key on the notify surface?
      instructions:
      - text: Cancel the notify-triggered workflow with my cancellation key.
      - text: Stop a pending notify workflow run by its cancellation key.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/notify'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger a workflow via notify
      effect: write
      questions:
      - How do I send a notification through the notify endpoint?
      - Can I trigger a workflow with an actor and recipients from the notify surface?
      instructions:
      - text: Trigger a workflow through notify for my recipients.
      - text: Fire a notify workflow with an actor, recipients and data.
      method: generated
      generated: '2026-10-01'