Notifications

We use SignalR to send asynchronous notifications to the client.

Currently you can connect to common hub. The connection is authorized with the same Access token that is used for API calls. The connection URL is /hubs/common.

You can subscribe for the following events:

workListChanged

This event is triggered by the Record status changing (read more on Record Statuses) and contains the payload:

{
  "recordId": "ef51e187-740c-44b7-a16b-501fa54f6a99",
  "status": "inRecognitionQueue",
  "lastStatusDate": "2024-05-09T12:03:14.6356191Z",
  
  // sent only if status is Recognized
  wordsCount: 100,
  recognized: "2024-05-09T12:03:14.6356191Z",

  // sent only if status is CorrectingBy
  correctorName: "UserName",

  // sent only if status is Uploaded
  fileSize: 1024,
  trackTime: 60000,
}

refreshWorklist

You can use this event to refresh data view of the list of Records. It's triggered by:

• One or multiple record(s) was/ were deleted.
• One or multipe record title(s) was/ were changed.

This event doesn't have any payload.

recordUploadDenied

The event is triggered during the file upload if there are some restrictions for upload. The payload is:

{
  "recordId": "ef51e187-740c-44b7-a16b-501fa54f6a99",
  "recordName": "My Record",
  "deniedCodes": ["fileUploadLimitReached"],
  "timestamp": "2024-05-09T12:03:14.6356191Z",
}

The deniedCodes field contains a list of codes, that are point to the restrictions for upload. To learn more about possible denied codes see Verify the possibility to upload a specific file.

accountDeleted

This event is triggered when a user account is deleted. This event doesn't have any payload.

transcriptExportCompleted

The event is triggered when transcript or notepad export is completed. The payload is:

{
  "recordId": "ef51e187-740c-44b7-a16b-501fa54f6a99",
  "fileId": "1231e187-740c-44b7-a16b-501fa54ff345",
  "fileName": "MyfileName",
  "fileFormat": "txt",
}