Birdeye · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Birdeye Ticketing API

5 actions 5 updates phrasing extends openapi/birdeye-ticketing-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 5

$.info

$.paths['/v1/ticket/{businessNumber}/create-ticket'].put

$.paths['/v1/ticket/{businessNumber}/comment-activity'].post

$.paths['/v1/ticket/{businessNumber}/update'].put

$.paths['/v1/ticket/{businessNumber}/get/all?'].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 Ticketing API
  version: 1.0.0
extends: openapi/birdeye-ticketing-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: 4
- target: $.paths['/v1/ticket/{businessNumber}/create-ticket'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a ticket
      effect: write
      questions:
      - Can I open a ticket for a customer issue and assign it to someone?
      - Can a ticket be created from a survey response?
      instructions:
      - text: Create a {ticketType} ticket at location {businessNumber} assigned to {assignedTo}.
        slots:
          ticketType: requestBody.ticketType
          businessNumber: path.businessNumber
          assignedTo: requestBody.assignedTo
      - text: Open a {ticketType} ticket on {businessNumber} for survey response {surveyResponseId}, assigned to {assignedTo}.
        slots:
          ticketType: requestBody.ticketType
          businessNumber: path.businessNumber
          surveyResponseId: requestBody.surveyResponseId
          assignedTo: requestBody.assignedTo
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ticket/{businessNumber}/comment-activity'].post
  update:
    x-apievangelist-phrasing:
      intent: Comment on a ticket
      effect: write
      questions:
      - Can I add a comment to an existing ticket?
      - Is it possible to log a note on a ticket as a specific user?
      instructions:
      - text: Add comment {comment} to ticket {ticketId} at {businessNumber} as {userEmail}.
        slots:
          comment: requestBody.comment
          ticketId: requestBody.ticketId
          businessNumber: path.businessNumber
          userEmail: requestBody.userEmail
      - text: 'Post a note on ticket {ticketId} for location {businessNumber} from {userEmail}: {comment}.'
        slots:
          ticketId: requestBody.ticketId
          businessNumber: path.businessNumber
          userEmail: requestBody.userEmail
          comment: requestBody.comment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ticket/{businessNumber}/update'].put
  update:
    x-apievangelist-phrasing:
      intent: Update tickets at a location
      effect: write
      questions:
      - Can I update existing tickets at a location?
      - Is there a way to push changes to several tickets in one request?
      instructions:
      - text: Update tickets at {businessNumber} with {ticketUpdateMessages}.
        slots:
          businessNumber: path.businessNumber
          ticketUpdateMessages: requestBody.ticketUpdateMessages
      - text: Apply ticket updates {ticketUpdateMessages} for location {businessNumber}.
        slots:
          ticketUpdateMessages: requestBody.ticketUpdateMessages
          businessNumber: path.businessNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ticket/{businessNumber}/get/all?'].post
  update:
    x-apievangelist-phrasing:
      intent: List tickets or ticket counts
      effect: read
      questions:
      - Can I list tickets filtered by status, type, or assignee?
      - Can I get just the ticket count instead of full ticket data?
      instructions:
      - text: Get tickets for account {businessNumber} with statuses {ticketStatuses}.
        slots:
          businessNumber: path.businessNumber
          ticketStatuses: requestBody.ticketStatuses
      - text: Count tickets for {businessNumber} using op {op}.
        slots:
          businessNumber: path.businessNumber
          op: query.op
      method: generated
      generated: '2026-09-26'