Create and Edit Notifications
This article introduces how to create or update a notification for either a standard event or custom event through the Zuora UI.
If you want to create or edit a notification triggered by a custom event, alternative to the UI, you can use the Create a notification definition API operation to create a notification, or the Update a notification definition API operation to update a notification.
Create a Notification
Take the following steps to create a notification:
- Navigate to Settings > Billing, Settings > Finance, or Settings > Payments.
- Click Setup Profiles, Notifications and Email Templates.
- Click add new notification.
- Enter the following fields:
- Related Event: The event that will trigger this notification.
- 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.
- 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.
- In the Delivery Options section, specify the following options:
-
Select Email, Callout, or both as the delivery protocol.
-
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.
- 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.
- Retry: Select if you want the callout attempt to be retried based on the Callout Options set up for your customer 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
-
- In the Additional Options section, select the account with which the notification is associated from the Associated Account list. The options are automatically populated based on your system configuration.
- 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 referenced within the Order Action of the subscription.
- 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:
- Click your user name in the top right-hand of the application.
- Navigate to Settings > Billing, Settings > Finance, or Settings > Payments.
- Click Setup Profiles, Notifications and Email Templates.
- In the Notifications section, click edit for the notification you want to edit.
- Edit the fields of the notification. See the Step 4 - 7 in Create and Edit Notifications for field details.
- Click save.