Webhooks / REFERENCE

Send a test event

Send synthetic data only. HTTP 200 reports the receiver outcome in delivered/status, or ok:false on network failure. No redirects are followed.

POST/api/v1/webhooks/{id}/test

Permissions webhooks:test + ideas:read

Parameters

Name	Description
`X-Luma-Workspace-Host`header · required	Your workspace host, e.g. acme.lumi-cx.com. Required on api.lumi-cx.com. This header never grants access: the Bearer key must belong to the selected workspace.
`id`path · required	Record identifier in this workspace.

200 Successful operation

{
  "ok": true,
  "delivered": false,
  "status": 1,
  "details": "example",
  "hint": "example",
  "error": "example",
  "message": "example"
}

400 Invalid request

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}

401 Missing, invalid, expired, revoked or wrong-workspace key

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}

403 Required key permission missing, module unavailable, or workspace suspended

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}

404 Record, workspace or route not found

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}

429 Rate limit exceeded; respect Retry-After

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}

502 Upstream or unexpected server error

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}