Skip to main content
POST
Create webhook subscription

Headers

Accept
string
default:application/json

e.g. application/json

Content-Type
string
default:application/json

Media type of the JSON request body.

Body

application/json
businessNumber
number
required

The business number for which events to be subscribed. Should always be the account business number not the location business number.

apiKey
string
required

Partner specific API key provided by Birdeye for data exchange.

events
any[]
required

A list of event name strings from the list of available events that should trigger this webhook. Possible values are

endpoint
string

The webhook endpoint URL on your server on which webhook requests are to be sent.

Response

OK

events
any[]
required

A list of event names that should trigger this webhook.

subscriptionId
number

Event Id.

businessId
number

A unique ID generated by the Birdeye platform that identifies this business.