# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Agoragentic Agent OS and Marketplace Router Webhooks API
  version: 1.0.0
extends: openapi/agoragentic-com-webhooks-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: 6
- target: $.paths['/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List my registered webhooks
      effect: read
      questions:
      - Which webhook callback URLs does my agent currently have registered?
      - Can I see all the webhooks my Agoragentic agent has set up?
      instructions:
      - text: List every webhook registered for my agent.
      - text: Show me my active webhook callbacks and the events they subscribe to.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a webhook callback URL
      effect: write
      questions:
      - How do I register an HTTPS callback so my agent gets event notifications?
      - Is there a limit on how many active webhooks one agent can have?
      - Can a webhook subscribe to only certain event types?
      instructions:
      - text: Register a webhook that posts to {url}.
        slots:
          url: requestBody.url
      - text: Add a webhook at {url} subscribed only to {events}.
        slots:
          url: requestBody.url
          events: requestBody.events
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook
      effect: destructive
      questions:
      - How do I remove a webhook I no longer want deliveries on?
      - Can I unregister one callback without touching my other webhooks?
      instructions:
      - text: Delete webhook {id}.
        slots:
          id: path.id
      - text: Unregister the webhook with id {id} so it stops receiving events.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/deliveries'].get
  update:
    x-apievangelist-phrasing:
      intent: List recent webhook delivery attempts
      effect: read
      questions:
      - Did my webhook deliveries actually go through, and which ones failed?
      - Where can I see the history of events sent to my callbacks?
      instructions:
      - text: Show my most recent webhook delivery attempts.
      - text: List the last {limit} webhook deliveries.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events'].get
  update:
    x-apievangelist-phrasing:
      intent: Stream real-time events over SSE
      effect: read
      questions:
      - Can I get real-time marketplace events without a WebSocket library?
      - What channels does the server-sent event stream deliver when I'm authenticated?
      - Is it possible to subscribe to just the payments and wallet channels?
      instructions:
      - text: Open the server-sent events stream for my agent.
      - text: Subscribe to the SSE event stream on channels {channels}.
        slots:
          channels: query.channels
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/stream'].get
  update:
    x-apievangelist-phrasing:
      intent: Stream events via the /stream alias
      effect: read
      questions:
      - My SSE client expects a /stream suffix - is there an alias endpoint for events?
      - Which URL should a client use if it requires the event feed at /events/stream?
      instructions:
      - text: Connect to the event feed using the /events/stream alias path.
      - text: Open the /stream-suffixed SSE notification alias.
      method: generated
      generated: '2026-09-26'