Callback notification

🔔 Callback Notifications

On completion of a test, a report is generated and a notification is sent to the registered callback URL. You must first register a callback URL that can receive this data via HTTP POST.

Note: The notification is sent only once. If your endpoint is unreachable or errors out, iMocha will retry 5 times consecutively. After that, retries are stopped. Use the Process Callbacks API to reprocess failed notifications.

📮 Registering a Callback URL

You can register the callback URL using the invite candidate API by passing the callbackURL parameter. The URL must support HTTP POST and TLS 1.2 or above — otherwise, the callback will fail.

🔄 Notification Types

Notifications are sent in two scenarios:

In Progress
Complete / Terminated / Test Left

📋 Payload Fields:

Field	Data Type
CandidateEmailId	String
AttemptedOn	String
TotalScore	Float
CandidateScore	Float
ReportPDFUrl	String
TestInvitationId	Integer64
Status	String
AttemptedOnUtc	String
PerformanceCategory	String

📤 Example: "In Progress"

{
  "CandidateEmailId": "[email protected]",
  "AttemptedOn": "09-Oct-2020 06:51 PM",
  "TotalScore": 0,
  "CandidateScore": 0,
  "ReportPDFUrl": null,
  "TestInvitationId": 3314697,
  "Status": "In Progress",
  "AttemptedOnUtc": "2020-10-09T13:21:53",
  "PerformanceCategory": null
}

📥 Example: "Complete / Terminated / Test Left"

{
  "CandidateEmailId": "[email protected]",
  "AttemptedOn": "09-Oct-2020 06:51 PM",
  "TotalScore": 115,
  "CandidateScore": 6,
  "ReportPDFUrl": "https://app.imocha.io/PDFReport?id=OXP5R5ayMu8nrHfnh2g%3d%3d",
  "TestInvitationId": 331469,
  "Status": "Complete",
  "AttemptedOnUtc": "2020-10-09T13:21:53",
  "PerformanceCategory": "Beginner"
}