Skip to navigation

This document outlines best practices for deploying notifications, including mapping display names, managing callout settings, and ensuring successful deployments.

The display names on the user interface of Notifications may be mapped to the following fields displayed on the compare screen of Deployment Manager.

ConfigurationNotifications User InterfaceDisplay names on compare screen
Basic InformationRelated Event Name Description ActiveEvent Name Name Description Active
Event ParametersNotifications Delivery DayParam 1 Param 2
Delivery OptionsEmail Callout Email Template Name Include Invoice PDFEmail Callout Email Template Name Param 4
Merge Field and Parameter SettingsMerge Field Base Url HTTP Method Custom Request Entity Body ParametersNot Supported in Deployment Manager Callout Base Url Http Method Use Custom Request Body Custom Request Body Content Type Callout Params- Parameter Value is Displayed
Retry SettingsRetry SettingsCallout Retriable
Callout AuthenticationUsername/Password OAuth OAuth 2.0 ProviderCallout Auth Callout Oauth 2
Additional OptionsAssociated AccountAssociated Account
  • Password/OAuth is set to default value as “Test”. Changing this field needs to be done manually. If the URL used in the callout is global, there is no action required. If it is environment specific, it needs to be changed manually.

  • Deployment Manager supports notification deployment preferences, allowing users to include or exclude the To, Cc, and Bcc fields during deployment from the Compare screen. By default, the checkbox is selected and email addresses are deployed from the source to the target configuration. If cleared, these fields are skipped and the target configuration remains unchanged.

    When creating email templates in the target tenant, the To email address is a mandatory field.

  • Merge Field is not supported.

  • For successful deployments:

    • Deploy Custom Fields, Custom Events, and Scheduled Custom Events before deploying Callout Notifications.
    • After deploying Callout Templates (for both creation and updates), manually update the password field to ensure proper configuration.
    • To maintain data consistency between the source and target, Zuora recommends deploying Reusable Blocks from the source tenant to the target tenant prior to deploying email templates. Otherwise, the deployment of email templates automatically includes the latest configuration of the associated reusable blocks.