Stripe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stripe Events API

3 actions 3 updates phrasing extends openapi/stripe-events-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Stripe's API. It is a proposal applied on top of the contract, not a document Stripe publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/v1/events'].get
$.paths['/v1/events/{id}'].get

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 Stripe Events API
  version: 1.0.0
extends: openapi/stripe-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: 2
- target: $.paths['/v1/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List account events
      effect: read
      questions:
      - How do I see what happened on my account recently?
      - How far back can I list events?
      - Can I find events whose webhooks failed to deliver?
      instructions:
      - text: List recent events.
      - text: List events of type {type}.
        slots:
          type: query.type
      - text: Show events where webhook delivery success is {delivery_success}.
        slots:
          delivery_success: query.delivery_success
      - text: List events of types {types} created in {created}.
        slots:
          types: query.types
          created: query.created
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/events/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an event
      effect: read
      questions:
      - How do I fetch the full event behind a webhook I received?
      - What data did this event carry?
      instructions:
      - text: Show event {id}.
        slots:
          id: path.id
      - text: Fetch webhook event {id} to verify it.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'