Pirsch · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Pirsch Webhooks API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/webhook'].get
$.paths['/webhook'].post
$.paths['/webhook'].delete

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 Pirsch Webhooks API
  version: 1.0.0
extends: openapi/pirsch-webhooks-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'].get
  update:
    x-apievangelist-phrasing:
      intent: List a domain's webhooks
      effect: read
      questions:
      - Which webhooks are configured for my site?
      - Can I see the endpoints my analytics events are sent to?
      instructions:
      - text: List the webhooks for domain {domain_id}.
        slots:
          domain_id: query.domain_id
      - text: Show every webhook endpoint on domain {domain_id}.
        slots:
          domain_id: query.domain_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhook'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or edit a webhook
      effect: write
      questions:
      - How do I get a webhook call when an event happens on my site?
      - Can I change the endpoint URL of an existing webhook?
      instructions:
      - text: Create a webhook on domain {domain_id} for event {event} posting to {endpoint}.
        slots:
          domain_id: requestBody.domain_id
          event: requestBody.event
          endpoint: requestBody.endpoint
      - text: Update webhook {id} on domain {domain_id} to send {event} to {endpoint}.
        slots:
          id: requestBody.id
          domain_id: requestBody.domain_id
          event: requestBody.event
          endpoint: requestBody.endpoint
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhook'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook
      effect: destructive
      questions:
      - How do I stop a webhook from firing?
      - Can I remove one webhook and keep the others?
      instructions:
      - text: Delete webhook {id}.
        slots:
          id: query.id
      - text: Remove the webhook {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-10-01'