curl --request GET \
--url https://api.example.com/api/hooks \
--header 'x-api-key: <api-key>'import requests
url = "https://api.example.com/api/hooks"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.example.com/api/hooks', 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/hooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/hooks"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/hooks")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/hooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"items": [
{
"execution_key": "<string>",
"execution_key_fingerprint": "<string>",
"name": "<string>",
"tool": "<string>",
"topic": "<string>",
"condition": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"expr": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"state_binding": {
"states": [
{
"state": "<string>",
"subject_expr": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"input_injections": [
{
"into": "<string>",
"jq": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"template_jq": "<string>"
}
],
"scope_expr": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"templates": [
"<string>"
],
"updates": [
{
"adapter": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"jq": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"op_id": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"template_jq": "<string>"
}
]
}
]
},
"subject": {
"key_expr": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"kind": "<string>",
"target_kind": "agent",
"target_name": "<string>"
},
"tool_kwargs": {}
}
],
"topic_verifiers": {},
"total": 123,
"trigger_auth": {}
}
}{
"error": "<string>",
"code": "<string>"
}List registered hooks
List registered hooks plus the per-topic verifier bindings.
With a topic, lists only the hooks registered for that topic; without one,
lists every registered hook. The response carries the hooks under items
(with total), the per-topic verifier bindings under topic_verifiers, and
under trigger_auth how a topic’s webhook ingress door authenticates its caller —
DERIVED from the live verifier bindings just read, never stored. trigger_auth is
keyed by every topic among the LISTED hooks plus every topic currently carrying a
verifier binding (one may be bound before any hook exists on it), so under a
topic filter it is neither a subset nor a superset of the listed topics.
curl --request GET \
--url https://api.example.com/api/hooks \
--header 'x-api-key: <api-key>'import requests
url = "https://api.example.com/api/hooks"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.example.com/api/hooks', 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/hooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/hooks"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/hooks")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/hooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"items": [
{
"execution_key": "<string>",
"execution_key_fingerprint": "<string>",
"name": "<string>",
"tool": "<string>",
"topic": "<string>",
"condition": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"expr": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"state_binding": {
"states": [
{
"state": "<string>",
"subject_expr": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"input_injections": [
{
"into": "<string>",
"jq": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"template_jq": "<string>"
}
],
"scope_expr": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"templates": [
"<string>"
],
"updates": [
{
"adapter": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"jq": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"op_id": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"template_jq": "<string>"
}
]
}
]
},
"subject": {
"key_expr": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"kind": "<string>",
"target_kind": "agent",
"target_name": "<string>"
},
"tool_kwargs": {}
}
],
"topic_verifiers": {},
"total": 123,
"trigger_auth": {}
}
}{
"error": "<string>",
"code": "<string>"
}Authorizations
Query Parameters
Restrict the listing to hooks registered for this topic; omit for all hooks.
Response
Success.
The registered hooks plus the live per-topic verifier bindings and derived
trigger-auth axis. topic_verifiers values are dumped binding metadata (an open,
secret-adjacent map, kept opaque so a bound config is not widened onto the wire);
trigger_auth maps each visible topic to how its webhook ingress door
authenticates, derived live, never stored.
Show child attributes
Show child attributes

