Hilt · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hilt So Integrations API

5 actions 5 updates phrasing extends openapi/hilt-so-integrations-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/v1/integrations/health'].get

$.paths['/v1/integrations/events'].get

$.paths['/v1/integrations/zapier/hooks'].post

$.paths['/v1/integrations/zapier/hooks/{endpoint_id}'].delete

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 Hilt So Integrations API
  version: 1.0.0
extends: openapi/hilt-so-integrations-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/v1/integrations/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check integration connection health
      effect: read
      questions:
      - Are my integrations connected and healthy?
      - Is my Zapier connection working?
      instructions:
      - text: Check my integration health.
      - text: Show integration connection status.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/integrations/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List events emitted to integrations
      effect: read
      questions:
      - Which events have been sent out to my integrations recently?
      - Can I filter integration events by type?
      instructions:
      - text: List integration events of type {event_type}.
        slots:
          event_type: query.event_type
      - text: Show the last {limit} integration events.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/integrations/zapier/hooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe a Zapier REST hook
      effect: write
      questions:
      - How do I send Hilt payment events to a Zap?
      - Can a Zapier hook be limited to certain products?
      instructions:
      - text: Subscribe Zapier hook {target_url} to {event_type}.
        slots:
          target_url: requestBody.target_url
          event_type: requestBody.event_type
      - text: Add a Zapier hook at {target_url} for products {product_ids}.
        slots:
          target_url: requestBody.target_url
          product_ids: requestBody.product_ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/integrations/zapier/hooks/{endpoint_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe a Zapier REST hook
      effect: destructive
      questions:
      - How do I stop a Zap from receiving Hilt events?
      - What happens when I turn off a Zapier hook?
      instructions:
      - text: Unsubscribe Zapier hook {endpoint_id}.
        slots:
          endpoint_id: path.endpoint_id
      - text: Remove the Zapier subscription {endpoint_id}.
        slots:
          endpoint_id: path.endpoint_id
      method: generated
      generated: '2026-09-26'