Register webhook
curl --request POST \
--url https://api.kitefrost.ai/v1/projects/{project_id}/webhooks \
--header 'Content-Type: application/json' \
--data '
{
"description": "Production server",
"events": [
"npc.created",
"generation.completed",
"generation.failed"
],
"url": "https://example.com/webhooks/kitefrost"
}
'import requests
url = "https://api.kitefrost.ai/v1/projects/{project_id}/webhooks"
payload = {
"description": "Production server",
"events": ["npc.created", "generation.completed", "generation.failed"],
"url": "https://example.com/webhooks/kitefrost"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
description: 'Production server',
events: ['npc.created', 'generation.completed', 'generation.failed'],
url: 'https://example.com/webhooks/kitefrost'
})
};
fetch('https://api.kitefrost.ai/v1/projects/{project_id}/webhooks', 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.kitefrost.ai/v1/projects/{project_id}/webhooks",
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([
'description' => 'Production server',
'events' => [
'npc.created',
'generation.completed',
'generation.failed'
],
'url' => 'https://example.com/webhooks/kitefrost'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.kitefrost.ai/v1/projects/{project_id}/webhooks"
payload := strings.NewReader("{\n \"description\": \"Production server\",\n \"events\": [\n \"npc.created\",\n \"generation.completed\",\n \"generation.failed\"\n ],\n \"url\": \"https://example.com/webhooks/kitefrost\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.kitefrost.ai/v1/projects/{project_id}/webhooks")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"Production server\",\n \"events\": [\n \"npc.created\",\n \"generation.completed\",\n \"generation.failed\"\n ],\n \"url\": \"https://example.com/webhooks/kitefrost\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kitefrost.ai/v1/projects/{project_id}/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"Production server\",\n \"events\": [\n \"npc.created\",\n \"generation.completed\",\n \"generation.failed\"\n ],\n \"url\": \"https://example.com/webhooks/kitefrost\"\n}"
response = http.request(request)
puts response.read_body{
"webhook_id": "<string>",
"project_id": "<string>",
"url": "<string>",
"events": [
"<string>"
],
"active": true,
"description": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"disabled_at": "2023-11-07T05:31:56Z",
"disabled_reason": "<string>",
"last_delivered_at": "2023-11-07T05:31:56Z",
"last_error": "<string>",
"consecutive_failures": 0,
"secret": "<string>"
}{
"error": "Not found",
"code": "not_found",
"request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"message": "The requested resource does not exist.",
"doc_url": "https://docs.kitefrost.ai/errors/not_found"
}{
"error": "Internal server error",
"code": "internal_error",
"request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"message": "An unexpected error occurred.",
"doc_url": "https://docs.kitefrost.ai/errors/internal_error"
}webhooks
Register webhook
Register an HTTPS endpoint to receive event notifications. Deliveries are signed with HMAC-SHA256 over {timestamp}.{body}; verify the X-Webhook-Signature header. The URL is validated against the SSRF blocklist before registration. Requires scope: webhooks:manage.
POST
/
v1
/
projects
/
{project_id}
/
webhooks
Register webhook
curl --request POST \
--url https://api.kitefrost.ai/v1/projects/{project_id}/webhooks \
--header 'Content-Type: application/json' \
--data '
{
"description": "Production server",
"events": [
"npc.created",
"generation.completed",
"generation.failed"
],
"url": "https://example.com/webhooks/kitefrost"
}
'import requests
url = "https://api.kitefrost.ai/v1/projects/{project_id}/webhooks"
payload = {
"description": "Production server",
"events": ["npc.created", "generation.completed", "generation.failed"],
"url": "https://example.com/webhooks/kitefrost"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
description: 'Production server',
events: ['npc.created', 'generation.completed', 'generation.failed'],
url: 'https://example.com/webhooks/kitefrost'
})
};
fetch('https://api.kitefrost.ai/v1/projects/{project_id}/webhooks', 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.kitefrost.ai/v1/projects/{project_id}/webhooks",
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([
'description' => 'Production server',
'events' => [
'npc.created',
'generation.completed',
'generation.failed'
],
'url' => 'https://example.com/webhooks/kitefrost'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.kitefrost.ai/v1/projects/{project_id}/webhooks"
payload := strings.NewReader("{\n \"description\": \"Production server\",\n \"events\": [\n \"npc.created\",\n \"generation.completed\",\n \"generation.failed\"\n ],\n \"url\": \"https://example.com/webhooks/kitefrost\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.kitefrost.ai/v1/projects/{project_id}/webhooks")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"Production server\",\n \"events\": [\n \"npc.created\",\n \"generation.completed\",\n \"generation.failed\"\n ],\n \"url\": \"https://example.com/webhooks/kitefrost\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kitefrost.ai/v1/projects/{project_id}/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"Production server\",\n \"events\": [\n \"npc.created\",\n \"generation.completed\",\n \"generation.failed\"\n ],\n \"url\": \"https://example.com/webhooks/kitefrost\"\n}"
response = http.request(request)
puts response.read_body{
"webhook_id": "<string>",
"project_id": "<string>",
"url": "<string>",
"events": [
"<string>"
],
"active": true,
"description": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"disabled_at": "2023-11-07T05:31:56Z",
"disabled_reason": "<string>",
"last_delivered_at": "2023-11-07T05:31:56Z",
"last_error": "<string>",
"consecutive_failures": 0,
"secret": "<string>"
}{
"error": "Not found",
"code": "not_found",
"request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"message": "The requested resource does not exist.",
"doc_url": "https://docs.kitefrost.ai/errors/not_found"
}{
"error": "Internal server error",
"code": "internal_error",
"request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"message": "An unexpected error occurred.",
"doc_url": "https://docs.kitefrost.ai/errors/internal_error"
}Body
application/json
POST /v1/projects/{project_id}/webhooks
HTTPS URL for webhook delivery (must pass SSRF validation)
Event types to subscribe to. See the canonical catalog in the docs.
Minimum array length:
1HMAC-SHA256 signing secret (min 16 chars). Omit to have the server mint one.
Required string length:
16 - 128Optional human-readable label shown on the dashboard.
Maximum string length:
200Response
Webhook registered - secret shown once
Webhook subscription representation.
secret is set only on the create + rotate-secret responses; list,
get, and patch responses omit it.
⌘I