Skip to main content

Notification Sent Export Format

  • Updated

The Notification Sent data represents all notification send events triggered by MyDataHelps.

Table of Contents

Data Fields

Field Description
ParticipantID The stable, automatically generated, internal system identifier for this participant.
ParticipantIdentifier The identifier of the participant the notification or survey was delivered to. Can be used to cross reference with Participants.
Timestamp The timestamp of the event (e.g., time email was sent, time push notification was received), in UTC.
ContentVersion The content version of the notification that was sent.
NotificationIdentifier The workspace-specific identifier of the notification that was sent. This is the identifier shown in the Notifications library.
NotificationType The type of notification sent (i.e., email, SMS, or push).
Recipients The email address or phone number that the notification was sent to.
StatusCode Status of the delivery. This will be "Succeeded" if the notification was successfully delivered, or it will indicate the problem (e.g., "MissingContactInfo").
TargetCustomField The name of the custom field that the notification was sent to, if specified when sending the notification (e.g., “AlternateEmail”). By default, notifications are sent to the email address or phone number associated with the participant’s MyDataHelps account.
RecipientOverride The coordinator notification email address, as defined in the notification schedule "Send to" field. See the Setting Up Coordinator Notifications article for more information. 
The legacy version of the Notification Sent Export also contained fields for Body, PushEventKey, Title, and DeviceIdentifier. These fields are now available in the Push Notifications Export, as described in the Push Notification Sent section of the Push Notification Export Format article. 

Sample CSV Export

ParticipantIdentifier,Timestamp,ContentVersion,NotificationIdentifier,NotificationType,Recipients,StatusCode,TargetCustomField,RecipientOverride
90136cf9-cc68-4139-91bb-7f123a02083d,2022-03-07T19:28:14Z,5,Welcome-Email-1,Email,test@careevolution.com,Succeeded,AltEmail,StudyEmail@uni.edu

Sample JSON Export

{
 "ParticipantID":"90136cf9-cc68-4139-91bb-7f123a02083d",
 "ParticipantIdentifier":"641d313d-7144-4534-ac28-719e0904253e",
 "Timestamp":"2022-03-07T19:28:14Z",
 "Properties":
  {
   "ContentVersion":"5", 
   "NotificationIdentifier":"Welcome-Email-1", 
   "NotificationType":"Email"
   "Recipients":"test@careevolution.com", 
   "StatusCode":"Succeeded", 
   "TargetCustomField":"AltEmail"
   "RecipientOverride":"StudyEmail@uni.edu"
  }
}

Was this article helpful?