Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hint Health Global Webhook Endpoint API

6 actions 6 updates phrasing extends openapi/hint-health-globalwebhookendpoint-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/global_webhook_endpoints'].get

$.paths['/global_webhook_endpoints'].post

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

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

$.paths['/global_webhook_endpoints/{id}'].patch

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 Hint Health Global Webhook Endpoint API
  version: 1.0.0
extends: openapi/hint-health-globalwebhookendpoint-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: 5
- target: $.paths['/global_webhook_endpoints'].get
  update:
    x-apievangelist-phrasing:
      intent: List global webhook endpoints (legacy)
      effect: read
      questions:
      - Which global webhook endpoints are registered across all my integrations?
      - Where can I see the legacy global webhook URLs?
      instructions:
      - text: List all global webhook endpoints.
      - text: Show every legacy global webhook URL.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/global_webhook_endpoints'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a global webhook endpoint (legacy)
      effect: write
      questions:
      - How do I add a global webhook URL that is not tied to one integration?
      - Can I register a legacy global webhook endpoint?
      instructions:
      - text: Create a global webhook endpoint at {webhook_url}.
        slots:
          webhook_url: requestBody.webhook_url
      - text: Register {webhook_url} as a global webhook.
        slots:
          webhook_url: requestBody.webhook_url
      method: generated
      generated: '2026-10-01'
- target: $.paths['/global_webhook_endpoints/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one global webhook endpoint (legacy)
      effect: read
      questions:
      - Can I look up a single global webhook endpoint by id?
      - Where is a given global webhook endpoint delivering to?
      instructions:
      - text: Show global webhook endpoint {id}.
        slots:
          id: path.id
      - text: Get the URL of global webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/global_webhook_endpoints/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a global webhook endpoint (legacy)
      effect: destructive
      questions:
      - Does deleting a global webhook endpoint cancel deliveries still pending or retrying?
      - Is there a way to remove a global webhook endpoint?
      instructions:
      - text: Delete global webhook endpoint {id}.
        slots:
          id: path.id
      - text: Remove global webhook {id} and cancel its pending deliveries.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/global_webhook_endpoints/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a global webhook endpoint URL (legacy)
      effect: write
      questions:
      - How do I change the URL of a global webhook endpoint?
      - Can I edit a global webhook rather than deleting and recreating it?
      instructions:
      - text: Point global webhook endpoint {id} at {webhook_url}.
        slots:
          id: path.id
          webhook_url: requestBody.webhook_url
      - text: Update the URL of global webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'