curl --request PATCH \
--url https://api.example.com/api/v2/webhooks/settings/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v2/webhooks/settings/"
headers = {"Authorization": "Bearer <token>"}
response = requests.patch(url, headers=headers)
print(response.text)const options = {method: 'PATCH', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v2/webhooks/settings/', 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://api.example.com/api/v2/webhooks/settings/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v2/webhooks/settings/"
req, _ := http.NewRequest("PATCH", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.example.com/api/v2/webhooks/settings/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/webhooks/settings/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"error": {
"code": "agent_not_available",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "agent_not_available",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "agent_not_available",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "agent_not_available",
"message": "<string>",
"request_id": "<string>"
}
}Patch apiv2webhookssettings
Company.webhook_url + secret-management endpoints. Legacy Cloud.
Same URL handles GET (read) and PATCH (update); POST is mounted on a subpath for the secret rotation.
This is the pre-Phase-4 surface and it stays because it has live receivers.
It configures exactly one Cloud endpoint with no environment, no event
subscription and the legacy envelope. A tenant that creates a Cloud
WebhookEndpoint supersedes it — see webhooks.events.resolve_endpoints,
where the fallback is conditioned on the absence of a row rather than on a
flag, so nothing can ever double-send.
Required scope: webhooks:write. A key without it is a 403 naming the scope; the endpoint is never silently skipped.
curl --request PATCH \
--url https://api.example.com/api/v2/webhooks/settings/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v2/webhooks/settings/"
headers = {"Authorization": "Bearer <token>"}
response = requests.patch(url, headers=headers)
print(response.text)const options = {method: 'PATCH', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v2/webhooks/settings/', 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://api.example.com/api/v2/webhooks/settings/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v2/webhooks/settings/"
req, _ := http.NewRequest("PATCH", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.example.com/api/v2/webhooks/settings/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/webhooks/settings/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"error": {
"code": "agent_not_available",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "agent_not_available",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "agent_not_available",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "agent_not_available",
"message": "<string>",
"request_id": "<string>"
}
}Authorizations
A managed API key, sent as Authorization: Bearer <key>. A workspace key is prefixed tgcc_; a reseller key is prefixed tgpk_. Keys carry scopes; the scope each operation demands is on the operation as x-required-scope.
Response
No response body

