Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Webhooks API

6 actions 6 updates phrasing extends openapi/close-webhooks-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 6

$.info

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

$.paths['/webhook/'].post

$.paths['/webhook/{id}/'].get

$.paths['/webhook/{id}/'].put

$.paths['/webhook/{id}/'].delete

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 Webhooks API
  version: 1.0.0
extends: openapi/close-webhooks-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: 5
- target: $.paths['/webhook/'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhook subscriptions
      effect: read
      questions:
      - Which webhooks are set up for our organization?
      - Where can I see every webhook subscription?
      instructions:
      - text: List our webhook subscriptions.
      - text: Show all webhooks configured for the organization.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhook/'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe a URL to CRM events
      effect: write
      questions:
      - How do I get notified when a lead is created or updated?
      - Can I turn off SSL verification for a webhook endpoint?
      instructions:
      - text: Create a webhook sending {events} to {url}.
        slots:
          events: requestBody.events
          url: requestBody.url
      - text: Subscribe {url} to lead and opportunity events.
        slots:
          url: requestBody.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhook/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webhook subscription
      effect: read
      questions:
      - How do I check which events one webhook listens for?
      - Is a particular webhook subscription active or paused?
      instructions:
      - text: Show webhook subscription {id}.
        slots:
          id: path.id
      - text: Fetch the events and URL of webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhook/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update or pause a webhook
      effect: write
      questions:
      - Can I pause a webhook without deleting it?
      - How do I change the events a webhook subscribes to?
      instructions:
      - text: Set the status of webhook {id} to {status}.
        slots:
          id: path.id
          status: requestBody.status
      - text: Change webhook {id} to deliver to {url}.
        slots:
          id: path.id
          url: requestBody.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhook/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook subscription
      effect: destructive
      questions:
      - What's the way to stop receiving webhook events for good?
      - Can I delete a webhook subscription?
      instructions:
      - text: Delete webhook {id}.
        slots:
          id: path.id
      - text: Remove webhook subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'