Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partner Endpoints Webhook Request API

2 actions 2 updates phrasing extends openapi/hint-health-webhookrequest-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_requests'].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 Request API
  version: 1.0.0
extends: openapi/hint-health-webhookrequest-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_requests'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhook delivery attempts
      effect: read
      questions:
      - Which webhook deliveries failed or are still retrying?
      - Can I filter webhook requests by event type or endpoint?
      - How many attempts did a webhook delivery take?
      instructions:
      - text: List webhook requests with status {status}.
        slots:
          status: query.status
      - text: Show webhook requests for event type {event_type} sent to endpoint {webhook_endpoint}.
        slots:
          event_type: query.event_type
          webhook_endpoint: query.webhook_endpoint
      - text: List webhook requests with {attempts} delivery attempts.
        slots:
          attempts: query.attempts
      method: generated
      generated: '2026-10-01'