Modificar un webhook
curl --request PATCH \
--url https://app.blockgence.com/v1/guard/webhooks/{hid} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"url": "<string>",
"min_severity": "<string>",
"description": "<string>",
"enabled": true,
"rotate_secret": false
}
'import requests
url = "https://app.blockgence.com/v1/guard/webhooks/{hid}"
payload = {
"url": "<string>",
"min_severity": "<string>",
"description": "<string>",
"enabled": True,
"rotate_secret": False
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: '<string>',
min_severity: '<string>',
description: '<string>',
enabled: true,
rotate_secret: false
})
};
fetch('https://app.blockgence.com/v1/guard/webhooks/{hid}', 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/{hid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'min_severity' => '<string>',
'description' => '<string>',
'enabled' => true,
'rotate_secret' => false
]),
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/{hid}"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"min_severity\": \"<string>\",\n \"description\": \"<string>\",\n \"enabled\": true,\n \"rotate_secret\": false\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://app.blockgence.com/v1/guard/webhooks/{hid}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"min_severity\": \"<string>\",\n \"description\": \"<string>\",\n \"enabled\": true,\n \"rotate_secret\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.blockgence.com/v1/guard/webhooks/{hid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"min_severity\": \"<string>\",\n \"description\": \"<string>\",\n \"enabled\": true,\n \"rotate_secret\": false\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>"
}Guard
Modificar un webhook
Cambia la URL, la severidad mínima o la descripción de un webhook, lo activa o lo desactiva, o rota su secreto.
Cuerpo del pedido con cualquiera de estos campos:
url,min_severityydescription;enabled: activarlo pone en cero las fallas seguidas y borra el motivo de la desactivación;rotate_secret: true: genera un secreto nuevo. La respuesta trae el secreto nuevo completo una sola vez yrotating_until: durante 24 horas cada mensaje lleva dos firmas separadas por un espacio, con el secreto nuevo y con el anterior.
Responde el webhook actualizado.
Lo modifican quien lo creó y, si su alcance es org o una vigilancia compartida, un administrador de la
organización. Para los demás responde 404.
Errores: 400 con una URL o una severidad inválidas; 422 con un campo desconocido. Requiere una clave de API
asignada a una persona (403).
Costo: sin cargo.
PATCH
/
v1
/
guard
/
webhooks
/
{hid}
Modificar un webhook
curl --request PATCH \
--url https://app.blockgence.com/v1/guard/webhooks/{hid} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"url": "<string>",
"min_severity": "<string>",
"description": "<string>",
"enabled": true,
"rotate_secret": false
}
'import requests
url = "https://app.blockgence.com/v1/guard/webhooks/{hid}"
payload = {
"url": "<string>",
"min_severity": "<string>",
"description": "<string>",
"enabled": True,
"rotate_secret": False
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: '<string>',
min_severity: '<string>',
description: '<string>',
enabled: true,
rotate_secret: false
})
};
fetch('https://app.blockgence.com/v1/guard/webhooks/{hid}', 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/{hid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'min_severity' => '<string>',
'description' => '<string>',
'enabled' => true,
'rotate_secret' => false
]),
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/{hid}"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"min_severity\": \"<string>\",\n \"description\": \"<string>\",\n \"enabled\": true,\n \"rotate_secret\": false\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://app.blockgence.com/v1/guard/webhooks/{hid}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"min_severity\": \"<string>\",\n \"description\": \"<string>\",\n \"enabled\": true,\n \"rotate_secret\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.blockgence.com/v1/guard/webhooks/{hid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"min_severity\": \"<string>\",\n \"description\": \"<string>\",\n \"enabled\": true,\n \"rotate_secret\": false\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
APIKeyHeaderBearerAuth
Encabezados
Parámetros de ruta
Cuerpo
application/json
Respuesta
Respuesta correcta.