Sendcloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Event Subscriptions O Auth2 API

2 actions 2 updates phrasing extends openapi/sendcloud-oauth2-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/connections/{id}/authorization'].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 Event Subscriptions O Auth2 API
  version: 1.0.0
extends: openapi/sendcloud-oauth2-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/connections/{id}/authorization'].post
  update:
    x-apievangelist-phrasing:
      intent: Start OAuth2 authorization for a connection
      effect: write
      questions:
      - What's needed to authorize a connection that uses OAuth2, like Klaviyo?
      - Where do I get the authorization URL to send the user to for a connection?
      instructions:
      - text: Start OAuth2 authorization for connection {id}.
        slots:
          id: path.id
      - text: Get the OAuth2 authorization URL for connection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'