POST /v1/messenger/subscribe/webhook/event

Servers

https://api.birdeye.com/resources

Request headers

Name	Type	Required	Description
`Accept`	String	No	e.g. application/json
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`events[]`	Array	Yes	A list of event name strings from the list of available events that should trigger this webhook. Possible values are `conversation.created - A new conversation started, conversation.updated - A conversation has been updated with a new status or assigned/unassigned, message.added - A new message has been created. Triggered for both sent and received messages, and conversation.closed - Conversation is closed.`
`apiKey`	String	Yes	Partner specific API key provided by Birdeye for data exchange.
`businessNumber`	Number	Yes	The business number for which events to be subscribed. Should always be the account business number not the location business number.
`endpoint`	String	No	f833-4589-b201-86b41a651464 (string) - The webhook endpoint URL on your server on which webhook requests are to be sent.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.