webhooks

Register a webhook endpoint

The signing secret is shown once; deliveries carry Portproof-Signature: t=<unix>,v1=<hex hmac-sha256(secret, t + "." + body)>. Requires an Idempotency-Key header (CONTRACT §1): the same key with the same body within 24 h replays the stored response; a different body returns 409 idempotency_conflict.

post/v1/webhooks

Request

  • Base URL: https://api.portproof.org
  • URL: https://api.portproof.org/v1/webhooks
  • Auth: HTTP bearer

Request body

urlstring uri required
eventsstring[] required

Response

Default Response

idstring required
urlstring uri required
eventsstring[] required
secretstring required

Changes

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