Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceQueries

Notification__templates

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__templates: [NotificationTemplateOutput!]!

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

  1. notification__templates
audience*String!
body*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
placeholders*[String!]!
subject?String
Example Request
query Notification__templates {  notification__templates {    audience    body    event    placeholders    subject  }}
Example Response
{  "data": {    "notification__templates": [      {        "audience": "string",        "body": "string",        "event": "ORDER_CANCELLED",        "placeholders": [          "string"        ],        "subject": "string"      }    ]  }}

Notification__rules QUERY

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).

Page QUERY

Authenticated · x-tenant · Auth rules: @storeos/rbac-catalog Requires a signed-in staff user. Needs the `Pages` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).