External Manuscript Submission Notification

External Manuscript Submission Notifications are generated when a manuscript is ingested into the ScholarOne Manuscripts system from an external submission platform. These notifications confirm whether the ingestion process succeeded or failed and provide the identifiers and file references necessary for tracking the submission across systems. In the case of failures, additional error information is included to assist in troubleshooting and resolution.

Each notification delivers a message payload that includes:

  • Common elements shared across all notification types
  • Event type and processing outcome
  • External identifiers for cross-system correlation
  • Optional error details for failed ingestions

External Manuscript Submission Payload Elements

Element/Payload Example

Type

Description

systemEventName

SUB_INTEGRATION_FAILURE

String

System-level label identifying the type of submission ingestion event.

externalSubmissionId

ERR-1634-08

String

Unique identifier assigned to the manuscript by the external system initiating the ingestion. Used for cross-referencing between the external platform and ScholarOne.

zipFileName

ERR-1634-08.zip

String

Name of the ZIP package containing the manuscript’s XML metadata file and any associated submission files provided by the external system.

errorCode

3

Integer

(Present only when systemEventName = SUB_INTEGRATION_FAILURE) Numeric error code indicating the cause of ingestion failure.

External Manuscript Submission Payload Sample

{
  "systemEventName": "SUB_INTEGRATION_FAILURE",
  "externalSubmissionId": "ERR-1634-08",
  "zipFileName": "ERR-1634-08.zip",
  "errorCode": 3,
  "notificationServiceVersion": "V3",
  "siteName": "supportdemo",
  "journalName": "Journal of Support",
  "subscriptionId": 34245,
  "subscriptionName": "Failure",
  "subscriptionType": "SYSTEM_EVENT",
  "eventDate": "2025-04-09T10:37:28Z",
  "messageUUID": "e9b7ba0d-ad8b-478e-9e8e-54e2495c2bc5"
}