Create a webhook key - Lumeus

cURL

curl --fail-with-body -sS -X POST 'https://webhooks-testnet.lumeus.dev/v1/keys' \
  -H "Authorization: Bearer $LUMEUS_WEBHOOK_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"name":"ci-deploy"}'

// Node 18+ (ES module)
const res = await fetch('https://webhooks-testnet.lumeus.dev/v1/keys', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LUMEUS_WEBHOOK_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "ci-deploy"
  }),
});
console.log(res.status, JSON.stringify(await res.json(), null, 2));

import json
import os

import requests

res = requests.post(
    "https://webhooks-testnet.lumeus.dev/v1/keys",
    headers={"Authorization": f"Bearer {os.environ['LUMEUS_WEBHOOK_KEY']}"},
    json={
        "name": "ci-deploy"
    },
    timeout=30,
)
print(res.status_code, json.dumps(res.json(), indent=2))

{
  "id": "00000000-0000-4000-8000-000000000000",
  "tenant_id": "00000000-0000-4000-8000-000000000000",
  "name": "ci-deploy",
  "prefix": "whk_0000…",
  "secret": "whk_0000…",
  "created_at": "2026-10-22T09:15:04Z"
}

POST

/

v1

/

keys

cURL

curl --fail-with-body -sS -X POST 'https://webhooks-testnet.lumeus.dev/v1/keys' \
  -H "Authorization: Bearer $LUMEUS_WEBHOOK_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"name":"ci-deploy"}'

// Node 18+ (ES module)
const res = await fetch('https://webhooks-testnet.lumeus.dev/v1/keys', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LUMEUS_WEBHOOK_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "ci-deploy"
  }),
});
console.log(res.status, JSON.stringify(await res.json(), null, 2));

import json
import os

import requests

res = requests.post(
    "https://webhooks-testnet.lumeus.dev/v1/keys",
    headers={"Authorization": f"Bearer {os.environ['LUMEUS_WEBHOOK_KEY']}"},
    json={
        "name": "ci-deploy"
    },
    timeout=30,
)
print(res.status_code, json.dumps(res.json(), indent=2))

{
  "id": "00000000-0000-4000-8000-000000000000",
  "tenant_id": "00000000-0000-4000-8000-000000000000",
  "name": "ci-deploy",
  "prefix": "whk_0000…",
  "secret": "whk_0000…",
  "created_at": "2026-10-22T09:15:04Z"
}

Authorizations

Authorization

string

header

required

Send Authorization: Bearer whk_…, a webhook key from the dashboard. Webhook keys belong to one network, so pick the server that matches the key. lum_ API keys are not accepted here (401).

Body

application/json

name

string

Label, at most 128 characters.

Maximum string length: 128

expires_at

string<date-time>

Optional expiry, between one minute and five years ahead.

Response

The new key. secret is shown only in this response.

id

string<uuid>

required

tenant_id

string<uuid>

required

prefix

string

required

created_at

string<date-time>

required

name

string

secret

string

Plaintext whk_ key, first creation only.

last_used_at

string<date-time>

Updated at most once a minute.

revoked_at

string<date-time>

expires_at

string<date-time>

The key stops authenticating at this time. Absent: never expires.