ActiveCampaign · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ActiveCampaign API v3 Event Tracking API

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

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/eventTrackingEvents'].get
$.paths['/eventTrackingEvents'].post
$.paths['/eventTracking'].get
$.paths['/eventTracking'].put
$.paths['/eventTrackingEvents/{eventName}'].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 ActiveCampaign API v3 Event Tracking API
  version: 1.0.0
extends: openapi/activecampaign-event-tracking-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: 5
- target: $.paths['/eventTrackingEvents'].get
  update:
    x-apievangelist-phrasing:
      intent: List tracked event names
      effect: read
      questions:
      - Which custom event names am I tracking?
      - Can I see the list of event types set up for event tracking?
      instructions:
      - text: List all tracked event names.
      - text: Show the event types registered for event tracking.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/eventTrackingEvents'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a new tracked event name
      effect: write
      questions:
      - How do I add a new custom event name to track?
      - Can I register an event like 'signed_up' before sending any occurrences?
      instructions:
      - text: Create the tracked event {eventTrackingEvent}.
        slots:
          eventTrackingEvent: requestBody.eventTrackingEvent
      - text: Register a new event name for tracking.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/eventTracking'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether event tracking is on
      effect: read
      questions:
      - Is event tracking enabled on my ActiveCampaign account?
      - Can I check the current event tracking status?
      instructions:
      - text: Tell me whether event tracking is enabled.
      - text: Get the event tracking status.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/eventTracking'].put
  update:
    x-apievangelist-phrasing:
      intent: Turn event tracking on or off
      effect: write
      questions:
      - How do I switch on event tracking for my account?
      - Can I disable event tracking entirely?
      instructions:
      - text: Set event tracking to {eventTracking}.
        slots:
          eventTracking: requestBody.eventTracking
      - text: Enable event tracking on the account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/eventTrackingEvents/{eventName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tracked event name
      effect: destructive
      questions:
      - How do I stop tracking a custom event name?
      - Can I remove an event type I registered by mistake?
      instructions:
      - text: Delete the tracked event named {eventName}.
        slots:
          eventName: path.eventName
      - text: Remove event {eventName} from event tracking.
        slots:
          eventName: path.eventName
      method: generated
      generated: '2026-09-26'