Gainsight · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gainsight PX Subscription API

3 actions 3 updates phrasing extends openapi/gainsight-subscription-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/subscriptions'].get

$.paths['/subscriptions'].post

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 Gainsight PX Subscription API
  version: 1.0.0
extends: openapi/gainsight-subscription-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: 2
- target: $.paths['/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List event webhook subscriptions
      effect: read
      questions:
      - What webhook subscriptions are set up for events?
      - Where are my event callbacks being delivered?
      instructions:
      - text: List my event subscriptions.
      - text: Show every configured webhook subscription.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe a webhook to events
      effect: write
      questions:
      - How do I get Gainsight events pushed to my own URL?
      - Can I subscribe a callback to one event type?
      instructions:
      - text: Subscribe {callbackUrl} to {eventType} events as {name}.
        slots:
          callbackUrl: requestBody.callbackUrl
          eventType: requestBody.eventType
          name: requestBody.name
      - text: Create webhook subscription {name} for event type {eventType} to {callbackUrl}.
        slots:
          name: requestBody.name
          eventType: requestBody.eventType
          callbackUrl: requestBody.callbackUrl
      method: generated
      generated: '2026-09-26'