Skip to main content
POST
Create subscription

Headers

Accept
string
default:application/json

e.g. application/json

x-api-key
string

e.g. [Required] Partner specific API key provided by Birdeye for data exchange.

Content-Type
string
default:application/json

Media type of the JSON request body.

Query Parameters

businessId
number
required

Account business number.

Body

application/json
webhookUrl
string

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

emails
any[]

The email id(s) of the business.

eventName
string

Name of the evnet to be subscribed

auth
object

Will be used for basic authorization, should be null for no auth

Response

OK

id
string
message
string