Knock · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Knock Integrations API

3 actions 3 updates phrasing extends openapi/knock-app-integrations-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/integrations/census/custom-destination'].post
$.paths['/v1/integrations/hightouch/embedded-destination'].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 Integrations API
  version: 1.0.0
extends: openapi/knock-app-integrations-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/integrations/census/custom-destination'].post
  update:
    x-apievangelist-phrasing:
      intent: Handle a Census custom destination request
      effect: write
      questions:
      - How do I sync data from Census into Knock through the custom destination?
      - Which JSON-RPC fields does the Census destination endpoint expect?
      instructions:
      - text: Process Census RPC method {method} with request id {id} and jsonrpc {jsonrpc}.
        slots:
          method: requestBody.method
          id: requestBody.id
          jsonrpc: requestBody.jsonrpc
      - text: 'Forward this Census custom destination call: method {method}, id {id}, version {jsonrpc}.'
        slots:
          method: requestBody.method
          id: requestBody.id
          jsonrpc: requestBody.jsonrpc
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/integrations/hightouch/embedded-destination'].post
  update:
    x-apievangelist-phrasing:
      intent: Handle a Hightouch embedded destination request
      effect: write
      questions:
      - How do I push Hightouch syncs into Knock through the embedded destination?
      - What JSON-RPC payload does the Hightouch destination endpoint accept?
      instructions:
      - text: Process Hightouch RPC method {method} with request id {id} and jsonrpc {jsonrpc}.
        slots:
          method: requestBody.method
          id: requestBody.id
          jsonrpc: requestBody.jsonrpc
      - text: 'Forward this Hightouch embedded destination call: method {method}, id {id}, version {jsonrpc}.'
        slots:
          method: requestBody.method
          id: requestBody.id
          jsonrpc: requestBody.jsonrpc
      method: generated
      generated: '2026-10-01'