Webhooks
List Webhooks
Retrieve all webhook endpoints registered on your account, optionally filtered by status to find active, disabled, or deleted hooks.
GET
/
v2
/
webhooks
List Webhooks
curl --request GET \
--url https://api-test.velafi.com/v2/webhooks \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/webhooks"
headers = {"X-BH-TOKEN": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-BH-TOKEN': '<api-key>'}};
fetch('https://api-test.velafi.com/v2/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api-test.velafi.com/v2/webhooks")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": [
{
"webhookId": "<string>",
"eventType": "<string>",
"url": "<string>",
"status": 123,
"publicKey": "<string>"
}
]
}Use this endpoint to list the webhook endpoints registered on your account. You can filter by status to see only active, disabled, or previously deleted webhooks. The response contains at most 100 webhooks, most recently updated first. Each result includes the
webhookId, event type, callback URL, and the public key used for signature verification.
All requests must include the
X-BH-TOKEN header with a business token from GET /v2/token/generate.Endpoint
GET https://api.velafi.com/v2/webhooks
Query Parameters
integer
Optional. Filter by webhook status. If omitted, webhooks in every status, including deleted ones, are returned:
10— active20— disabled30— deleted
Response Fields
number
HTTP-style response code.
200 indicates success.string
Human-readable status message, e.g.
SUCCESS.array
Example
cURL
curl -G https://api.velafi.com/v2/webhooks \
-H "X-BH-TOKEN: YOUR_TOKEN" \
--data-urlencode "status=10"
Response
{
"code": 200,
"msg": "SUCCESS",
"data": [
{
"webhookId": "ebab8a9663704e7cbbebe672c7c67912",
"eventType": "ORDER_WEBHOOK",
"url": "https://your-app.com/webhooks/velafi",
"status": 10,
"publicKey": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAp/6GRTIrl+kQb9u27cGz..."
}
]
}
If you need to rotate or replace a webhook URL, retrieve the
webhookId here, then call the Update Webhook endpoint with the new URL.⌘I
List Webhooks
curl --request GET \
--url https://api-test.velafi.com/v2/webhooks \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/webhooks"
headers = {"X-BH-TOKEN": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-BH-TOKEN': '<api-key>'}};
fetch('https://api-test.velafi.com/v2/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api-test.velafi.com/v2/webhooks")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": [
{
"webhookId": "<string>",
"eventType": "<string>",
"url": "<string>",
"status": 123,
"publicKey": "<string>"
}
]
}