Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partner Endpoints Installation Webhook Endpoints API

5 actions 5 updates phrasing extends openapi/hint-health-installationwebhookendpoints-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 5

$.info

$.paths['/partner/installations/{installation_id}/webhook_endpoints'].get

$.paths['/partner/installations/{installation_id}/webhook_endpoints'].post

$.paths['/partner/installations/{installation_id}/webhook_endpoints/{id}'].delete

$.paths['/partner/installations/{installation_id}/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 Partner Endpoints Installation Webhook Endpoints API
  version: 1.0.0
extends: openapi/hint-health-installationwebhookendpoints-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: 4
- target: $.paths['/partner/installations/{installation_id}/webhook_endpoints'].get
  update:
    x-apievangelist-phrasing:
      intent: List an installation's webhook endpoints
      effect: read
      questions:
      - Which webhook endpoints are registered for a product installation at a practice?
      - Do installs of the same practice's products share webhook endpoints?
      - Can I filter installation webhook endpoints by URL?
      instructions:
      - text: List webhook endpoints for installation {installation_id}.
        slots:
          installation_id: path.installation_id
      - text: Find webhook endpoints on installation {installation_id} with URL {webhook_url}.
        slots:
          installation_id: path.installation_id
          webhook_url: query.webhook_url
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/installations/{installation_id}/webhook_endpoints'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a webhook endpoint to an installation
      effect: write
      questions:
      - How do I register a webhook URL for one product installation?
      - Can a practice installation send events to my URL?
      instructions:
      - text: Add webhook URL {webhook_url} to installation {installation_id}.
        slots:
          webhook_url: requestBody.webhook_url
          installation_id: path.installation_id
      - text: Register {webhook_url} as a webhook on installation {installation_id}.
        slots:
          webhook_url: requestBody.webhook_url
          installation_id: path.installation_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/installations/{installation_id}/webhook_endpoints/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an installation webhook endpoint
      effect: destructive
      questions:
      - How do I remove a webhook endpoint from a product installation?
      - Can I stop an installation from posting to an old URL?
      instructions:
      - text: Delete webhook endpoint {id} from installation {installation_id}.
        slots:
          id: path.id
          installation_id: path.installation_id
      - text: Remove installation {installation_id}'s webhook {id}.
        slots:
          id: path.id
          installation_id: path.installation_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/installations/{installation_id}/webhook_endpoints/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an installation webhook URL
      effect: write
      questions:
      - How do I change the URL of a webhook on a product installation?
      - Can I edit an installation webhook endpoint in place?
      instructions:
      - text: Point installation {installation_id}'s webhook {id} at {webhook_url}.
        slots:
          installation_id: path.installation_id
          id: path.id
          webhook_url: requestBody.webhook_url
      - text: Update webhook endpoint {id} on installation {installation_id}.
        slots:
          id: path.id
          installation_id: path.installation_id
      method: generated
      generated: '2026-10-01'