Cogny · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cogny Webhooks API

2 actions 2 updates phrasing extends openapi/cogny-webhooks-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Cogny's API. It is a proposal applied on top of the contract, not a document Cogny publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/webhooks'].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 Cogny Webhooks API
  version: 1.0.0
extends: openapi/cogny-webhooks-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: 1
- target: $.paths['/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe a URL to webhook events
      effect: write
      questions:
      - How do I get notified at my own endpoint when something happens in Cogny?
      - Can I choose which events a webhook subscription receives?
      instructions:
      - text: Create a webhook that sends events to {url}.
        slots:
          url: requestBody.url
      - text: Subscribe {url} to the events {events}.
        slots:
          url: requestBody.url
          events: requestBody.events
      method: generated
      generated: '2026-10-01'