Birdeye

Birdeye Subscription API

Subscribe or Unsubscribe multiple webhooks with different URLs or Events for a subscription and deliver real-time notifications.

Documentation GitHub OpenAPI

Operations 2

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v1/subscriptions/subscribe Subscribe to account events · Create subscription #

Ask an LLM

“Can I subscribe a webhook URL to Birdeye events for my account?”

“Can event notifications go to email addresses instead of a webhook?”

Tell an agent

Subscribe {webhookUrl} to {eventName} events for business {businessId}.

Create a subscription sending {eventName} to emails {emails} for {businessId}.

GET /v1/subscriptions/unsubscribe/{subscriptionId} Cancel an event subscription · Unsubscribe subscription #

Ask an LLM

“Can I cancel an event subscription I created?”

“Is there a way to stop a subscription's notifications by its ID?”

Tell an agent destructive · confirm first

Unsubscribe subscription {subscriptionId} for business {businessId}.

Cancel event subscription {subscriptionId} on {businessId}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/birdeye:birdeye-subscription-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Birdeye Subscription API
  version: '1.0'
  description: 'Operations tagged Subscription across 2 of this provider''s published API definitions: birdeye-birdeye-api-openapi.yml, birdeye-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.birdeye.com
  description: Production
- url: https://api.birdeye.com/resources
tags:
- name: Subscription
  description: Subscribe or Unsubscribe multiple webhooks with different URLs or Events for a subscription and deliver real-time notifications.
paths:
  /v1/subscriptions/subscribe:
    post:
      summary: Create subscription
      operationId: create-subscription
      tags:
      - Subscription
      parameters:
      - name: businessId
        in: query
        required: true
        description: Account business number.
        schema:
          type: number
        example: '1234567890'
      responses:
        '200':
          description: HTTP 200 response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 1167
                  message: API key is missing
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: http://json-schema.org/draft-07/schema#
              type: object
              properties:
                webhookUrl:
                  type: string
                emails:
                  type: array
                eventName:
                  type: string
                auth:
                  type: object
      security:
      - apiKey: []
    servers:
    - url: https://api.birdeye.com
      description: Production
  /v1/subscriptions/unsubscribe/{subscriptionId}:
    get:
      summary: Unsubscribe subscription
      operationId: unsubscribe-subscription
      tags:
      - Subscription
      parameters:
      - name: subscriptionId
        in: path
        required: true
        description: ''
        schema:
          type: string
        example: tyhjwvbtys56782hbjsAGH
      - name: businessId
        in: query
        required: true
        description: Account business number.
        schema:
          type: number
        example: '1234567890'
      responses:
        '200':
          description: HTTP 200 response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 1005
                  message: Subscription Not found for Particular Id
      security:
      - apiKey: []
    servers:
    - url: https://api.birdeye.com
      description: Production
components:
  schemas:
    Apiary_createSubscription_Request:
      type: object
      properties:
        webhookUrl:
          type: string
          description: The webhook endpoint URL on your server on which webhook requests are to be sent.
        emails:
          type: array
          description: The email id(s) of the business.
          items: {}
        eventName:
          type: string
          description: Name of the evnet to be subscribed
        auth:
          type: object
          properties:
            username:
              type: string
              description: username for authorization
            password:
              type: string
              description: password for authorization
          description: Will be used for basic authorization, should be null for no auth
      example:
        webhookUrl: https://webhook.site/2036c967-0174-4604-8b38-8d5493ed6d65
        emails:
        - test@xyz.com
        eventName: APPOINTMENT_BOOKED
        auth:
          username: testUser
          password: userpassword
    1167Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1167
        message: API key is missing
    89Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 89
        message: Rate limit exceeded
    1011Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1011
        message: Business id is invalid
    1161Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1161
        message: Invalid API key
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Partner specific API key provided by Birdeye for data exchange.
x-refined-from:
- birdeye-birdeye-api-openapi.yml
- birdeye-openapi-original.yml