Register a webhook

⚠️

Preview — this feature is being built; the design below is the spec.

POST https://app.syntic.ai/v1/webhooks

Register an HTTPS endpoint to receive signed event deliveries for the key’s workspace. The response contains the signing secret, which is shown only here; store it with your other secrets and use it to verify every delivery.

For how this fits into a full workflow, see Webhooks.

Headers

Header	Required	Value
`Authorization`	Yes	`Bearer <key>`: a private inference key (`sk_live_...`). See Authentication.
`syntic-beta`	Yes, while in preview	`webhooks-2026-11-01`. Without it the call fails with `400 beta_required`. See Versioning.
`Content-Type`	Yes	`application/json`
`Idempotency-Key`	No	Up to 255 characters. Retrying with the same key within 24 hours returns the first result instead of creating a duplicate. See Idempotency.

Body parameters

Parameter	Type	Required	Notes
`url`	string	Yes	`https://` only, a public address, up to 2,048 characters. Redirects are not followed.
`events`	array of strings	Yes	Event types such as `batch.completed`, or `["*"]` for every type.
`description`	string	No	Up to 200 characters.
`status`	string	No	`enabled` (default) or `disabled`.

Response

201 Created, Content-Type: application/json

{
  "id": "whk_01JCA4C6E8G0J2L4N6Q8",
  "object": "webhook",
  "url": "https://hooks.example.com/syntic",
  "events": [
    "batch.completed",
    "session.requires_action",
    "deployment.run.failed"
  ],
  "description": "Ops alerts",
  "status": "enabled",
  "workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
  "created_at": "2026-11-05T09:00:00Z",
  "updated_at": "2026-11-05T09:00:00Z",
  "last_delivery": null,
  "signing_secret": "whsec_6Jt2Qm9...redacted"
}

Field	Type	Description
`id`	string	Starts with `whk_`.
`object`	string	Always `webhook`.
`url`	string	Where deliveries are sent. HTTPS, public address.
`events`	array	Event types delivered, or `["*"]` for all.
`description`	string or null	Up to 200 characters.
`status`	string	`enabled` or `disabled`. Syntic disables an endpoint that has failed every delivery for 3 days.
`workspace_id`	string	Only this workspace’s events are delivered.
`created_at`	string	RFC 3339 UTC.
`updated_at`	string	RFC 3339 UTC.
`last_delivery`	object or null	Time, HTTP status and outcome of the most recent attempt.
`signing_secret`	string	Starts with `whsec_`. Returned only by this call and by rotate-secret.

Examples

curl -sS https://app.syntic.ai/v1/webhooks \
  -H "Authorization: Bearer $SYNTIC_API_KEY" \
  -H "syntic-beta: webhooks-2026-11-01" \
  -H "Idempotency-Key: 8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69" \
  -H "Content-Type: application/json" \
  -d '{
      "url": "https://hooks.example.com/syntic",
      "events": [
        "batch.completed",
        "session.requires_action",
        "deployment.run.failed"
      ],
      "description": "Ops alerts"
    }'

import os
 
import requests
 
resp = requests.post(
    "https://app.syntic.ai/v1/webhooks",
    headers={
        "Authorization": f"Bearer {os.environ['SYNTIC_API_KEY']}",
        "syntic-beta": "webhooks-2026-11-01",
        "Idempotency-Key": "8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69",
    },
    json={
        "url": "https://hooks.example.com/syntic",
        "events": [
            "batch.completed",
            "session.requires_action",
            "deployment.run.failed",
        ],
        "description": "Ops alerts",
    },
    timeout=60,
)
data = resp.json()
if not resp.ok:
    raise RuntimeError(f"{resp.status_code} {data['error']['code']}: {data['error']['message']}")
print(data)

