MCPList subscriptions
curl --request GET \
--url https://api.birdeye.com/resources/v1/subscriptions/list \
--header 'x-api-key: <x-api-key>' \
--header 'x-business-number: <x-business-number>'import requests
url = "https://api.birdeye.com/resources/v1/subscriptions/list"
headers = {
"x-api-key": "<x-api-key>",
"x-business-number": "<x-business-number>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-api-key': '<x-api-key>', 'x-business-number': '<x-business-number>'}
};
fetch('https://api.birdeye.com/resources/v1/subscriptions/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.birdeye.com/resources/v1/subscriptions/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <x-api-key>",
"x-business-number: <x-business-number>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.birdeye.com/resources/v1/subscriptions/list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<x-api-key>")
req.Header.Add("x-business-number", "<x-business-number>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.birdeye.com/resources/v1/subscriptions/list")
.header("x-api-key", "<x-api-key>")
.header("x-business-number", "<x-business-number>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.birdeye.com/resources/v1/subscriptions/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
request["x-business-number"] = '<x-business-number>'
response = http.request(request)
puts response.read_body[
{
"id": "64f1c2a9b3d4e5f6a7b8c9d0",
"customHeaders": null,
"webhookUrl": "https://hooks.zapier.com/hooks/catch/12345678/abcd1234/",
"eventName": "REVIEW_CREATED",
"createdDate": "15 Jan 2025, 10:15:00 AM UTC"
},
{
"id": "64f1c2a9b3d4e5f6a7b8c9d1",
"customHeaders": {
"X-Auth-Token": "sample-token-value",
"X-Source": "birdeye"
},
"webhookUrl": "https://webhook.site/11111111-2222-3333-4444-555555555555",
"eventName": "TICKET_CREATED",
"createdDate": "02 Feb 2025, 11:20:35 AM UTC"
}
]{
"code": 1161,
"message": "Invalid API key"
}{
"code": 1532,
"message": "Business id is missing or invalid."
}{
"code": 89,
"message": "Rate limit exceeded"
}Subscription
List
Get the list of webhook subscriptions configured for the account.
GET
/
v1
/
subscriptions
/
list
List subscriptions
curl --request GET \
--url https://api.birdeye.com/resources/v1/subscriptions/list \
--header 'x-api-key: <x-api-key>' \
--header 'x-business-number: <x-business-number>'import requests
url = "https://api.birdeye.com/resources/v1/subscriptions/list"
headers = {
"x-api-key": "<x-api-key>",
"x-business-number": "<x-business-number>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-api-key': '<x-api-key>', 'x-business-number': '<x-business-number>'}
};
fetch('https://api.birdeye.com/resources/v1/subscriptions/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.birdeye.com/resources/v1/subscriptions/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <x-api-key>",
"x-business-number: <x-business-number>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.birdeye.com/resources/v1/subscriptions/list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<x-api-key>")
req.Header.Add("x-business-number", "<x-business-number>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.birdeye.com/resources/v1/subscriptions/list")
.header("x-api-key", "<x-api-key>")
.header("x-business-number", "<x-business-number>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.birdeye.com/resources/v1/subscriptions/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
request["x-business-number"] = '<x-business-number>'
response = http.request(request)
puts response.read_body[
{
"id": "64f1c2a9b3d4e5f6a7b8c9d0",
"customHeaders": null,
"webhookUrl": "https://hooks.zapier.com/hooks/catch/12345678/abcd1234/",
"eventName": "REVIEW_CREATED",
"createdDate": "15 Jan 2025, 10:15:00 AM UTC"
},
{
"id": "64f1c2a9b3d4e5f6a7b8c9d1",
"customHeaders": {
"X-Auth-Token": "sample-token-value",
"X-Source": "birdeye"
},
"webhookUrl": "https://webhook.site/11111111-2222-3333-4444-555555555555",
"eventName": "TICKET_CREATED",
"createdDate": "02 Feb 2025, 11:20:35 AM UTC"
}
]{
"code": 1161,
"message": "Invalid API key"
}{
"code": 1532,
"message": "Business id is missing or invalid."
}{
"code": 89,
"message": "Rate limit exceeded"
}Headers
e.g. application/json
e.g. [Required] Partner specific API key provided by Birdeye for data exchange.
e.g. [Required] Long Business Number.
Response
OK
Unique identifier of the subscription.
Show child attributes
Show child attributes
The webhook endpoint URL on your server on which webhook requests are sent.
Name of the subscribed event.
Date and time (in UTC) at which the subscription was created.
Example:
[
{
"id": "64f1c2a9b3d4e5f6a7b8c9d0",
"customHeaders": null,
"webhookUrl": "https://hooks.zapier.com/hooks/catch/12345678/abcd1234/",
"eventName": "REVIEW_CREATED",
"createdDate": "15 Jan 2025, 10:15:00 AM UTC"
},
{
"id": "64f1c2a9b3d4e5f6a7b8c9d1",
"customHeaders": {
"X-Auth-Token": "sample-token-value",
"X-Source": "birdeye"
},
"webhookUrl": "https://webhook.site/11111111-2222-3333-4444-555555555555",
"eventName": "TICKET_CREATED",
"createdDate": "02 Feb 2025, 11:20:35 AM UTC"
}
]