Manage notifications

Prerequisite

Open the notification editor before creating a notification by following these steps:

1. Navigate to Platform > Events & Notifications in the left navigation menu. The Setup Profiles, Notifications and Email Templates page opens.
2. Click + Add New Notification on the Notifications tab. The notification editor opens.

Step 1: Define trigger

Select the trigger type of the notification:

• On An Event Occurrence: The notification will be triggered when a specific event occurs, such as Invoice Posted, Order Action Processed, or any custom event.
• On A Daily Schedule: The notification will be triggered when the date matches the criteria of a daily-scheduled event, such as Invoice Due, Payment Method Expiration, or any custom scheduled event.

Step 2: Select a related event

You can select an existing event or create a new custom or custom scheduled event for the notification.

1. Select a related event by using one of the following methods:
   • Select an existing event from the dropdown list.
   • Click Create New Event and specify the event details.
     Available fields vary depending on the trigger type you selected in Step 1: Define trigger. For more information about the description of each field, see Create a custom event and Create a custom scheduled event.
2. Click Next.

Step 3: Set filters

You can set existing system filters or create custom filters for the notification. The notification will be triggered only if all filter criteria are met.

1. If any system filters exist, set them in the System Filter(s) section.
   Available system filters vary depending on the related event you selected in Step 2: Select a related event. Certain events do not have system filters.
2. Optional: Click Manage Custom Filter(s) and then edit custom filters in the Manage Custom Filter(s) dialog that pops up.
   1. In the Custom Input Fields section, click + Add Input Field. 
   2. Specify the following information to define a custom input field. Skip this step if no custom input field is needed.
      • Name: the name of the custom input field. White space is not allowed.
      • Display Name: the label of the custom input field displayed in the UI.
      • Input Type: the value type of the custom input field.
      • Description: the description of the custom input field.
      • Options: the option values of the custom input field. Each option must be separated by a new line.
      You must include all custom input fields in filter conditions. See step d for more information.
   3. Repeat steps a and b to define more custom input fields as needed.
   4. Define filter conditions in the Condition section by using one of the following methods:
      • Define conditions with the condition builder. For more information, see Define conditions with the condition builder.
      • Switch on the Advanced (JEXL) toggle, and then specify an expression in Java EXpression Language (JEXL) in the Set Filter Conditions field. For more information, see Trigger condition syntax.
      You must include all custom input fields in custom conditions. For example, _SUBSCRIPTION_STATUS is a custom input field in the following condition:
      Subscription.Status == _SUBSCRIPTION_STATUS.
   5. Click Save.
3. If any custom filters exist, set them in the Custom Filter(s) section.
4. Click Next.

Step 4: Set delivery options

Notifications are delivered via email or callout. You can select existing email or callout templates or create new templates as needed.

1. Configure email template:
   1. Optional: Click Create New Email Template and create a new email template in the pop-up window. For more information, see Manage Email Templates.
      You can skip this step if the email template you want to use already exists.
   2. Select an email template from the Delivered By Email list.
2. Configure callout templates:
   1. Optional: Click Create New Callout Template and create a new callout template in the pop-up window. For more information, see Manage callout templates.
      You can skip this step if the callout template you want to use already exists.
   2. Repeat step a to create more callout templates as needed.
   3. Select one or more callout templates from the Delivered By Callout list.
      Zuora sends the notification to all endpoints configured in the callout templates when the related event is triggered.
3. Click Next.

Step 5: Define target accounts

Each customer account is associated with a communication profile. When defining notifications, you must define target accounts by assigning the notification to one or more communication profiles. For more information, see Communication profiles.

1. Optional: Click Create New Communication Profile and create a new communication profile in the pop-up window. For more information, see Create a communication profile.
2. Select one or more communication profiles associated with the notification from the dropdown list.
3. Click Next.

Step 6: Finalize notification details

Specify basic information and additional settings of the notification.

1. Specify the following information in the Basic Information section:
   • Name
   • Description
   • Active: Switch this toggle to activate or deactivate the notification. Zuora does not send notifications that are inactive.
2. Optional: From the Associated Account list in the Additional Settings section, select the account on which the histories of this notification will be displayed.
   The associated account does not enforce where the merge fields come from.
   • Account: the primary customer account related to the notification. It is also the default value.
   • Parent Account: the parent account of the primary account referenced above. This option can take effect only if you have the Customer Hierarchy feature enabled.
   • Subscription Owner Account: the account associated with the subscription. This option is available only if the base object of the related event of the notification is Order Action.
3. Click Next.

Step 7: Review notification

Review the notification configuration and go back to the previous steps if you want to adjust any settings before creating the notification.

1. Review the notification configuration.
2. If you want to adjust any settings before creating the notification, click a specific step in the left navigation or click Previous.
3. Click Done.