Documentation · Webhooks

Set Up Result Webhooks

Send signed result events from API Exams to Studio.

Verified
Purpose
Send signed result events from API Exams to Studio.
Prerequisites
  • Administrator access to both applications
  • Server-side secret storage
Architecture
Integration Studio represents the external client or LMS. API Exams App represents the assessment provider. Exam Player is the candidate-facing browser application.

Configuration

Example receiverhttps://studio.example.com/api/webhooks/local-api-exams (example only)
Secret<webhook-secret>; saved server-side and enter to replace
SignatureHMAC-SHA256 over the delivered event

Implementation steps

  1. 01API Exams → Integration Clients → Integration Studio → Webhook Delivery: enter the Studio receiver URL and choose attempt.finish.
  2. 02Create a signing secret. In Studio → Connections → API Exams → Webhooks enter the same secret.
  3. 03Save both sides and complete an assessment.
  4. 04Inspect API Exams Webhooks and Studio Integration Activity.
  5. 05Use Pull-Based Result Synchronization for scheduled reconciliation instead of push events.

Testing procedure

  • Delivery history appears
  • Studio accepts the signature and result

Troubleshooting

Signature invalid

Compare the saved secret on both sides and verify the raw request body.