Webhooks
Listar webhooks
Obtén todos los endpoints de webhook registrados en tu cuenta, con la opción de filtrar por estado para encontrar webhooks activos, deshabilitados o eliminados.
GET
/
v2
/
webhooks
Listar 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>"
}
]
}Usa este endpoint para listar los endpoints de webhook registrados en tu cuenta. Puedes filtrar por estado para ver solo los webhooks activos, deshabilitados o eliminados previamente. La respuesta contiene como máximo 100 webhooks, ordenados del actualizado más recientemente al más antiguo. Cada resultado incluye el
webhookId, el tipo de evento, la URL de callback y la clave pública que se usa para verificar la firma.
Todas las solicitudes deben incluir el header
X-BH-TOKEN con un token de negocio de GET /v2/token/generate.Endpoint
GET https://api.velafi.com/v2/webhooks
Parámetros de consulta
integer
Opcional. Filtra por estado del webhook. Si se omite, se devuelven los webhooks en todos los estados, incluidos los eliminados:
10— activo20— deshabilitado30— eliminado
Campos de la respuesta
number
Código de respuesta de tipo HTTP.
200 indica éxito.string
Mensaje de estado legible, por ejemplo
SUCCESS.array
Mostrar campos de cada elemento de data
Mostrar campos de cada elemento de data
string
Identificador único de este webhook.
string
El tipo de evento que recibe este webhook (por ejemplo,
ORDER_WEBHOOK).string
La URL de callback registrada.
number
Estado del webhook:
10 = activo, 20 = deshabilitado, 30 = eliminado.string
Clave pública RSA codificada en Base64 para verificar las firmas de los webhooks.
Ejemplo
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..."
}
]
}
Si necesitas rotar o reemplazar la URL de un webhook, obtén aquí el
webhookId y luego llama al endpoint Actualizar webhook con la nueva URL.⌘I
Listar 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>"
}
]
}