Cancel a replay - Lumeus

cURL

# Use a subscription id from POST or GET /v1/subscriptions; the placeholder answers 404.
curl --fail-with-body -sS -X DELETE 'https://webhooks-testnet.lumeus.dev/v1/subscriptions/00000000-0000-4000-8000-000000000000/replays/00000000-0000-4000-8000-000000000000' \
  -H "Authorization: Bearer $LUMEUS_WEBHOOK_KEY"

// Node 18+ (ES module)
// Use a subscription id from POST or GET /v1/subscriptions; the placeholder answers 404.
const res = await fetch('https://webhooks-testnet.lumeus.dev/v1/subscriptions/00000000-0000-4000-8000-000000000000/replays/00000000-0000-4000-8000-000000000000', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.LUMEUS_WEBHOOK_KEY}`,
  },
});
console.log(res.status, JSON.stringify(await res.json(), null, 2));

# Use a subscription id from POST or GET /v1/subscriptions; the placeholder answers 404.
import json
import os

import requests

res = requests.delete(
    "https://webhooks-testnet.lumeus.dev/v1/subscriptions/00000000-0000-4000-8000-000000000000/replays/00000000-0000-4000-8000-000000000000",
    headers={"Authorization": f"Bearer {os.environ['LUMEUS_WEBHOOK_KEY']}"},
    timeout=30,
)
print(res.status_code, json.dumps(res.json(), indent=2))

{
  "kind": "retained",
  "id": "00000000-0000-4000-8000-000000000001",
  "subscription_id": "00000000-0000-4000-8000-000000000000",
  "generation": "testnet-2025-12-18-v2",
  "state": "cancelling",
  "quote": {
    "subscription_id": "00000000-0000-4000-8000-000000000000",
    "subscription_version": 2,
    "generation": "testnet-2025-12-18-v2",
    "delivery_ids": [
      1
    ],
    "payload_sha256": [
      "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    ],
    "policy_version": "prepaid-2026-10",
    "target_sha256": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
    "maximum_credits": 1,
    "resources": {
      "bytes": 4096,
      "attempts": 8,
      "work_ms": 0,
      "concurrency": 1,
      "retained_bytes": 0
    },
    "recoverable_until": "2026-10-23T09:15:04Z",
    "quote_sha256": "cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc"
  },
  "pending": 1,
  "delivered": 0,
  "dead": 0,
  "in_flight": 0,
  "created_at": "2026-10-22T09:15:04Z"
}

DELETE

/

v1

/

subscriptions

/

{id}

/

replays

/

{job}

cURL

# Use a subscription id from POST or GET /v1/subscriptions; the placeholder answers 404.
curl --fail-with-body -sS -X DELETE 'https://webhooks-testnet.lumeus.dev/v1/subscriptions/00000000-0000-4000-8000-000000000000/replays/00000000-0000-4000-8000-000000000000' \
  -H "Authorization: Bearer $LUMEUS_WEBHOOK_KEY"

// Node 18+ (ES module)
// Use a subscription id from POST or GET /v1/subscriptions; the placeholder answers 404.
const res = await fetch('https://webhooks-testnet.lumeus.dev/v1/subscriptions/00000000-0000-4000-8000-000000000000/replays/00000000-0000-4000-8000-000000000000', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.LUMEUS_WEBHOOK_KEY}`,
  },
});
console.log(res.status, JSON.stringify(await res.json(), null, 2));

# Use a subscription id from POST or GET /v1/subscriptions; the placeholder answers 404.
import json
import os

import requests

res = requests.delete(
    "https://webhooks-testnet.lumeus.dev/v1/subscriptions/00000000-0000-4000-8000-000000000000/replays/00000000-0000-4000-8000-000000000000",
    headers={"Authorization": f"Bearer {os.environ['LUMEUS_WEBHOOK_KEY']}"},
    timeout=30,
)
print(res.status_code, json.dumps(res.json(), indent=2))

{
  "kind": "retained",
  "id": "00000000-0000-4000-8000-000000000001",
  "subscription_id": "00000000-0000-4000-8000-000000000000",
  "generation": "testnet-2025-12-18-v2",
  "state": "cancelling",
  "quote": {
    "subscription_id": "00000000-0000-4000-8000-000000000000",
    "subscription_version": 2,
    "generation": "testnet-2025-12-18-v2",
    "delivery_ids": [
      1
    ],
    "payload_sha256": [
      "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    ],
    "policy_version": "prepaid-2026-10",
    "target_sha256": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
    "maximum_credits": 1,
    "resources": {
      "bytes": 4096,
      "attempts": 8,
      "work_ms": 0,
      "concurrency": 1,
      "retained_bytes": 0
    },
    "recoverable_until": "2026-10-23T09:15:04Z",
    "quote_sha256": "cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc"
  },
  "pending": 1,
  "delivered": 0,
  "dead": 0,
  "in_flight": 0,
  "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).

Path Parameters

id

string<uuid>

required

Endpoint (subscription) ID from POST /v1/subscriptions or GET /v1/subscriptions. The example ID is a placeholder and answers 404: use your own.

Example:

"00000000-0000-4000-8000-000000000000"

job

string<uuid>

required

Replay job ID from the start response (also in its Location header). The example ID is a placeholder and answers 404: use your own.

Example:

"00000000-0000-4000-8000-000000000000"

Response

The job, now cancelling.

kind

enum<string>

required

retained: a redelivery of retained payloads; source: a source replay.

Available options:

retained,

source

id

string<uuid>

required

subscription_id

string<uuid>

required

generation

string

required

state

string

required

pending

integer

required

delivered

integer

required

dead

integer

required

in_flight

integer

required

created_at

string<date-time>

required

source_quote

object

Show child attributes

source_phase

string

source_attempts

integer

failure_code

string

quote

object

Show child attributes