API referenceWebhooksSend a test event

Send a test event

⚠️
Preview — this feature is being built; the design below is the spec.
POST https://app.syntic.ai/v1/webhooks/{webhook_id}/test

Send a webhook.test event to the endpoint right away and report what happened. Use it after registering an endpoint or changing your verification code.

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

Headers

HeaderRequiredValue
AuthorizationYesBearer <key>: a private inference key (sk_live_...). See Authentication.
syntic-betaYes, while in previewwebhooks-2026-11-01. Without it the call fails with 400 beta_required. See Versioning.

Path parameters

ParameterTypeDescription
webhook_idstringThe webhook id, starting with whk_.

Response

200 OK, Content-Type: application/json

{
  "delivery_id": "dlv_01JCB2M4P6R8T0V2X4Z6",
  "event_id": "evt_01JCB2M3N5Q7S9U1W3Y5",
  "status_code": 200,
  "succeeded": true,
  "duration_ms": 184
}
FieldTypeDescription
delivery_idstringThe attempt, as listed in the delivery log.
status_codeinteger or nullYour endpoint’s HTTP status, or null if it could not be reached.
succeededbooleantrue for any 2xx within 10 seconds.
duration_msintegerTime until your endpoint answered.

Examples

curl -sS -X POST https://app.syntic.ai/v1/webhooks/whk_01JCA4C6E8G0J2L4N6Q8/test \
  -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:

StatustypecodeWhen
400invalid_request_errorbeta_requiredThe syntic-beta header is missing.
404not_found_errorwebhook_not_foundNo webhook with that id in this workspace.
409conflict_errorwebhook_disabledThe endpoint is disabled; enable it first.
401authentication_errorinvalid_api_keyThe key is missing, unknown, revoked or expired.
429rate_limit_errorrate_limitedToo many requests; wait for Retry-After. See Rate-limit headers.
Was this page helpful?