Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for impact.com Webhook API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/{tenant_alias}/subscription'].get
$.paths['/{tenant_alias}/subscription'].post
$.paths['/{tenant_alias}/subscription/{url}'].delete
$.paths['/{tenant_alias}/subscription/{url}/test'].post

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 impact.com Webhook API
  version: 1.0.0
extends: openapi/impact-webhook-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: 4
- target: $.paths['/{tenant_alias}/subscription'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhook subscriptions
      effect: read
      questions:
      - Which URLs are subscribed to receive my webhook events?
      - Where can I see my current webhook subscriptions?
      instructions:
      - text: List webhook subscriptions for tenant {tenant}.
        slots:
          tenant: path.tenant_alias
      - text: Show every endpoint subscribed to events in tenant {tenant}.
        slots:
          tenant: path.tenant_alias
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{tenant_alias}/subscription'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe a URL to webhooks
      effect: write
      questions:
      - How do I start receiving webhook events at my endpoint?
      - Can I subscribe a URL to only certain webhook types?
      instructions:
      - text: Subscribe {url} to webhooks in tenant {tenant}.
        slots:
          tenant: path.tenant_alias
          url: requestBody.endpointUrl
      - text: Create webhook {name} at {url} for event types {types}.
        slots:
          name: requestBody.name
          url: requestBody.endpointUrl
          types: requestBody.webhookTypes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{tenant_alias}/subscription/{url}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a webhook subscription
      effect: destructive
      questions:
      - How do I stop events going to a webhook URL?
      - Can I unsubscribe an endpoint from webhooks?
      instructions:
      - text: Delete the webhook subscription for {url} in tenant {tenant}.
        slots:
          tenant: path.tenant_alias
          url: path.url
      - text: Unsubscribe {url} from webhook events.
        slots:
          url: path.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{tenant_alias}/subscription/{url}/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test webhook event
      effect: write
      questions:
      - Can I send a test event to check my webhook works?
      - What happens when I test a webhook subscription?
      instructions:
      - text: Send a test event to webhook {url} in tenant {tenant}.
        slots:
          tenant: path.tenant_alias
          url: path.url
      - text: Fire a sample webhook at {url}.
        slots:
          url: path.url
      method: generated
      generated: '2026-09-26'