Get a webhook
⚠️
Preview — this feature is being built; the design below is the spec.
GET https://app.syntic.ai/v1/webhooks/{webhook_id}Return one webhook endpoint, including the outcome of its most recent 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. |
Path parameters
| Parameter | Type | Description |
|---|---|---|
webhook_id | string | The webhook id, starting with whk_. |
Response
200 OK, 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": {
"at": "2026-11-05T10:00:02Z",
"status_code": 200,
"succeeded": true
}
}| 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. |
Examples
curl -sS https://app.syntic.ai/v1/webhooks/whk_01JCA4C6E8G0J2L4N6Q8 \
-H "Authorization: Bearer $SYNTIC_API_KEY" \
-H "syntic-beta: webhooks-2026-11-01"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. |
| 404 | not_found_error | webhook_not_found | No webhook with that id in this workspace. |
| 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. |
Related
Was this page helpful?