Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Events API

3 actions 3 updates phrasing extends openapi/close-events-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/event/'].get

$.paths['/event/{id}/'].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 Close Events API
  version: 1.0.0
extends: openapi/close-events-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/event/'].get
  update:
    x-apievangelist-phrasing:
      intent: List events from the change log
      effect: read
      questions:
      - What changed on a lead recently?
      - Can I poll for events updated after a certain time?
      instructions:
      - text: List events for lead {lead_id}.
        slots:
          lead_id: query.lead_id
      - text: Show {action} events on {object_type} objects.
        slots:
          action: query.action
          object_type: query.object_type
      - text: List events updated after {date_updated__gt}.
        slots:
          date_updated__gt: query.date_updated__gt
      method: generated
      generated: '2026-09-26'
- target: $.paths['/event/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single event
      effect: read
      questions:
      - How do I look up one event in the change log?
      - What data does a single event contain?
      instructions:
      - text: Show event {id}.
        slots:
          id: path.id
      - text: Fetch event log entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'