Xquik · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Xquik Webhooks API

8 actions 8 updates phrasing extends openapi/xquik-api-webhooks-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info

$.paths['/api/v1/webhooks'].get

$.paths['/api/v1/webhooks'].post

$.paths['/api/v1/webhooks/{id}'].delete

$.paths['/api/v1/webhooks/{id}'].patch

$.paths['/api/v1/webhooks/{id}/deliveries'].get

$.paths['/api/v1/webhooks/{id}/test'].post

$.paths['/api/v1/webhooks/{id}/resume'].post

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 Xquik Webhooks API
  version: 1.0.0
extends: openapi/xquik-api-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: 7
- target: $.paths['/api/v1/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List my webhooks
      effect: read
      questions:
      - Which webhook endpoints have I registered?
      - Can I see all my webhooks and whether they're active?
      instructions:
      - text: List my webhooks.
      - text: Show all registered webhook endpoints.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a webhook for monitor events
      effect: write
      questions:
      - How do I receive monitor events at my own URL?
      - Can I choose which event types a webhook receives?
      instructions:
      - text: Create a webhook at {url} for {eventTypes}.
        slots:
          url: requestBody.url
          eventTypes: requestBody.eventTypes
      - text: Send {eventTypes} events to {url}.
        slots:
          url: requestBody.url
          eventTypes: requestBody.eventTypes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/webhooks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Deactivate a webhook
      effect: destructive
      questions:
      - What's the way to deactivate a webhook?
      - Can I stop a webhook from receiving events for good?
      instructions:
      - text: Deactivate webhook {id}.
        slots:
          id: path.id
      - text: Shut off webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/webhooks/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a webhook's URL or events
      effect: write
      questions:
      - Can I change the URL a webhook posts to?
      - Can I change which events an existing webhook subscribes to?
      instructions:
      - text: Change webhook {id} URL to {url}.
        slots:
          id: path.id
          url: requestBody.url
      - text: Update webhook {id} to receive {eventTypes}.
        slots:
          id: path.id
          eventTypes: requestBody.eventTypes
      - text: Set webhook {id} active to {isActive}.
        slots:
          id: path.id
          isActive: requestBody.isActive
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/webhooks/{id}/deliveries'].get
  update:
    x-apievangelist-phrasing:
      intent: List a webhook's deliveries
      effect: read
      questions:
      - Did my webhook deliveries succeed?
      - Can I see the delivery history for a webhook?
      instructions:
      - text: List deliveries for webhook {id}.
        slots:
          id: path.id
      - text: Show recent delivery attempts to webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/webhooks/{id}/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test event to a webhook
      effect: write
      questions:
      - Can I send a test event to my webhook endpoint?
      - Is there a way to verify my webhook URL works before going live?
      instructions:
      - text: Send a test delivery to webhook {id}.
        slots:
          id: path.id
      - text: Test webhook endpoint {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/webhooks/{id}/resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Test and resume a webhook
      effect: write
      questions:
      - Can I test and reactivate a webhook in one step?
      - How do I get a stopped webhook delivering again?
      instructions:
      - text: Test and resume webhook {id}.
        slots:
          id: path.id
      - text: Reactivate webhook {id} after checking it responds.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'