Documentation · Webhooks

Webhooks · Overview

Push delivery of lifecycle events instead of polling.

Needs Verification
Purpose
React to assessment lifecycle changes in near real time.
Prerequisites
  • HTTPS endpoint
  • Signing secret storage
Architecture
Subscription → signed POST → 2xx acknowledgement → retry on failure.

Configuration

Timeout5s to acknowledge (illustrative)
SignatureHMAC-SHA256 over timestamp.body

Implementation steps

  1. 01Register the subscription
  2. 02Verify the signature
  3. 03Acknowledge fast, process asynchronously
  4. 04Deduplicate on event id

Testing procedure

  • Use the Webhook Simulator to deliver each event and inspect retries

Troubleshooting

Events stop arriving

Subscription auto-disabled after repeated failures; check delivery history.