Skip to content
Sign in Waitlist

Get webhook

GET /v1/webhooks/:id scope admin

One webhook (without the secret).

HeadersAuthorization: Bearer praeko_… and X-Praeko-Contract: en. Always send both.

Parameters

Name In Description
id path Webhook id (starts with wh_).

Example

curl "https://praeko.app/v1/webhooks/wh_01KA3X4D8P6TQ1VZ0C7MH2NB5R" \
  -H "Authorization: Bearer $PRAEKO_KEY" \
  -H "X-Praeko-Contract: en"

Response

Success status When
200 Success.
Response 200
{
  "id": "wh_01KA3X4D8P6TQ1VZ0C7MH2NB5R",
  "url": "https://example.com/hooks/praeko",
  "events": [
    "post.sent",
    "post.failed"
  ],
  "active": true,
  "secretHint": "whsec_…k3Qw",
  "consecutiveFailures": 0,
  "createdAt": "2026-11-07T14:02:11.482Z",
  "updatedAt": "2026-11-07T14:02:11.482Z"
}

Errors

Status code When
404 webhook_not_found The webhook does not exist.

Errors on any route

Status code When
401 unauthorized The Authorization: Bearer … header is missing.
401 invalid_api_key The key does not exist.
401 revoked_api_key The key has been revoked.
401 expired_api_key The key has expired.
403 forbidden The key's scope is not enough for this route (see the scope badge).
429 rate_limited The per-minute request limit was exceeded.

The body of every error is { "error": { "code", "message", "details"? } }. See all error codes.

Try it

Try it

The live test uses your key and your account. It stays off when you are not signed in.

Sign in to try it
Question or mistake on this page? contato@praeko.appView .md

Type to search pages, routes and error codes.