curl --request POST \
--url https://app.blockgence.com/v1/guard/webhooks \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"url": "<string>",
"scope": "mine",
"watch_id": 123,
"min_severity": "high",
"description": ""
}
'import requests
url = "https://app.blockgence.com/v1/guard/webhooks"
payload = {
"url": "<string>",
"scope": "mine",
"watch_id": 123,
"min_severity": "high",
"description": ""
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: '<string>',
scope: 'mine',
watch_id: 123,
min_severity: 'high',
description: ''
})
};
fetch('https://app.blockgence.com/v1/guard/webhooks', 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://app.blockgence.com/v1/guard/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'scope' => 'mine',
'watch_id' => 123,
'min_severity' => 'high',
'description' => ''
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.blockgence.com/v1/guard/webhooks"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"scope\": \"mine\",\n \"watch_id\": 123,\n \"min_severity\": \"high\",\n \"description\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.blockgence.com/v1/guard/webhooks")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"scope\": \"mine\",\n \"watch_id\": 123,\n \"min_severity\": \"high\",\n \"description\": \"\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.blockgence.com/v1/guard/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"scope\": \"mine\",\n \"watch_id\": 123,\n \"min_severity\": \"high\",\n \"description\": \"\"\n}"
response = http.request(request)
puts response.read_body{
"detail": "<string>",
"error": "<string>"
}{
"detail": "<string>",
"error": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "<string>",
"error": "<string>"
}Crear un webhook firmado (muestra el secreto una sola vez)
Crea un webhook firmado que recibe las alertas de Guard por POST JSON.
Body {"url": "https://...", "scope": "mine", "watch_id": null, "min_severity": "high", "description": "..."}.
scope dice qué alertas recibe:
mine: las de tus vigilancias;org: las de las vigilancias compartidas de tu organización (lo crea un admin de la organización);watch: las de una vigilancia y sus derivadas (conwatch_id; lo crea quien puede editarla).
Los mensajes siguen Standard Webhooks: encabezados webhook-id, webhook-timestamp y webhook-signature
(HMAC-SHA256). Responde el webhook con el secret entero una sola vez (secret_shown_once: true); después va
enmascarado. La URL tiene que ser https, en el puerto 443, y resolver a IPs públicas.
Errores: 400 (URL inválida o no pública, alcance o severidad inválidos), 403 (org sin ser admin, una
vigilancia que no podés editar o el tope de webhooks), 404 (una vigilancia que no ves) y 422 (un campo
desconocido).
Necesita una key asignada a una persona (si no, 403).
Costo: 0 créditos.
curl --request POST \
--url https://app.blockgence.com/v1/guard/webhooks \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"url": "<string>",
"scope": "mine",
"watch_id": 123,
"min_severity": "high",
"description": ""
}
'import requests
url = "https://app.blockgence.com/v1/guard/webhooks"
payload = {
"url": "<string>",
"scope": "mine",
"watch_id": 123,
"min_severity": "high",
"description": ""
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: '<string>',
scope: 'mine',
watch_id: 123,
min_severity: 'high',
description: ''
})
};
fetch('https://app.blockgence.com/v1/guard/webhooks', 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://app.blockgence.com/v1/guard/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'scope' => 'mine',
'watch_id' => 123,
'min_severity' => 'high',
'description' => ''
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.blockgence.com/v1/guard/webhooks"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"scope\": \"mine\",\n \"watch_id\": 123,\n \"min_severity\": \"high\",\n \"description\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.blockgence.com/v1/guard/webhooks")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"scope\": \"mine\",\n \"watch_id\": 123,\n \"min_severity\": \"high\",\n \"description\": \"\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.blockgence.com/v1/guard/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"scope\": \"mine\",\n \"watch_id\": 123,\n \"min_severity\": \"high\",\n \"description\": \"\"\n}"
response = http.request(request)
puts response.read_body{
"detail": "<string>",
"error": "<string>"
}{
"detail": "<string>",
"error": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "<string>",
"error": "<string>"
}Autorizaciones
Encabezados
Caso activo (opcional): el token de un caso que podés ver. La consulta queda en el registro de actividad de ese caso y resuelve también sus labels propias. Un caso que no existe, se borró o ya no está compartido con vos da 400 case_unavailable y la consulta no se hace (sin cobro).
Cuerpo
Respuesta
Successful Response