Skip to main content

Manage Notifications


Manage Notifications

This article introduces how to create or update a notification through the Zuora UI.

Alternatively, you can use the following operations to manage notifications through the API:

Create a notification

Take the following steps to create a notification:

  1. Navigate to Settings > AdministrationSettings > BillingSettings > Finance, or Settings > Payments.
  2. Click Setup Profiles, Notifications and Email Templates.
  3. (Optional) In the Notifications section, select a product domain from the drop-down list.
  4. Click Add New Notification.
  5. Enter the following fields:
    • Related Event: The event that will trigger this notification. The available events depend on the current communication profile and product domain. For example, custom events for custom objects and System Health dashboard events are available only in the System product domain of the default communication profile.
    • Name
    • Description
    • Active: Select to activate the notification. You can also activate the notification at a later time. For example, you can activate the notification when you are ready to use it.
  6. In the Event Parameters section, specify the related options. The parameters that you can select are based on the related event you selected in Step 4.
  7. In the Delivery Options section, specify the following  options:
    1. Select Email, Callout, or both as the delivery protocol.

    2. If you selected Email, click and select the email template.

      If the event is related to an invoice or a payment, you can include the invoice with the email.

      If the event is related to a credit memo or a debit memo, you can include the credit memo or debit memo with the email. This feature is only available if you have the Invoice Settlement feature enabled.

      Zuora retries up to three times for emails that fail to deliver to the recipient. You cannot configure the maximum number of attempts for email notifications.

    3. If you selected Callout, enter the following information. For more information, see Configure callout notifications.
      • Base URL: The URL to which you would like to send the callout data. This is the path to the receiver service of the callout.
      • Click add parameter if you want to include additional information in the callout.
        • Click the Parameter Value field to get a list of possible objects and field names that you can pass in as parameters in the callout request.
      • HTTP Method: Select the method you want to use to send the callout data.
      • Allow Retry: Select if you want the callout attempt to be retried based on the Callout Settings set up for your customer notifications. For more information, see Configure Callout Settings.
        This setting applies only to callout notifications.
      • Callout Authentication: Select to specify the username and password for the callout, and enter the following information.
        • Username
        • Password
        • Domain: Specify the domain if using NTLM authentication.
      • Body Format: application/json
  8. (Optional) From the Associated Account list in the Additional Options 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.
  9. Click add new notification to save the notification.

There can only be one notification per event with the same event parameters.

Edit a notification

To edit an existing notification or enable the notification, perform the following steps:

  1. Click your user name in the top right-hand of the application.
  2. Navigate to Settings > AdministrationSettings > BillingSettings > Finance, or Settings > Payments.
  3. Click Setup Profiles, Notifications and Email Templates.
  4. In the Notifications section, click edit for the notification you want to edit.
  5. Edit the fields of the notification. See the Step 5 - 8 in Create a notification for field details.
  6. Click save.