Birdeye

Birdeye Webhook API

Configure multiple webhooks with different URLs 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

GET /v1/messenger/webhook/event List messenger webhook events · Get events #

Ask an LLM

“Which messenger webhook events can I subscribe to?”

“Is there a list of the webhook event names available?”

Tell an agent

List the available messenger webhook events.

Show the webhook event types I can subscribe to.

POST /v1/messenger/subscribe/webhook/event Subscribe an endpoint to messenger events · Create webhook subscription #

Ask an LLM

“Can I send messenger events to my own endpoint?”

“What's needed to subscribe an endpoint to messenger webhook events?”

Tell an agent

Subscribe endpoint {endpoint} to events {events} for {businessNumber} using key {apiKey}.

Create a messenger webhook subscription for {businessNumber} on {events} with API key {apiKey}.

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-webhook-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 Webhook API
  version: '1.0'
  description: 'Operations tagged Webhook 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: Webhook
  description: Configure multiple webhooks with different URLs for a subscription and deliver real-time notifications.
paths:
  /v1/messenger/webhook/event:
    get:
      summary: Get events
      operationId: get-events
      tags:
      - Webhook
      parameters: []
      responses:
        '200':
          description: HTTP 200 response
          content:
            application/json:
              schema:
                $schema: http://json-schema.org/draft-07/schema#
                type: array
      security:
      - apiKey: []
    servers:
    - url: https://api.birdeye.com
      description: Production
  /v1/messenger/subscribe/webhook/event:
    post:
      summary: Create webhook subscription
      operationId: create-webhook-subscription
      tags:
      - Webhook
      parameters: []
      responses:
        '200':
          description: HTTP 200 response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 1011
                  message: Business id is invalid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: http://json-schema.org/draft-07/schema#
              type: object
              properties:
                businessNumber:
                  type: number
                apiKey:
                  type: string
                events:
                  type: array
                endpoint:
                  type: string
              required:
              - businessNumber
              - apiKey
              - events
      security:
      - apiKey: []
    servers:
    - url: https://api.birdeye.com
      description: Production
components:
  schemas:
    Apiary_createWebhookSubscription_Request:
      type: object
      properties:
        businessNumber:
          type: number
          description: The business number for which events to be subscribed. Should always be the account business number not the location business number.
        apiKey:
          type: string
          description: Partner specific API key provided by Birdeye for data exchange.
        events:
          type: array
          description: A list of event name strings from the list of available events that should trigger this webhook. Possible values are
          items: {}
        endpoint:
          type: string
          description: The webhook endpoint URL on your server on which webhook requests are to be sent.
      required:
      - businessNumber
      - apiKey
      - events
      example:
        businessNumber: '755009344'
        apiKey: 92bcd6e0-c102-43fd-8a67-1a7be5258451
        events:
        - conversation.created
        - conversation.updated
        - message.added
        - message.closed
        endpoint: https://webhook.site/0c27e14d-f833-4589-b201-86b41a651464
    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
    Apiary_getEvents_Response200:
      type: array
      items:
        type: object
        properties:
          eventId:
            type: number
            description: Event Id.
          eventName:
            type: string
            description: Name of the created event. Possible values are
    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