Cloudflare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloudflare Stream Webhooks API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/accounts/{account_id}/stream/webhook'].get
$.paths['/accounts/{account_id}/stream/webhook'].put
$.paths['/accounts/{account_id}/stream/webhook'].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 Cloudflare Stream Webhooks API
  version: 1.0.0
extends: openapi/cloudflare-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: 3
- target: $.paths['/accounts/{account_id}/stream/webhook'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Stream video webhook URL
      effect: read
      questions:
      - Which URL receives my Cloudflare Stream video processing notifications?
      - Is a webhook currently configured for Stream video events?
      instructions:
      - text: Show the Stream webhook URL for account {account}.
        slots:
          account: path.account_id
      - text: Check where my video processing notifications are being sent.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/stream/webhook'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the Stream video webhook URL
      effect: write
      questions:
      - How do I get notified when a Stream video finishes processing?
      - Can I change the endpoint that receives video processing webhooks?
      instructions:
      - text: Send Stream video processing notifications to {notificationUrl}.
        slots:
          notificationUrl: requestBody.notificationUrl
      - text: Set the Stream webhook for account {account} to {notificationUrl}.
        slots:
          account: path.account_id
          notificationUrl: requestBody.notificationUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/stream/webhook'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove the Stream video webhook
      effect: destructive
      questions:
      - How do I stop receiving Stream video processing webhooks?
      - Can I remove the webhook configuration from my Stream account entirely?
      instructions:
      - text: Delete the Stream webhook configuration for account {account}.
        slots:
          account: path.account_id
      - text: Turn off video processing notifications by removing the webhook.
      method: generated
      generated: '2026-09-26'