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": "<string>",
  "condition_id": "<string>",
  "condition_kwargs": {},
  "expr": "<string>",
  "expr_id": "<string>",
  "expr_kwargs": {},
  "tool_kwargs": {}
}
'

import requests

url = "https://api.example.com/api/hooks"

payload = {
    "execution_key": "<string>",
    "name": "<string>",
    "tool": "<string>",
    "topic": "<string>",
    "condition": "<string>",
    "condition_id": "<string>",
    "condition_kwargs": {},
    "expr": "<string>",
    "expr_id": "<string>",
    "expr_kwargs": {},
    "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: '<string>',
    condition_id: '<string>',
    condition_kwargs: {},
    expr: '<string>',
    expr_id: '<string>',
    expr_kwargs: {},
    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' => '<string>',
    'condition_id' => '<string>',
    'condition_kwargs' => [
        
    ],
    'expr' => '<string>',
    'expr_id' => '<string>',
    'expr_kwargs' => [
        
    ],
    '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\": \"<string>\",\n  \"condition_id\": \"<string>\",\n  \"condition_kwargs\": {},\n  \"expr\": \"<string>\",\n  \"expr_id\": \"<string>\",\n  \"expr_kwargs\": {},\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\": \"<string>\",\n  \"condition_id\": \"<string>\",\n  \"condition_kwargs\": {},\n  \"expr\": \"<string>\",\n  \"expr_id\": \"<string>\",\n  \"expr_kwargs\": {},\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\": \"<string>\",\n  \"condition_id\": \"<string>\",\n  \"condition_kwargs\": {},\n  \"expr\": \"<string>\",\n  \"expr_id\": \"<string>\",\n  \"expr_kwargs\": {},\n  \"tool_kwargs\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "data": "<unknown>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<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 (via condition or condition_id), payload transformation (via expr or expr_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

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": "<string>",
  "condition_id": "<string>",
  "condition_kwargs": {},
  "expr": "<string>",
  "expr_id": "<string>",
  "expr_kwargs": {},
  "tool_kwargs": {}
}
'

import requests

url = "https://api.example.com/api/hooks"

payload = {
    "execution_key": "<string>",
    "name": "<string>",
    "tool": "<string>",
    "topic": "<string>",
    "condition": "<string>",
    "condition_id": "<string>",
    "condition_kwargs": {},
    "expr": "<string>",
    "expr_id": "<string>",
    "expr_kwargs": {},
    "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: '<string>',
    condition_id: '<string>',
    condition_kwargs: {},
    expr: '<string>',
    expr_id: '<string>',
    expr_kwargs: {},
    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' => '<string>',
    'condition_id' => '<string>',
    'condition_kwargs' => [
        
    ],
    'expr' => '<string>',
    'expr_id' => '<string>',
    'expr_kwargs' => [
        
    ],
    '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\": \"<string>\",\n  \"condition_id\": \"<string>\",\n  \"condition_kwargs\": {},\n  \"expr\": \"<string>\",\n  \"expr_id\": \"<string>\",\n  \"expr_kwargs\": {},\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\": \"<string>\",\n  \"condition_id\": \"<string>\",\n  \"condition_kwargs\": {},\n  \"expr\": \"<string>\",\n  \"expr_id\": \"<string>\",\n  \"expr_kwargs\": {},\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\": \"<string>\",\n  \"condition_id\": \"<string>\",\n  \"condition_kwargs\": {},\n  \"expr\": \"<string>\",\n  \"expr_id\": \"<string>\",\n  \"expr_kwargs\": {},\n  \"tool_kwargs\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "data": "<unknown>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

x-api-key

string

header

required

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.

execution_key

string

required

The api-key user_id the hook fires as; its live stored grants authorize every tool call the fire makes.

Minimum string length: 1

name

string

required

Minimum string length: 1

tool

string

required

Minimum string length: 1

topic

string

required

Minimum string length: 1

condition

string | null

condition_id

string | null

condition_kwargs

Condition Kwargs · object

expr

string | null

expr_id

string | null

expr_kwargs

Expr Kwargs · object

tool_kwargs

Tool Kwargs · object

Response

Success.

data

any

required

List registered hooks Bind a webhook verifier to a topic

HTTP API

CLI

Settings

Conversation bridge

Python SDK

Catalog

Studio SDK

Register a hook

Authorizations

Body

Response