Birdeye · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Birdeye Subscription API

3 actions 3 updates phrasing extends openapi/birdeye-subscription-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Birdeye's API. It is a proposal applied on top of the contract, not a document Birdeye publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/v1/subscriptions/subscribe'].post

$.paths['/v1/subscriptions/unsubscribe/{subscriptionId}'].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 Birdeye Subscription API
  version: 1.0.0
extends: openapi/birdeye-subscription-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: 2
- target: $.paths['/v1/subscriptions/subscribe'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe to account events
      effect: write
      questions:
      - Can I subscribe a webhook URL to Birdeye events for my account?
      - Can event notifications go to email addresses instead of a webhook?
      instructions:
      - text: Subscribe {webhookUrl} to {eventName} events for business {businessId}.
        slots:
          webhookUrl: requestBody.webhookUrl
          eventName: requestBody.eventName
          businessId: query.businessId
      - text: Create a subscription sending {eventName} to emails {emails} for {businessId}.
        slots:
          eventName: requestBody.eventName
          emails: requestBody.emails
          businessId: query.businessId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/subscriptions/unsubscribe/{subscriptionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Cancel an event subscription
      effect: destructive
      questions:
      - Can I cancel an event subscription I created?
      - Is there a way to stop a subscription's notifications by its ID?
      instructions:
      - text: Unsubscribe subscription {subscriptionId} for business {businessId}.
        slots:
          subscriptionId: path.subscriptionId
          businessId: query.businessId
      - text: Cancel event subscription {subscriptionId} on {businessId}.
        slots:
          subscriptionId: path.subscriptionId
          businessId: query.businessId
      method: generated
      generated: '2026-09-26'