const res = await fetch('https://app.syntic.ai/v1/webhooks', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SYNTIC_API_KEY}`,
    'syntic-beta': 'webhooks-2026-11-01',
    'Idempotency-Key': '8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "url": "https://hooks.example.com/syntic",
    "events": [
      "batch.completed",
      "session.requires_action",
      "deployment.run.failed"
    ],
    "description": "Ops alerts"
  }),
})
const data = await res.json()
if (!res.ok) throw new Error(`${res.status} ${data.error.code}: ${data.error.message}`)
console.log(data)

package main
 
import (
	"fmt"
	"io"
	"net/http"
	"os"
	"strings"
)
 
func main() {
	body := strings.NewReader(`{
  "url": "https://hooks.example.com/syntic",
  "events": [
    "batch.completed",
    "session.requires_action",
    "deployment.run.failed"
  ],
  "description": "Ops alerts"
}`)
	req, err := http.NewRequest("POST", "https://app.syntic.ai/v1/webhooks", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("SYNTIC_API_KEY"))
	req.Header.Set("syntic-beta", "webhooks-2026-11-01")
	req.Header.Set("Idempotency-Key", "8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69")
	req.Header.Set("Content-Type", "application/json")
 
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
 
	out, _ := io.ReadAll(resp.Body)
	if resp.StatusCode >= 300 {
		panic(fmt.Sprintf("%d: %s", resp.StatusCode, out))
	}
	fmt.Println(string(out))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
 
public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "url": "https://hooks.example.com/syntic",
              "events": [
                "batch.completed",
                "session.requires_action",
                "deployment.run.failed"
              ],
              "description": "Ops alerts"
            }
            """;
        HttpRequest request = HttpRequest.newBuilder(URI.create("https://app.syntic.ai/v1/webhooks"))
            .header("Authorization", "Bearer " + System.getenv("SYNTIC_API_KEY"))
            .header("syntic-beta", "webhooks-2026-11-01")
            .header("Idempotency-Key", "8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        if (response.statusCode() >= 300) {
            throw new RuntimeException(response.statusCode() + ": " + response.body());
        }
        System.out.println(response.body());
    }
}

using System.Net.Http.Headers;
using System.Text;
 
using var http = new HttpClient();
using var request = new HttpRequestMessage(new HttpMethod("POST"), "https://app.syntic.ai/v1/webhooks");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("SYNTIC_API_KEY"));
request.Headers.Add("syntic-beta", "webhooks-2026-11-01");
request.Headers.Add("Idempotency-Key", "8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69");
request.Content = new StringContent("""
    {
      "url": "https://hooks.example.com/syntic",
      "events": [
        "batch.completed",
        "session.requires_action",
        "deployment.run.failed"
      ],
      "description": "Ops alerts"
    }
    """, Encoding.UTF8, "application/json");
 
using var response = await http.SendAsync(request);
var text = await response.Content.ReadAsStringAsync();
if (!response.IsSuccessStatusCode) throw new Exception($"{(int)response.StatusCode}: {text}");
Console.WriteLine(text);

<?php
$body = <<<'JSON'
{
  "url": "https://hooks.example.com/syntic",
  "events": [
    "batch.completed",
    "session.requires_action",
    "deployment.run.failed"
  ],
  "description": "Ops alerts"
}
JSON;
 
$ch = curl_init('https://app.syntic.ai/v1/webhooks');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('SYNTIC_API_KEY'),
        'syntic-beta: webhooks-2026-11-01',
        'Idempotency-Key: 8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => $body,
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);
 
if ($status >= 300) {
    throw new RuntimeException("$status: $response");
}
print_r(json_decode($response, true));

require "json"
require "net/http"
require "uri"
 
uri = URI("https://app.syntic.ai/v1/webhooks")
req = Net::HTTP::Post.new(uri)
req["Authorization"] = "Bearer #{ENV.fetch('SYNTIC_API_KEY')}"
req["syntic-beta"] = "webhooks-2026-11-01"
req["Idempotency-Key"] = "8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69"
req["Content-Type"] = "application/json"
req.body = <<~'JSON'
  {
    "url": "https://hooks.example.com/syntic",
    "events": [
      "batch.completed",
      "session.requires_action",
      "deployment.run.failed"
    ],
    "description": "Ops alerts"
  }
JSON
 
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
raise "#{res.code}: #{res.body}" unless res.is_a?(Net::HTTPSuccess)
puts JSON.pretty_generate(JSON.parse(res.body))

Errors

Errors use the error envelope and carry a request_id. Codes specific to this operation:

Status	`type`	`code`	When
400	`invalid_request_error`	`beta_required`	The `syntic-beta` header is missing.
400	`invalid_request_error`	`invalid_url`	Not HTTPS, not a public address, or too long.
400	`invalid_request_error`	`unknown_event_type`	An entry in `events` is not a known type.
409	`conflict_error`	`webhook_limit_reached`	The workspace already has 20 endpoints.
401	`authentication_error`	`invalid_api_key`	The key is missing, unknown, revoked or expired.
429	`rate_limit_error`	`rate_limited`	Too many requests; wait for `Retry-After`. See Rate-limit headers.

Organization-wide events

Spend and security events that concern the whole organization can also be registered with an Admin API key at /v1/organizations/webhooks, which accepts the same body and returns the same object.

Webhooks List webhooks

Was this page helpful?