Encharge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Encharge Webhooks API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/event-subscriptions'].post
$.paths['/event-subscriptions/{id}'].delete

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 Encharge Webhooks API
  version: 1.0.0
extends: openapi/encharge-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: 2
- target: $.paths['/event-subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe a webhook to events
      effect: write
      questions:
      - How do I get notified at my URL when something happens in Encharge?
      - Which event types can I subscribe a webhook to?
      instructions:
      - text: Send {eventType} events to {url}.
        slots:
          eventType: requestBody.eventType
          url: requestBody.url
      - text: Create a webhook subscription for {eventType} posting to {url}.
        slots:
          eventType: requestBody.eventType
          url: requestBody.url
      method: generated
      generated: '2026-10-01'
- target: $.paths['/event-subscriptions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook subscription
      effect: destructive
      questions:
      - How do I stop sending events to a webhook?
      - Can I remove an event subscription I set up earlier?
      instructions:
      - text: Delete event subscription {id}.
        slots:
          id: path.id
      - text: Remove webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'