Element451Integrations Guide

el_notifications_raw

Updated Article

el_notifications_raw Columns#

ColumnSQL Data TypeDescription
_idVARCHARUnique identifier for each document.
subdomVARCHARPartner school instance identifier
srcVARIANTJSON object of Notification document properties.
updated_atTIMESTAMP_NTZDocument update timestamp
created_atTIMESTAMP_NTZDocument created timestamp
etl_loaded_atTIMESTAMP_NTZDocument loaded to Snowflake timestamp

JSON Keys for Notifications Object#

KeyData TypeDescription
_idStringUnique identifier for the Notifications Object.
_subdomStringClient instance subdomain embedded in the source document.
activeBooleanWhether the notification template is active.
created_atString (Timestamp)Timestamp when the notification record was created in Element451.
deliveryArrayDelivery channels enabled for the notification. Distinct values: email, sms, alert.
directBooleanWhether the notification is sent directly without a campaign wrapper.
from_sourceObjectSource module and namespace that owns the notification template.
from_source.moduleStringElement451 module that created the notification (campaigns, events, etc.). Distinct values: campaigns, events, applications, documents.
from_source.namespaceStringNamespace within the module (communications, messages, autoresponders). Distinct values: communications, messages, autoresponders.
guidStringElement451 GUID for the notification record.
idStringLegacy or alternate identifier for the notification record.
is_templateBooleanWhether the record is a reusable notification template.
messageObjectMessage content configuration for each delivery channel.
message.alertStringIn-app alert message text for system notifications.
message.email (opens in a new tab)StringEmail conversation or template GUID for the notification.
message.smsStringSMS message configuration for the notification.
message.sms_from_numberStringSender phone number for SMS (top-level alias on message object).
message.sms.contentStringSMS message body text.
message.sms.from_numberStringSender phone number for the SMS notification.
message.sms.media (opens in a new tab)StringMedia attachments included in the SMS message.
message.sms.media (opens in a new tab)[].typeStringMedia attachment type for SMS. Distinct values: file.
message.sms.media (opens in a new tab)[].valueStringMedia attachment URL or file reference for SMS.
message.sms.opt_out_textStringOpt-out disclaimer text appended to SMS messages.
message.sms.smsStringNested SMS content object with body and file attachments.
message.sms.sms.contentStringSMS body text in the nested SMS content object.
message.sms.sms.fileStringFile attachment reference for the nested SMS content.
nameStringDisplay name for the notification template.
scheduleObjectDelivery timing configuration per channel.
schedule.email (opens in a new tab)StringEmail delivery timing mode (synchronous or asynchronous). Distinct values: asynch, async, sync.
schedule.pushStringPush notification delivery timing mode. Distinct values: asynch.
schedule.smsStringSMS delivery timing mode (synchronous or asynchronous). Distinct values: asynch, sync.
senderStringSender type for the notification (typically client). Distinct values: client.
sourceStringOrigin of the notification (autoresponder or system). Distinct values: autoresponder, system.
subdomStringClient subdomain duplicated inside the SRC document.
targetStringRecipient target type for the notification (user or anonymous). Distinct values: user, anon.
typeStringNotification type classification. Distinct values: info, sms, email.
updated_atStringTimestamp when the notification record was last updated.
used_inArrayGUIDs of campaigns, events, or workflows that reference this notification.

Sample JSON Object for Notifications#

Notifications

json
{
  "_id": "55bb7c5b200c78c63e641f57",
  "_subdom": "instance",
  "active": true,
  "delivery": [
    "email",
    "sms"
  ],
  "event": "RecommendationRequestEmailSend",
  "from_source": {
    "module": "documents",
    "namespace": "autoresponders"
  },
  "guid": "instance.notifications.withwaiver",
  "message": {
    "email": "emails.instance.5",
    "sms": "Just a reminder...",
    "sms_from_number": "+1234567890"
  },
  "name": "Information Request with Waiver",
  "schedule": {
    "email": "async"
  },
  "sender": "client",
  "source": "autoresponder",
  "target": "anon",
  "type": "info",
  "updated_at": "2016-06-13T16:20:11.924000",
  "used_in": [
    "instance.communications.281204"
  ]
}
el_notifications_raw
0 rows
el_notifications_raw
ColumnData TypeDescription
el_notifications_raw Columns
6 rows
el_notifications_raw Columns
ColumnSQL Data TypeDescription
srcVARIANTJSON object of Notification document properties.
_idVARCHARUnique identifier for each document.
etl_loaded_atTIMESTAMP_NTZDocument loaded to Snowflake timestamp
subdomVARCHARPartner school instance identifier
updated_atTIMESTAMP_NTZDocument update timestamp
created_atTIMESTAMP_NTZDocument created timestamp
JSON Keys for Notifications Object
25 rows
JSON Keys for Notifications Object
DescriptionData TypeKey
Email conversation or template GUID for the notification.STRING[message.email](http://message.email)
Timestamp when the notification record was created in Element451.STRING (TIMESTAMP)created_at
Namespace within the module (communications, messages, autoresponders). Distinct values: communications, messages, autoresponders.STRINGfrom_source.namespace
Source module and namespace that owns the notification template.OBJECTfrom_source
Media attachment type for SMS. Distinct values: file.STRING[message.sms.media](http://message.sms.media)[].type
SMS message body text.STRINGmessage.sms.content
Whether the notification is sent directly without a campaign wrapper.BOOLEANdirect
Delivery channels enabled for the notification. Distinct values: email, sms, alert.ARRAYdelivery
Element451 module that created the notification (campaigns, events, etc.). Distinct values: campaigns, events, applications, documents.STRINGfrom_source.module
Opt-out disclaimer text appended to SMS messages.STRINGmessage.sms.opt_out_text
Nested SMS content object with body and file attachments.STRINGmessage.sms.sms
Whether the notification template is active.BOOLEANactive
In-app alert message text for system notifications.STRINGmessage.alert
SMS message configuration for the notification.STRINGmessage.sms
Sender phone number for the SMS notification.STRINGmessage.sms.from_number
Legacy or alternate identifier for the notification record.STRINGid
Client instance subdomain embedded in the source document.STRING_subdom
Whether the record is a reusable notification template.BOOLEANis_template
Media attachments included in the SMS message.STRING[message.sms.media](http://message.sms.media)
Message content configuration for each delivery channel.OBJECTmessage
Element451 GUID for the notification record.STRINGguid
Sender phone number for SMS (top-level alias on message object).STRINGmessage.sms_from_number
Unique identifier for the Notifications Object.STRING_id
Media attachment URL or file reference for SMS.STRING[message.sms.media](http://message.sms.media)[].value
SMS body text in the nested SMS content object.STRINGmessage.sms.sms.content