Skip to main content
Webhook delivery is coming soon. This page documents the planned event shapes so you can design your integration now. In the meantime, use the polling recipe below.

Planned events

session.completed

Fired when a candidate completes their session and all artifacts have been generated.

assessment.key.redeemed

Fired when a candidate redeems their key by running promptster start.

Polling recipe (interim)

Until webhooks are available, poll the sessions endpoint to detect completed assessments.

Basic polling

Key status polling

To track when candidates redeem their keys:
A polling interval of 30-60 seconds is recommended. Shorter intervals provide faster detection but consume more API quota. The 300 req/min rate limit allows up to 5 assessments polled every second.

Webhook configuration (planned)

When webhooks launch, you will be able to configure them in the dashboard under Settings > Webhooks or via the API:
  • Endpoint URL: Your HTTPS endpoint that receives POST requests
  • Events: Select which events to subscribe to
  • Secret: HMAC-SHA256 signing secret for payload verification
  • Retry policy: Failed deliveries will be retried with exponential backoff (1m, 5m, 30m, 2h)
Webhook payloads will include a X-Promptster-Signature header for verification.