Notification__rules

Requires a signed-in staff user. Needs the `identity__Tenant` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).

QUERYnotification__rules: [NotificationRuleOutput!]!

Requires a signed-in staff user. Needs the identity__Tenant read permission. Send the x-tenant header (the gateway sets it from your API key).

Returns

notification__rules

deliveries*

enabled*Boolean!

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

Example Request

query Notification__rules {
  notification__rules {
    deliveries {
      channel
      recipients {
        email
        name
        phoneNumber
        role
        templateBody
        templateSubject
        type
        userIds
      }
      templateBody
      templateKey
      templateSubject
    }
    enabled
    event
  }
}

query Notification__rules {  notification__rules {    deliveries {      channel      recipients {        email        name        phoneNumber        role        templateBody        templateSubject        type        userIds      }      templateBody      templateKey      templateSubject    }    enabled    event  }}

Example Response

{
  "data": {
    "notification__rules": [
      {
        "deliveries": [
          {
            "channel": "EMAIL",
            "recipients": [
              {
                "email": "string",
                "name": "string",
                "phoneNumber": "string",
                "role": "string",
                "templateBody": "string",
                "templateSubject": "string",
                "type": "CUSTOM",
                "userIds": [
                  "string"
                ]
              }
            ],
            "templateBody": "string",
            "templateKey": "string",
            "templateSubject": "string"
          }
        ],
        "enabled": true,
        "event": "ORDER_CANCELLED"
      }
    ]
  }
}

Example Response

{  "data": {    "notification__rules": [      {        "deliveries": [          {            "channel": "EMAIL",            "recipients": [              {                "email": "string",                "name": "string",                "phoneNumber": "string",                "role": "string",                "templateBody": "string",                "templateSubject": "string",                "type": "CUSTOM",                "userIds": [                  "string"                ]              }            ],            "templateBody": "string",            "templateKey": "string",            "templateSubject": "string"          }        ],        "enabled": true,        "event": "ORDER_CANCELLED"      }    ]  }}

ReturnsCopy Anchor Link

Returns