Gainsight · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gainsight CS Events API

4 actions 4 updates phrasing extends openapi/gainsight-events-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 4

$.info

$.paths['/events'].post

$.paths['/events/bulk'].post

$.paths['/events/types'].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 Gainsight CS Events API
  version: 1.0.0
extends: openapi/gainsight-events-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: 3
- target: $.paths['/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish an external event
      effect: write
      questions:
      - How do I push an event from another system into Gainsight to trigger rules?
      - Can I tie a published event to a specific company?
      instructions:
      - text: Publish a {eventType} event for object {objectType} with operation {operation} and payload {payload}.
        slots:
          eventType: requestBody.eventType
          objectType: requestBody.objectType
          operation: requestBody.operation
          payload: requestBody.payload
      - text: Send event {eventType} on {objectType} ({operation}) for company {companyId} with data {payload}.
        slots:
          eventType: requestBody.eventType
          objectType: requestBody.objectType
          operation: requestBody.operation
          companyId: requestBody.companyId
          payload: requestBody.payload
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish events in bulk
      effect: write
      questions:
      - Can I publish many external events in a single request?
      - Is there a batch endpoint for sending events into Gainsight?
      instructions:
      - text: 'Publish this batch of events: {records}.'
        slots:
          records: requestBody.records
      - text: Bulk send events {records} in one call.
        slots:
          records: requestBody.records
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/types'].get
  update:
    x-apievangelist-phrasing:
      intent: List event types
      effect: read
      questions:
      - What event types are configured for publishing?
      - Which eventType values will Gainsight accept?
      instructions:
      - text: List the configured event types.
      - text: Show every event type I can publish.
      method: generated
      generated: '2026-09-26'