Scope3 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Scope3 Buyer Webhook Subscriptions API

4 actions 4 updates phrasing extends openapi/scope3-webhook-subscriptions-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/webhook-subscriptions'].get

$.paths['/webhook-subscriptions'].post

$.paths['/webhook-subscriptions/{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 Scope3 Buyer Webhook Subscriptions API
  version: 1.0.0
extends: openapi/scope3-webhook-subscriptions-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/webhook-subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List my webhook subscriptions
      effect: read
      questions:
      - Which webhook endpoints have I registered for push events?
      - Can I see what event types each of my webhooks receives?
      instructions:
      - text: List all my webhook subscriptions.
      - text: Show the URLs and event types of my registered webhooks.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhook-subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a webhook for push events
      effect: write
      questions:
      - Can I get progressive discovery updates pushed to my server instead of polling?
      - How are webhook deliveries signed so I can verify them?
      instructions:
      - text: Register webhook {url} for {event_types} events signed with secret {secret}.
        slots:
          url: requestBody.url
          event_types: requestBody.eventTypes
          secret: requestBody.secret
      - text: Subscribe {url} to discovery revision events using secret {secret} and event types {event_types}.
        slots:
          url: requestBody.url
          secret: requestBody.secret
          event_types: requestBody.eventTypes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhook-subscriptions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook subscription
      effect: destructive
      questions:
      - How do I stop webhook deliveries to an endpoint I no longer use?
      - Do deliveries stop right away when I remove a webhook?
      instructions:
      - text: Delete webhook subscription {id}.
        slots:
          id: path.id
      - text: Stop sending events to webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'