# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Stripe Webhook Webhook Endpoints API
  version: 1.0.0
extends: openapi/stripe-webhook-endpoints-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: 5
- target: $.paths['/v1/webhook_endpoints'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhook endpoints
      effect: read
      questions:
      - Which URLs am I sending webhook events to?
      - How do I see all my webhook endpoints?
      instructions:
      - text: List my webhook endpoints.
      - text: Show the first {limit} webhook endpoints.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/webhook_endpoints'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a webhook endpoint
      effect: write
      questions:
      - How do I get notified at my server when a payment succeeds?
      - Can one webhook endpoint receive events from all my connected accounts?
      - Can I subscribe a webhook to every event type?
      instructions:
      - text: Send {enabled_events} events to webhook URL {url}.
        slots:
          enabled_events: requestBody.enabled_events
          url: requestBody.url
      - text: 'Create a Connect webhook at {url} for {enabled_events} from connected accounts: {connect}.'
        slots:
          url: requestBody.url
          enabled_events: requestBody.enabled_events
          connect: requestBody.connect
      - text: Register webhook {url} for {enabled_events} pinned to API version {api_version}.
        slots:
          url: requestBody.url
          enabled_events: requestBody.enabled_events
          api_version: requestBody.api_version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/webhook_endpoints/{webhook_endpoint}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webhook endpoint
      effect: read
      questions:
      - How do I check which events a webhook endpoint listens for?
      - Is a given webhook endpoint enabled or disabled?
      instructions:
      - text: Show webhook endpoint {webhook_endpoint}.
        slots:
          webhook_endpoint: path.webhook_endpoint
      - text: Get the URL and events of webhook {webhook_endpoint}.
        slots:
          webhook_endpoint: path.webhook_endpoint
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/webhook_endpoints/{webhook_endpoint}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update or disable a webhook endpoint
      effect: write
      questions:
      - How do I change the events a webhook endpoint receives?
      - Can I pause a webhook endpoint without deleting it?
      - How do I point an existing webhook at a new URL?
      instructions:
      - text: Change webhook {webhook_endpoint} to receive {enabled_events}.
        slots:
          webhook_endpoint: path.webhook_endpoint
          enabled_events: requestBody.enabled_events
      - text: Point webhook endpoint {webhook_endpoint} at {url}.
        slots:
          webhook_endpoint: path.webhook_endpoint
          url: requestBody.url
      - text: 'Disable webhook endpoint {webhook_endpoint}: {disabled}.'
        slots:
          webhook_endpoint: path.webhook_endpoint
          disabled: requestBody.disabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/webhook_endpoints/{webhook_endpoint}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook endpoint
      effect: destructive
      questions:
      - How do I stop sending events to an old webhook URL for good?
      - Can I remove a webhook endpoint through the API instead of the dashboard?
      instructions:
      - text: Delete webhook endpoint {webhook_endpoint}.
        slots:
          webhook_endpoint: path.webhook_endpoint
      - text: Remove webhook {webhook_endpoint} permanently.
        slots:
          webhook_endpoint: path.webhook_endpoint
      method: generated
      generated: '2026-09-26'