Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hint Health Webhook Endpoint API

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

$.info
$.paths['/integrations/{integration_id}/webhook_endpoints'].get
$.paths['/integrations/{integration_id}/webhook_endpoints'].post
$.paths['/integrations/{integration_id}/webhook_endpoints/{id}'].get
$.paths['/integrations/{integration_id}/webhook_endpoints/{id}'].delete
$.paths['/integrations/{integration_id}/webhook_endpoints/{id}'].patch
$.paths['/partner/webhook_endpoints'].get
$.paths['/partner/webhook_endpoints/{id}'].delete
$.paths['/partner/webhook_endpoints/{id}'].patch

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 Hint Health Webhook Endpoint API
  version: 1.0.0
extends: openapi/hint-health-webhook-endpoint-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: 8
- target: $.paths['/integrations/{integration_id}/webhook_endpoints'].get
  update:
    x-apievangelist-phrasing:
      intent: List an integration's webhook endpoints (legacy)
      effect: read
      questions:
      - Which webhook URLs are registered on one of my integrations under the older integration endpoints?
      - How can I see the legacy per-integration webhook endpoints?
      instructions:
      - text: List the legacy webhook endpoints on integration {integration_id}.
        slots:
          integration_id: path.integration_id
      - text: Show every webhook URL registered for integration {integration_id}.
        slots:
          integration_id: path.integration_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/integrations/{integration_id}/webhook_endpoints'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a webhook endpoint to an integration (legacy)
      effect: write
      questions:
      - Can I register a webhook URL on one specific integration through the legacy endpoint?
      - Can an integration send its events to an additional URL?
      instructions:
      - text: Add webhook URL {webhook_url} to integration {integration_id}.
        slots:
          webhook_url: requestBody.webhook_url
          integration_id: path.integration_id
      - text: Register {webhook_url} as a legacy webhook endpoint on integration {integration_id}.
        slots:
          webhook_url: requestBody.webhook_url
          integration_id: path.integration_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/integrations/{integration_id}/webhook_endpoints/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one integration webhook endpoint (legacy)
      effect: read
      questions:
      - What are the details of one webhook endpoint that belongs to an integration?
      - What URL is a particular legacy integration webhook endpoint pointing at?
      instructions:
      - text: Show webhook endpoint {id} on integration {integration_id}.
        slots:
          id: path.id
          integration_id: path.integration_id
      - text: Get details of legacy integration webhook {id} for integration {integration_id}.
        slots:
          id: path.id
          integration_id: path.integration_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/integrations/{integration_id}/webhook_endpoints/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an integration webhook endpoint (legacy)
      effect: destructive
      questions:
      - What happens to pending and retrying webhooks when I delete an integration's endpoint?
      - Can I remove a webhook URL from an integration under the legacy routes?
      instructions:
      - text: Delete webhook endpoint {id} from integration {integration_id}.
        slots:
          id: path.id
          integration_id: path.integration_id
      - text: Remove legacy integration webhook {id} on integration {integration_id} and stop its pending deliveries.
        slots:
          id: path.id
          integration_id: path.integration_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/integrations/{integration_id}/webhook_endpoints/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an integration webhook URL (legacy)
      effect: write
      questions:
      - Is it possible to point an existing integration webhook endpoint at a new URL?
      - Can I edit a legacy integration webhook instead of recreating it?
      instructions:
      - text: Change webhook endpoint {id} on integration {integration_id} to {webhook_url}.
        slots:
          id: path.id
          integration_id: path.integration_id
          webhook_url: requestBody.webhook_url
      - text: Update the URL of legacy integration webhook {id} for integration {integration_id}.
        slots:
          id: path.id
          integration_id: path.integration_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/webhook_endpoints'].get
  update:
    x-apievangelist-phrasing:
      intent: List partner webhook endpoints
      effect: read
      questions:
      - Which webhook endpoints are set up on my partner account?
      - Can I filter my partner webhook endpoints by URL or by when they last received a delivery?
      - Is there pagination for partner-level webhook endpoints?
      instructions:
      - text: List my partner webhook endpoints.
      - text: Find partner webhook endpoints with URL {webhook_url}.
        slots:
          webhook_url: query.webhook_url
      - text: List partner webhook endpoints last delivered at {last_delivered_at}, {limit} per page.
        slots:
          last_delivered_at: query.last_delivered_at
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/webhook_endpoints/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a partner webhook endpoint
      effect: destructive
      questions:
      - Can I remove a webhook endpoint from my partner account?
      - Can I stop sending partner webhooks to a URL I no longer use?
      instructions:
      - text: Delete partner webhook endpoint {id}.
        slots:
          id: path.id
      - text: Remove partner-level webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/webhook_endpoints/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a partner webhook endpoint URL
      effect: write
      questions:
      - How do I change where a partner webhook endpoint delivers?
      - Can I update the URL on a partner webhook endpoint in place?
      instructions:
      - text: Set partner webhook endpoint {id} to deliver to {webhook_url}.
        slots:
          id: path.id
          webhook_url: requestBody.webhook_url
      - text: Update the URL on partner webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'