Home / Documentation / Mobile & Researcher API
Mobile & Researcher API

Notifications

A published guide from Survanta's public documentation.

Notifications

Overview

Survanta exposes an authenticated mobile notification inbox and supports push delivery when the current user has registered a device token. The inbox contract does not guarantee that every product event produces a notification or that a client implements a particular screen or navigation behavior.

Types of Notifications

Notification Type When It Appears Examples
Push delivery When a notification is dispatched to the user's currently registered device token Depends on administrator configuration and delivery status
Notification inbox Whenever the client calls the inbox endpoints Stored notifications visible to the current user

Enabling Push Notifications

The client must request device notification permission, obtain a provider token, and register it through POST /api/Researcher/device-token. Survanta stores one current token per user.

If you previously denied notification permission or wish to re-enable it:

  1. Go to your device's Settings.
  2. Find Survanta in the list of installed apps.
  3. Tap Notifications and toggle the permission to On.

Without permission and a registered provider token, push delivery is unavailable. The authenticated inbox can still be queried independently.

Viewing Notifications

Notification inbox API:

  1. Call GET /api/Notifications?page=1&pageSize=20; pageSize is clamped to 1 through 100.
  2. Call GET /api/Notifications/unread-count for { "unreadCount": number }.
  3. Call POST /api/Notifications/{id}/read to mark an owned notification as read; success returns HTTP 204 and an unavailable item returns 404.
  4. Call POST /api/Notifications/read-all to receive { "updatedCount": number }.

Push notifications:

  • Push notifications appear on your device's lock screen and notification tray.
  • Any deep-link or navigation behavior is implemented by the client from the notification payload; the inbox endpoints do not define it.

Common Notification Events

  • Notification title, body, timestamps, targeting, and delivery depend on the notification created by the platform or administrator.
  • Clients should render stored title/body values and read state rather than infer an undocumented event catalog.
  • Survey submission success is authoritative only in the submission API response; do not wait for a notification to confirm persistence.

Acknowledging and Dismissing Notifications

  • Opening an item does not mark it read unless the client calls the single-item read endpoint.
  • Use the read-all endpoint to mark all currently unread notifications as read.
  • To dismiss a specific notification from the notification tray (device-level), swipe it left or right.
  • Dismissing a device-level push does not call the Survanta read endpoints; whether a matching inbox item exists depends on how the notification was created.

Notification Preferences

Inbox access requires a valid mobile JWT, the mobile tenant-user policy, and Tenant.ReceiveMobileNotifications. Delivery and targeting are configured by the platform or tenant administrator.

Troubleshooting

  • Not receiving push notifications: Verify that notifications are enabled for Survanta in your device Settings. Check that your device is connected to the internet.
  • Push notifications arrive but tapping them does nothing: Check the client payload/deep-link handling; the server inbox API does not control navigation.
  • Unread badge is stale: Refresh it from GET /api/Notifications/unread-count after read operations.

Support

Please log in or create an account to chat with our support team.