Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partner Endpoints Webhook Event API

2 actions 2 updates phrasing extends openapi/hint-health-webhook-event-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 2

$.info

$.paths['/partner/webhook_events'].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 Partner Endpoints Webhook Event API
  version: 1.0.0
extends: openapi/hint-health-webhook-event-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['/partner/webhook_events'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhook event types
      effect: read
      questions:
      - Which webhook event types can my partner endpoint receive?
      - What event names are delivered for patient and invoice changes?
      instructions:
      - text: List all webhook event types.
      - text: Show the event names partner webhooks can deliver.
      method: generated
      generated: '2026-10-01'