API reference

POSTSend a test event

POST /v1/webhook_endpoints/{endpoint_id}/test: Queues one ping event to this endpoint (at most 30 test sends per hour per organization).

POSThttps://api.light-ai.app/v1/webhook_endpoints/{endpoint_id}/test

Queues one ping event to this endpoint (at most 30 test sends per hour per organization). In test mode each ping is also one of the organization's 500 test deliveries a day: past that it is refused (429 rate_limited, limit_scope test_deliveries, Retry-After until midnight UTC), never answered without a delivery. An endpoint that cannot receive it answers 409 stale_state.

Scope	`webhooks:manage`
Credential	API key: `Authorization: Bearer lai_live_…` (or `lai_test_…`). Partner keys add `Light-AI-Organization`.
Test mode	Works with test keys (test objects only).
Idempotency	`Idempotency-Key` supported. See Idempotency.

Path parameters#

endpoint_idstringrequired#

The endpoint id (we_…). Id prefix we_.

Headers#

Light-AI-Organizationstring#

Partner keys: the connected organization to act for (org_…). Organization keys may omit it. Id prefix org_.

Light-AI-Versionstring#

Pin a dated API version (defaults to the key's version). One of: 2026-11-01.

Idempotency-Keystring#

Retry-safe writes: the same key and body replay the first response for 24 hours (Idempotent-Replayed: true). 8–128 characters.

Request body#

An empty JSON object ({}) or no body.

Response 200#

The queued ping (delivery_id is the delivery to watch).

objectstringrequired#

Always webhook_test.

event_idstringrequired#

Id prefix evt_.

delivery_idstringrequired#

The queued delivery (a ping is never answered without one). Id prefix whd_.

Errors#

Status	Meaning
`400`	Bad request. `bad_request`, `test_mode_mismatch`, `test_mode_unsupported`, `unsupported_api_version`
`401`	Missing or invalid credential. `authentication_required`, `invalid_api_key`, `api_key_revoked`, `api_key_expired`, `api_key_suspended`
`403`	Not allowed. `insufficient_scope`, `plan_upgrade_required`, `organization_paused`, `organization_off_season`, `api_disabled`, `api_access_not_enabled`, `ip_not_allowed`, `forbidden`
`404`	Not found (also for objects of other organizations and for organizations without an active grant).
`409`	Conflict. `stale_state`, `conflict`, `idempotency_in_progress`, `idempotency_scope_mismatch`, `quote_already_decided`, `quote_not_current`, `billing_review_required`
`413`	Request bodies are limited to 256 KB.
`415`	The body is not JSON: send Content-Type: application/json. `unsupported_media_type`
`422`	Validation failed. `idempotency_key_reused`
`429`	Rate limited or daily cap reached. See Retry-After and the RateLimit headers. `rate_limited`, `daily_cap_reached`
`500`	Unexpected server error. Safe to retry with exponential backoff; quote the Request-Id to support. `internal_error`
`503`	Temporarily unavailable. Retry with exponential backoff. `service_unavailable`

Request

curl -X POST "https://api.light-ai.app/v1/webhook_endpoints/{endpoint_id}/test" \
  -H "Authorization: Bearer $LIGHT_AI_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

const response = await fetch('https://api.light-ai.app/v1/webhook_endpoints/{endpoint_id}/test', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LIGHT_AI_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
  },
});
const data = await response.json();

import os, uuid, requests

response = requests.post(
    "https://api.light-ai.app/v1/webhook_endpoints/{endpoint_id}/test",
    headers={
        "Authorization": f"Bearer {os.environ['LIGHT_AI_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    timeout=30,
)
data = response.json()

Response 200JSON

{
  "object": "webhook_test",
  "event_id": "evt_3f9c2a7be41d…",
  "delivery_id": "whd_3f9c2a7be41d…"
}