Create a webhook for a team
curl --request POST \
--url https://core.cyberun.cloud/api/v1/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"display_name": "Task Completion Notifier",
"webhook_url": "https://my-app.example.com/webhooks/cyberun",
"webhook_events": [
"task.completed",
"task.failed"
]
}
'import requests
url = "https://core.cyberun.cloud/api/v1/webhooks"
payload = {
"display_name": "Task Completion Notifier",
"webhook_url": "https://my-app.example.com/webhooks/cyberun",
"webhook_events": ["task.completed", "task.failed"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
display_name: 'Task Completion Notifier',
webhook_url: 'https://my-app.example.com/webhooks/cyberun',
webhook_events: ['task.completed', 'task.failed']
})
};
fetch('https://core.cyberun.cloud/api/v1/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://core.cyberun.cloud/api/v1/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([
'display_name' => 'Task Completion Notifier',
'webhook_url' => 'https://my-app.example.com/webhooks/cyberun',
'webhook_events' => [
'task.completed',
'task.failed'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://core.cyberun.cloud/api/v1/webhooks"
payload := strings.NewReader("{\n \"display_name\": \"Task Completion Notifier\",\n \"webhook_url\": \"https://my-app.example.com/webhooks/cyberun\",\n \"webhook_events\": [\n \"task.completed\",\n \"task.failed\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://core.cyberun.cloud/api/v1/webhooks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"display_name\": \"Task Completion Notifier\",\n \"webhook_url\": \"https://my-app.example.com/webhooks/cyberun\",\n \"webhook_events\": [\n \"task.completed\",\n \"task.failed\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core.cyberun.cloud/api/v1/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"display_name\": \"Task Completion Notifier\",\n \"webhook_url\": \"https://my-app.example.com/webhooks/cyberun\",\n \"webhook_events\": [\n \"task.completed\",\n \"task.failed\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "019abc12-3456-7890-abcd-ef1234567890"
}{
"error_message": "resource not found"
}{
"error_message": "resource not found"
}{
"error_message": "resource not found"
}Webhook
Create a webhook for a team
Registers a new webhook endpoint that will receive HTTP POST notifications for subscribed events. Returns the webhook ID and a signing secret.
POST
/
webhooks
Create a webhook for a team
curl --request POST \
--url https://core.cyberun.cloud/api/v1/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"display_name": "Task Completion Notifier",
"webhook_url": "https://my-app.example.com/webhooks/cyberun",
"webhook_events": [
"task.completed",
"task.failed"
]
}
'import requests
url = "https://core.cyberun.cloud/api/v1/webhooks"
payload = {
"display_name": "Task Completion Notifier",
"webhook_url": "https://my-app.example.com/webhooks/cyberun",
"webhook_events": ["task.completed", "task.failed"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
display_name: 'Task Completion Notifier',
webhook_url: 'https://my-app.example.com/webhooks/cyberun',
webhook_events: ['task.completed', 'task.failed']
})
};
fetch('https://core.cyberun.cloud/api/v1/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://core.cyberun.cloud/api/v1/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([
'display_name' => 'Task Completion Notifier',
'webhook_url' => 'https://my-app.example.com/webhooks/cyberun',
'webhook_events' => [
'task.completed',
'task.failed'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://core.cyberun.cloud/api/v1/webhooks"
payload := strings.NewReader("{\n \"display_name\": \"Task Completion Notifier\",\n \"webhook_url\": \"https://my-app.example.com/webhooks/cyberun\",\n \"webhook_events\": [\n \"task.completed\",\n \"task.failed\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://core.cyberun.cloud/api/v1/webhooks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"display_name\": \"Task Completion Notifier\",\n \"webhook_url\": \"https://my-app.example.com/webhooks/cyberun\",\n \"webhook_events\": [\n \"task.completed\",\n \"task.failed\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core.cyberun.cloud/api/v1/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"display_name\": \"Task Completion Notifier\",\n \"webhook_url\": \"https://my-app.example.com/webhooks/cyberun\",\n \"webhook_events\": [\n \"task.completed\",\n \"task.failed\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "019abc12-3456-7890-abcd-ef1234567890"
}{
"error_message": "resource not found"
}{
"error_message": "resource not found"
}{
"error_message": "resource not found"
}Authorizations
bearerAuthDeviceAuth
User session JWT (Bearer ). Must be paired with the X-Team-ID
request header on team-scoped endpoints so the server knows which
team's resources to operate on.
Headers
UUID of the team to scope the request to. Used by dual-auth endpoints (runtime + scoped management):
- JWT callers MUST send it — a user may belong to multiple teams and the runtime cannot otherwise know which one to operate on. Missing header → 400.
- Credential callers (
sk-,dk-) can omit it because the team is derived from the credential row itself. Any value sent is ignored.
Example:
"019abc12-4567-7890-abcd-ef1234567891"
Body
application/json
Registers a webhook endpoint. The server signs each delivery payload with HMAC-SHA256 using a generated secret (returned in the webhook detail response).
Webhook Payload Format
Each delivery is an HTTP POST with JSON body:
{
"event_type": "task.completed",
"task_id": "019c65a0-...",
"task_status": "completed",
"task_output": {"storage_key": "tasks/.../output.png", "image_count": 1},
"task_error": "",
"timestamp": "2025-02-16T09:00:00Z"
}
Signature Verification
Each delivery includes an X-Webhook-Signature-256 header:
X-Webhook-Signature-256: sha256=<hex_hmac>
Verify by computing HMAC-SHA256(webhook_secret, raw_body) and comparing.
Retry Policy
Failed deliveries (non-2xx response or timeout) are retried up to 4 times with exponential backoff: immediate → 5s → 30s → 2min.
Human-readable name for the webhook.
Required string length:
1 - 255Example:
"Task Completion Notifier"
HTTPS endpoint URL to receive webhook payloads.
Maximum string length:
2048Pattern:
^https://Example:
"https://my-app.example.com/webhooks/cyberun"
List of event types to subscribe to:
task.completed: Fired when a task finishes successfully.task.failed: Fired when a task fails (including timeout and agent disconnect).
Minimum array length:
1Available options:
task.completed, task.failed Example:
["task.completed", "task.failed"]
Response
Webhook created
UUID of the created or updated resource.
Example:
"019abc12-3456-7890-abcd-ef1234567890"