Update a 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
Update a webhook
Changes the URL, the minimum severity or the description of a webhook, enables or disables it, or rotates its secret.
Body with any of these fields:
url,min_severityanddescription;enabled: enabling it resets the consecutive failures and clears the reason it was disabled;rotate_secret: true: generates a new secret. The response carries the full new secret only once androtating_until: for 24 hours, each message carries two signatures separated by a space, one with the new secret and one with the previous one.
Returns the updated webhook.
It can be changed by the person who created it and, if its scope is org or a shared watch, by an administrator
of the organization. For anyone else it returns 404.
Errors: 400 with an invalid URL or severity; 422 with an unknown field. Requires an API key assigned to a
person (403).
Cost: free.
PATCH
/
v1
/
guard
/
webhooks
/
{hid}
Update a 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>"
}Authorizations
APIKeyHeaderBearerAuth
Headers
Body
application/json
Response
Successful response.