Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceObjects

NotificationDeliveryOutput

typeNotificationDeliveryOutput

Fields

  1. fields
_id*String!
attempts*Int!
channel*NotificationChannel!

Delivery channel for a notification rule

Value inEMAILSMSWHATSAPP
createdAt?DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

error?String
event*NotificationEvent!

Business event that can trigger a customer or team notification

Value inORDER_CANCELLEDORDER_CONFIRMEDORDER_PLACEDPAYMENT_FAILEDPAYMENT_PAIDREVIEW_INVITEDSHIPMENT_CREATEDSHIPMENT_DELIVEREDSHIPMENT_DELIVERY_FAILEDSHIPMENT_IN_TRANSITSHIPMENT_OUT_FOR_DELIVERYSHIPMENT_RETURNEDSTORE_CUSTOM
idempotencyKey*String!
provider*NotificationProvider!

Messaging provider configured for a channel

Value inBULKSMSBDSMTPWALAND
providerMessageId?String
recipient?String
sentAt?DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

status*NotificationDeliveryStatus!

Current state of a notification delivery attempt

Value inFAILEDQUEUEDSENTSKIPPED
subjectId?String
subjectType*NotificationSubjectType!

Entity a notification belongs to

Value inORDERPAYMENTSHIPMENTSTORE
templateKey?String

Usages

SDL
type NotificationDeliveryOutput {  _id: String!  attempts: Int!  channel: NotificationChannel!  createdAt: DateTime  error: String  event: NotificationEvent!  idempotencyKey: String!  provider: NotificationProvider!  providerMessageId: String  recipient: String  sentAt: DateTime  status: NotificationDeliveryStatus!  subjectId: String  subjectType: NotificationSubjectType!  templateKey: String}