Sendcloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Event Subscriptions Broadcast API

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

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/event-subscriptions/broadcast/test/{subscription_id}'].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 Event Subscriptions Broadcast API
  version: 1.0.0
extends: openapi/sendcloud-broadcast-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: 1
- target: $.paths['/event-subscriptions/broadcast/test/{subscription_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test event to a subscription
      effect: write
      questions:
      - Is there a way to check that my event subscription endpoint is receiving events?
      - Can I fire a test event at a subscription before going live?
      instructions:
      - text: Send a test event for subscription {subscription_id}.
        slots:
          subscription_id: path.subscription_id
      - text: Broadcast a test event to the connection behind subscription {subscription_id}.
        slots:
          subscription_id: path.subscription_id
      method: generated
      generated: '2026-10-01'