Send a test event to a webhook

THE CALL, PART BY PART

method

POST

host

strait.link

version

/v1

resource

/webhooks/{id}/test

POST /v1/webhooks/{id}/test

Auth: secret key as Authorization: Bearer. Server-side only.

Request

Delivers a ping event to the webhook right now (even if paused) and returns the receiver's HTTP status and the time it took (never its response body). Not stored or retried. Every delivery is signed: X-Strait-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of "<t>.<raw body>" with the webhook secret> — recompute it and refuse timestamps more than 5 minutes old. It is the only signature header. Other headers: X-Strait-Event, X-Strait-Delivery (stable across retries — de-duplicate on it), X-Strait-Attempt. Events: link.clicked, app.opened, install.matched, referral.converted and app.event (POST /v1/event). Webhook URLs must be public https endpoints: private, loopback, link-local and CGNAT addresses are refused when saved and again at every delivery, when the connection is made (after DNS resolution).

Parameters

id required string path
The webhook id (Dashboard → Settings → Webhooks)

Response

  • 200 The attempt (delivered or not)
  • 401 Missing or invalid secret key
  • 404 No such webhook in the key's workspace
Request · curl
curl -X POST https://strait.link/v1/webhooks/<webhook id>/test \
  -H "Authorization: Bearer $SECRET_KEY"

The response, printed

Response 200
{
  "delivered": true,
  "status": 204,
  "error": null,
  "body": "",
  "durationMs": 182,
  "deliveryId": "0b9c3f0e-5a7d-4a51-9a2e-3f1c8d2b6e47",
  "event": "ping"
}