Birdeye · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Birdeye Webhook API

3 actions 3 updates phrasing extends openapi/birdeye-webhook-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/messenger/webhook/event'].get

$.paths['/v1/messenger/subscribe/webhook/event'].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 Birdeye Webhook API
  version: 1.0.0
extends: openapi/birdeye-webhook-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/messenger/webhook/event'].get
  update:
    x-apievangelist-phrasing:
      intent: List messenger webhook events
      effect: read
      questions:
      - Which messenger webhook events can I subscribe to?
      - Is there a list of the webhook event names available?
      instructions:
      - text: List the available messenger webhook events.
      - text: Show the webhook event types I can subscribe to.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/messenger/subscribe/webhook/event'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe an endpoint to messenger events
      effect: write
      questions:
      - Can I send messenger events to my own endpoint?
      - What's needed to subscribe an endpoint to messenger webhook events?
      instructions:
      - text: Subscribe endpoint {endpoint} to events {events} for {businessNumber} using key {apiKey}.
        slots:
          endpoint: requestBody.endpoint
          events: requestBody.events
          businessNumber: requestBody.businessNumber
          apiKey: requestBody.apiKey
      - text: Create a messenger webhook subscription for {businessNumber} on {events} with API key {apiKey}.
        slots:
          businessNumber: requestBody.businessNumber
          events: requestBody.events
          apiKey: requestBody.apiKey
      method: generated
      generated: '2026-09-26'