Manage in-app notifications and notification preferences.
The Notifications API allows you to retrieve and manage in-app notifications for your organization's team members.
/notifications| Name | Type | Required | Description |
|---|---|---|---|
| status | string | Optional | Filter by status: unread, read, all (default: all) |
| type | string | Optional | Filter by type: exam, application, system, billing |
| limit | integer | Optional | Results per page (default: 20, max: 100) |
{
"data": [
{
"id": "notif_klm890",
"type": "exam",
"title": "New exam completion",
"message": "Jane Smith completed Senior Backend Developer exam with score 87.5",
"status": "unread",
"created_at": "2024-02-12T09:20:00Z",
"data": {
"candidate_id": "cand_xyz789",
"result_id": "result_ghi789",
"score": 87.5
}
}
],
"pagination": { "total": 23, "limit": 20, "has_more": true },
"unread_count": 8
}/notifications/{notification_id}/read/notifications/read-all/notifications/unread-count{
"unread_count": 8,
"by_type": {
"exam": 5,
"application": 2,
"system": 1,
"billing": 0
}
}/notifications/preferences{
"email_notifications": {
"exam_completed": true,
"candidate_invited": false,
"result_available": true,
"daily_digest": true
},
"in_app_notifications": {
"exam_completed": true,
"candidate_invited": true,
"result_available": true,
"application_received": true
}
}/notifications/preferencesUse webhooks for real-time integrations instead of polling the notifications endpoint. Notifications are best for user-facing features.
Was this article helpful?