Constant Contact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for AppConnect V3 Technology Partners Webhooks API

6 actions 6 updates phrasing extends openapi/constant-contact-technology-partners-webhooks-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Constant Contact's API. It is a proposal applied on top of the contract, not a document Constant Contact publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/partner/webhooks/subscriptions'].get
$.paths['/partner/webhooks/subscriptions/{topic_id}'].get
$.paths['/partner/webhooks/subscriptions/{topic_id}'].put
$.paths['/partner/webhooks/subscriptions/{topic_id}'].delete
$.paths['/partner/webhooks/subscriptions/{topic_id}/tests'].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 AppConnect V3 Technology Partners Webhooks API
  version: 1.0.0
extends: openapi/constant-contact-technology-partners-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: 5
- target: $.paths['/partner/webhooks/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List my webhook subscriptions
      effect: read
      questions:
      - Which webhook topics is my partner app subscribed to?
      - Can I see all my billing and account webhook callbacks?
      instructions:
      - text: List my webhook subscriptions.
      - text: Show every partner webhook topic I'm subscribed to.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/webhooks/subscriptions/{topic_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one webhook topic subscription
      effect: read
      questions:
      - What callback URL is set for the account-cancelled webhook?
      - Am I subscribed to a particular webhook topic?
      instructions:
      - text: Show my subscription for webhook topic {topic_id}.
        slots:
          topic_id: path.topic_id
      - text: Get the callback URI for topic {topic_id}.
        slots:
          topic_id: path.topic_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/webhooks/subscriptions/{topic_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Subscribe to a webhook topic or change its callback
      effect: write
      questions:
      - Can I get notified when a client upgrades or downgrades billing tier?
      - Is it possible to change the callback URL on an existing webhook subscription?
      instructions:
      - text: Subscribe to topic {topic_id} at {hook_uri}.
        slots:
          topic_id: path.topic_id
          hook_uri: requestBody.hook_uri
      - text: Point webhook topic {topic_id} to callback {hook_uri}.
        slots:
          topic_id: path.topic_id
          hook_uri: requestBody.hook_uri
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/webhooks/subscriptions/{topic_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe from a webhook topic
      effect: destructive
      questions:
      - Can I stop receiving a webhook topic?
      - Is there a way to turn off account-disabled notifications?
      instructions:
      - text: Unsubscribe from webhook topic {topic_id}.
        slots:
          topic_id: path.topic_id
      - text: Delete my subscription to topic {topic_id}.
        slots:
          topic_id: path.topic_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/webhooks/subscriptions/{topic_id}/tests'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test webhook notification
      effect: write
      questions:
      - Can I trigger a test webhook to check my endpoint works?
      - Is there a way to validate a webhook subscription before real events arrive?
      instructions:
      - text: Send a test notification for webhook topic {topic_id}.
        slots:
          topic_id: path.topic_id
      - text: Fire a test webhook on topic {topic_id}.
        slots:
          topic_id: path.topic_id
      method: generated
      generated: '2026-10-01'