L lumi developers

Webhooks / REFERENCE

Rotate webhook authentication

Manage only this workspace's idea events. Creation and rotation return a Bearer secret once and disable delivery. Changing the URL also disables delivery; enable explicitly after configuring authentication. At most 50 webhooks per workspace.

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

Permissions webhooks:write + ideas:read

Parameters

NameDescription
X-Luma-Workspace-Hostheader · requiredYour 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.
idpath · requiredRecord identifier in this workspace.

Responses

200 Successful operation
{
  "ok": true,
  "webhook": {
    "id": "00000000-0000-4000-8000-000000000001",
    "name": "Idea notifications",
    "url": "https://receiver.example.com/webhooks/lumi",
    "secretPrefix": "whsec_EXAMPLE",
    "authenticationConfigured": true,
    "events": [
      "idea.submitted"
    ],
    "enabled": false,
    "createdAt": "2026-09-26T09:00:00Z",
    "updatedAt": "2026-09-26T09:00:00Z",
    "secret": "whsec_EXAMPLE_NOT_A_REAL_CREDENTIAL"
  }
}
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"
}
Need an API key? Open Developer Options in your workspace.