Webhooks

Register an https endpoint

The URL must be public https; private, loopback and VPN addresses are refused. The secret is returned once. Up to 5 active endpoints per account. Events are sent only for proofs created after registration.

post/api/v1/webhooks

Request

  • Base URL: https://proofledger.io
  • URL: https://proofledger.io/api/v1/webhooks
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Optional. Any unique string, 1 to 200 printable ASCII characters, no spaces. A resend with the same key and the same body within 24 hours returns the stored 2xx response (same status, same JSON) with Idempotent-Replayed: true and runs nothing twice. The same key with a different body is refused with 422; a duplicate that arrives while the first request is still running gets 409. Only 2xx responses are stored, so after a 4xx the same key accepts a corrected body. Scoped to your account and to the route.

Request body

urlstring uri required
eventsstring[]

Defaults to proof.polygon.anchored. proof.bitcoin.anchored is a retired name, accepted so old clients are not refused, and never sent (Bitcoin anchoring ended 2026-10-15).

Example request

{
  "url": "https://api.example.com/proofledger/events"
}

Response

Registered.

secretstring
messagestring

Example response

{
  "secret": "whsec_..."
}

Changes

No recorded changes to this operation across all 1 revision of this API.