Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partner Event Notifications API

3 actions 3 updates phrasing extends openapi/impact-event-notifications-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 3

$.info

$.paths['/your-configured-path'].get

$.paths['/your-configured-path'].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 Partner Event Notifications API
  version: 1.0.0
extends: openapi/impact-event-notifications-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: 2
- target: $.paths['/your-configured-path'].get
  update:
    x-apievangelist-phrasing:
      intent: Receive an event notification as a GET
      effect: read
      questions:
      - What query parameters arrive when impact.com pings my URL with a GET?
      - Can I use pixel-style event notifications for conversions?
      instructions:
      - text: Handle a GET notification for action {action} with status {status}.
        slots:
          action: query.action_id
          status: query.status
      - text: Record the payout {payout} from a pixel-style notification on campaign {campaign}.
        slots:
          payout: query.payout
          campaign: query.campaign_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/your-configured-path'].post
  update:
    x-apievangelist-phrasing:
      intent: Receive an event notification as JSON
      effect: write
      questions:
      - What JSON body does impact.com post to my endpoint when an event happens?
      - How should my server acknowledge a posted event notification?
      instructions:
      - text: Process a JSON event for action {action} with status {status}.
        slots:
          action: requestBody.action_id
          status: requestBody.status
      - text: Store the items {items} from a posted notification on campaign {campaign}.
        slots:
          items: requestBody.items
          campaign: requestBody.campaign_id
      method: generated
      generated: '2026-09-26'