Send a test event

Parameters

Header Idempotency-Key (optional, up to 255 characters): retry with the same key and body within 24 hours and you get the first response back (Idempotent-Replayed: true) – the request is not run twice. Another body: 422 idempotency_key_reused; still running: 409 idempotency_key_in_progress. More.

Example request

curl -X POST https://www.helprange.com/api/v2/webhook-endpoints/3/test \
  -H "X-API-Key: $HELPRANGE_API_KEY"

const res = await fetch('https://www.helprange.com/api/v2/webhook-endpoints/3/test', {
  method: 'POST',
  headers: {'X-API-Key': process.env.HELPRANGE_API_KEY},
});
const data = await res.json();
if (!res.ok) throw new Error(`${res.status}: ${data.error || data.message || data.reason}`);
console.log(data);

import os

import requests

r = requests.post(
    'https://www.helprange.com/api/v2/webhook-endpoints/3/test',
    headers={'X-API-Key': os.environ['HELPRANGE_API_KEY']},
    timeout=60,
)
r.raise_for_status()
print(r.json())

The samples read the key from the HELPRANGE_API_KEY environment variable.

Responses

{
  "id": 812,
  "event_id": "evt_3f9c2b7e0d1a4c5b8e6f7a9d0c1b2e3f",
  "event_type": "document.opened",
  "status": "delivered",
  "test": true,
  "attempts": 1,
  "last_status_code": 200,
  "last_error": null,
  "last_duration_ms": 143,
  "created_at": "2026-11-15T09:12:03+00:00",
  "last_attempt_at": "2026-11-15T09:12:03+00:00",
  "next_attempt_at": null,
  "delivered_at": "2026-11-15T09:12:03+00:00",
  "payload": {
    "id": "evt_3f9c2b7e0d1a4c5b8e6f7a9d0c1b2e3f",
    "event": "document.opened",
    "api_version": "2026-11-15",
    "created_at": "2026-11-15T09:12:03.512345Z",
    "data": {}
  },
  "delivered": true
}

Try it