Register a hook
curl --request POST \
--url https://api.example.com/api/hooks \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"execution_key": "<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_name": "<string>"
},
"tool_kwargs": {}
}
'import requests
url = "https://api.example.com/api/hooks"
payload = {
"execution_key": "<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_name": "<string>"
},
"tool_kwargs": {}
}
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({
execution_key: '<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_name: '<string>'
},
tool_kwargs: {}
})
};
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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'execution_key' => '<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_name' => '<string>'
],
'tool_kwargs' => [
]
]),
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://api.example.com/api/hooks"
payload := strings.NewReader("{\n \"execution_key\": \"<string>\",\n \"name\": \"<string>\",\n \"tool\": \"<string>\",\n \"topic\": \"<string>\",\n \"condition\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"state_binding\": {\n \"states\": [\n {\n \"state\": \"<string>\",\n \"subject_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"input_injections\": [\n {\n \"into\": \"<string>\",\n \"jq\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"template_jq\": \"<string>\"\n }\n ],\n \"scope_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"templates\": [\n \"<string>\"\n ],\n \"updates\": [\n {\n \"adapter\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"jq\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"op_id\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"template_jq\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"subject\": {\n \"key_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"kind\": \"<string>\",\n \"target_name\": \"<string>\"\n },\n \"tool_kwargs\": {}\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://api.example.com/api/hooks")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"execution_key\": \"<string>\",\n \"name\": \"<string>\",\n \"tool\": \"<string>\",\n \"topic\": \"<string>\",\n \"condition\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"state_binding\": {\n \"states\": [\n {\n \"state\": \"<string>\",\n \"subject_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"input_injections\": [\n {\n \"into\": \"<string>\",\n \"jq\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"template_jq\": \"<string>\"\n }\n ],\n \"scope_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"templates\": [\n \"<string>\"\n ],\n \"updates\": [\n {\n \"adapter\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"jq\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"op_id\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"template_jq\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"subject\": {\n \"key_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"kind\": \"<string>\",\n \"target_name\": \"<string>\"\n },\n \"tool_kwargs\": {}\n}")
.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::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"execution_key\": \"<string>\",\n \"name\": \"<string>\",\n \"tool\": \"<string>\",\n \"topic\": \"<string>\",\n \"condition\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"state_binding\": {\n \"states\": [\n {\n \"state\": \"<string>\",\n \"subject_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"input_injections\": [\n {\n \"into\": \"<string>\",\n \"jq\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"template_jq\": \"<string>\"\n }\n ],\n \"scope_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"templates\": [\n \"<string>\"\n ],\n \"updates\": [\n {\n \"adapter\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"jq\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"op_id\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"template_jq\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"subject\": {\n \"key_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"kind\": \"<string>\",\n \"target_name\": \"<string>\"\n },\n \"tool_kwargs\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"name": "<string>",
"registered": true
}
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}hooks
Register a hook
Register a hook from its flat parameters — an UPSERT, so this is the create path AND the edit path for a hook of that name.
Supports conditional execution (condition), payload transformation (expr) —
each a templated text carrying its jq inline or by stored id — and dynamic tool arguments.
execution_key is the api-key identity every fire runs as; the caller’s authority
to delegate it and its usability by a tokenless fire are decided BEFORE the upsert, so
a refusal stores nothing and leaves any existing hook of that name untouched. Returns
{"registered", "name"}; registered is True for a create and a replace
alike.
POST
/
api
/
hooks
Register a hook
curl --request POST \
--url https://api.example.com/api/hooks \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"execution_key": "<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_name": "<string>"
},
"tool_kwargs": {}
}
'import requests
url = "https://api.example.com/api/hooks"
payload = {
"execution_key": "<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_name": "<string>"
},
"tool_kwargs": {}
}
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({
execution_key: '<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_name: '<string>'
},
tool_kwargs: {}
})
};
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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'execution_key' => '<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_name' => '<string>'
],
'tool_kwargs' => [
]
]),
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://api.example.com/api/hooks"
payload := strings.NewReader("{\n \"execution_key\": \"<string>\",\n \"name\": \"<string>\",\n \"tool\": \"<string>\",\n \"topic\": \"<string>\",\n \"condition\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"state_binding\": {\n \"states\": [\n {\n \"state\": \"<string>\",\n \"subject_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"input_injections\": [\n {\n \"into\": \"<string>\",\n \"jq\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"template_jq\": \"<string>\"\n }\n ],\n \"scope_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"templates\": [\n \"<string>\"\n ],\n \"updates\": [\n {\n \"adapter\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"jq\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"op_id\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"template_jq\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"subject\": {\n \"key_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"kind\": \"<string>\",\n \"target_name\": \"<string>\"\n },\n \"tool_kwargs\": {}\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://api.example.com/api/hooks")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"execution_key\": \"<string>\",\n \"name\": \"<string>\",\n \"tool\": \"<string>\",\n \"topic\": \"<string>\",\n \"condition\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"state_binding\": {\n \"states\": [\n {\n \"state\": \"<string>\",\n \"subject_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"input_injections\": [\n {\n \"into\": \"<string>\",\n \"jq\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"template_jq\": \"<string>\"\n }\n ],\n \"scope_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"templates\": [\n \"<string>\"\n ],\n \"updates\": [\n {\n \"adapter\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"jq\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"op_id\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"template_jq\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"subject\": {\n \"key_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"kind\": \"<string>\",\n \"target_name\": \"<string>\"\n },\n \"tool_kwargs\": {}\n}")
.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::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"execution_key\": \"<string>\",\n \"name\": \"<string>\",\n \"tool\": \"<string>\",\n \"topic\": \"<string>\",\n \"condition\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"state_binding\": {\n \"states\": [\n {\n \"state\": \"<string>\",\n \"subject_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"input_injections\": [\n {\n \"into\": \"<string>\",\n \"jq\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"template_jq\": \"<string>\"\n }\n ],\n \"scope_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"templates\": [\n \"<string>\"\n ],\n \"updates\": [\n {\n \"adapter\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"jq\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"op_id\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"template_jq\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"subject\": {\n \"key_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"kind\": \"<string>\",\n \"target_name\": \"<string>\"\n },\n \"tool_kwargs\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"name": "<string>",
"registered": true
}
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Authorizations
Body
application/json
The client-facing register-a-hook request body: the fields a caller supplies.
execution_key_fingerprint is server-derived at bind and deliberately absent
here; :class:HookParams is this shape plus that one stored field.
The api-key user_id the hook fires as; its live stored grants authorize every tool call the fire makes.
Minimum string length:
1Minimum string length:
1Minimum string length:
1Minimum string length:
1A renderable text: its source plus the parameters its render takes.
EXACTLY ONE source is set — content (the text inline) or id (the id of a
stored resource holding the text); neither and both are refused at construction.
kwargs are the render parameters for the TEXT and apply either way, so moving a
text from inline to stored (or back) leaves its parameters untouched.
Show child attributes
Show child attributes
A renderable text: its source plus the parameters its render takes.
EXACTLY ONE source is set — content (the text inline) or id (the id of a
stored resource holding the text); neither and both are refused at construction.
kwargs are the render parameters for the TEXT and apply either way, so moving a
text from inline to stored (or back) leaves its parameters untouched.
Show child attributes
Show child attributes
The optional binding a door carries: one or more :class:StateAttach entries. Frozen.
The same shape is stored on PresetBody/PresetSeed, TargetConversationConfig,
HookRegister and ScheduleCreate, deposited on ToolInvocation through the
ambient dispatch context, and repeated per node by a flow engine.
Show child attributes
Show child attributes
The optional state subject a hook fire targets: the conversation-target scope
(target_kind, target_name), the subject kind (matching
:data:~tai42_contract.states.SUBJECT_KIND_RE), and a key_expr — a templated text
carrying (inline or by stored id) a jq program evaluated over the event payload at
fire — it must yield a non-empty string, else the fire fails loudly like any hook
error. Frozen; deposited as the ambient state context so a state write during the fire
is keyed and attributed to the hook.
Show child attributes
Show child attributes
Response
Success.
A hook upsert confirmation — registered is True for a create and a
replace alike.
Show child attributes
Show child attributes