Docs menu

Docs / Send a test message

Send a test message

Last updated 2026-11-13

Queue a signed test message.

POST/v1/webhooks/{id}/test · API key required

Queues a message of type test with no recall attached. It is sent within about 5 minutes, signed like every other message, and shows in the delivery log.

Parameters

NameInRequiredDescription
idpathyesThe webhook id. Example: wh_3f9a1c07b2d4

Request

curl -X POST https://recalldb.app/v1/webhooks/wh_3f9a1c07b2d4/test \
  -H "Authorization: Bearer $RECALLDB_KEY"
const res = await fetch('https://recalldb.app/v1/webhooks/wh_3f9a1c07b2d4/test', {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.RECALLDB_KEY}` },
})
console.log(await res.json())
import os, requests

r = requests.post("https://recalldb.app/v1/webhooks/wh_3f9a1c07b2d4/test", headers={"Authorization": f"Bearer {os.environ['RECALLDB_KEY']}"})
r.raise_for_status()
body = r.json()
print(body)

Response

200 OK
{
  "data": {
    "event_id": "test_a1b2c3d4e5f6",
    "queued": true,
    "note": "The test message is sent within about 5 minutes."
  }
}

Every response includes source (agency, official ID, official URL, last updated) and attribution. Attribution rules.

Notes

  • Counts as one request.

Errors: error codes. Limits: rate limits.