ActiveCampaign · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ActiveCampaign API v3 Webhooks API

7 actions 7 updates phrasing extends openapi/activecampaign-webhooks-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 7

$.info

$.paths['/webhooks'].get

$.paths['/webhooks'].post

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

$.paths['/webhooks/{id}'].put

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

$.paths['/webhook/events'].get

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 ActiveCampaign API v3 Webhooks API
  version: 1.0.0
extends: openapi/activecampaign-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: 6
- target: $.paths['/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhooks
      effect: read
      questions:
      - Which webhooks are configured in my ActiveCampaign account?
      - Can I find webhooks pointing at a particular URL or list?
      instructions:
      - text: List all my webhooks.
      - text: Find webhooks sending to {url}.
        slots:
          url: query.filters[url]
      - text: Show webhooks tied to list {listid}.
        slots:
          listid: query.filters[listid]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a webhook
      effect: write
      questions:
      - How do I get notified at my URL when a contact subscribes?
      - Can I choose which events and sources trigger a webhook?
      instructions:
      - text: Create a webhook with {webhook}.
        slots:
          webhook: requestBody.webhook
      - text: Set up a webhook that posts new subscribes to my endpoint.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webhook
      effect: read
      questions:
      - Where can I see the settings of one webhook?
      - What events does webhook 6 listen to?
      instructions:
      - text: Show webhook {id}.
        slots:
          id: path.id
      - text: Get the URL and events of webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a webhook
      effect: write
      questions:
      - Can I change the URL or events on an existing webhook?
      - Is it possible to edit a webhook without recreating it?
      instructions:
      - text: Update webhook {id} with {webhook}.
        slots:
          id: path.id
          webhook: requestBody.webhook
      - text: Point webhook {id} at a new URL.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook
      effect: destructive
      questions:
      - How do I stop and remove a webhook?
      - Can I delete a webhook that keeps failing?
      instructions:
      - text: Delete webhook {id}.
        slots:
          id: path.id
      - text: Remove the failing webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhook/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List available webhook events
      effect: read
      questions:
      - What events can a webhook subscribe to?
      - Which event types are supported for webhooks?
      instructions:
      - text: List all available webhook events.
      - text: Show me the event types I can subscribe a webhook to.
      method: generated
      generated: '2026-09-26'