Standard Events

Last updated
Save as PDF

Standard events are pre-defined business events for Zuora Billing, Zuora Payment, Zuora Finance, and Zuora Central Platform. Zuora provides you with the supported standard events out of the box.

Standard events such as Invoice Due and Payment Processed are tied to customer transactions and actions. Zuora uses communication profiles specified on customer accounts to provide localized data in notifications related to these events. Other standard events such as Bill Run Completion do not have the context of customer accounts, thus default communication profiles are used. See Communication profiles for more information.

Supported standard events

To view the supported standard events in the application:

Click your avatar on the upper-right corner, and then click Billing, Payments, Finance, or Administration.
On the settings page, click Setup Profiles, Notifications and Email Templates.

The following table lists the required user permissions for each event category. If you do not have the permissions, contact your organization’s administrator.

Event category	Required permission
Billing	Billing > Manage Billing Settings
Payments	Payments > Manage Payments Settings
Finance	Finance > Manage Finance Settings
System	You must log in as a Zuora Platform Administrator or have been granted at least one of the following user permissions: Billing > Manage Billing Settings Payments > Manage Payments Settings Finance > Manage Finance Settings

See the supported standard events for Zuora Orders, Zuora Billing, Zuora Payment, Zuora Finance, and Zuora Central Platform below.

Standard events for Zuora Orders

The following table describes the standard events supported by Zuora Orders. If you want to enable Orders and the associated standard events, submit a request at Zuora Global Support. Once they are enabled, Zuora will provide you with these standard events and corresponding notifications out of the box.

If the Orders Harmonization feature is enabled in your tenant, the Orders events and notifications are available for any order action created through the Orders API.

Name	Related Event	Description
Order Processed	Order Processed	Notification sent out when an order has been processed.
Add Product	Order Action Processed	Notification sent out when a product is added to an order.
Cancel Subscription	Order Action Processed	Notification sent out when a subscription is canceled.
Create Subscription	Order Action Processed	Notification sent out when a subscription is created.
Owner Transfer	Order Action Processed	Notification sent out when the invoice owner or subscription owner is changed.
Remove Product	Order Action Processed	Notification sent out when a product is removed.
Renew Subscription	Order Action Processed	Notification sent out when a product is renewed.
Terms and Conditions	Order Action Processed	Notification sent out when changes happened to the terms and conditions of a subscription.
Update Product	Order Action Processed	Notification sent out when a product is updated.

Note that the Order Processed and Order Action Processed events are pre-defined by Zuora. Zuora evaluates these events as custom events in your Zuora tenant.

Standard events for Zuora Billing

The following table describes the standard events supported by Zuora Billing.

The standard events and notifications in the table are not available if the Orders feature is enabled in your tenant, with the following exceptions:

If the Orders feature is enabled, Subscription Start Date for the Key Date(s) event is available.
If the Orders Harmonization feature is enabled, the following events and notifications are available for any subscription creation or amendment created through the Subscribe and Amend API or UI:
- The AmendmentProcessed event and corresponding notifications
- The New Subscription Created event and corresponding notifications

Name	Related Event	Description
Cancellation	AmendmentProcessed	A subscription cancelation amendment has been submitted and processed.
NewProduct	AmendmentProcessed	An "add new product" amendment has been submitted and processed.
Owner Transfer	AmendmentProcessed	An Owner Transfer amendment has been submitted and processed.
RemoveProduct	AmendmentProcessed	A remove product amendment has been submitted and processed.
Renewal	AmendmentProcessed	A renewal amendment has been submitted and processed.
Resume Subscription	AmendmentProcessed	A Resume Subscription amendment has been submitted and processed. The AmendmentProcessed notification for Resume Subscription amendment is in Limited Availability. If you already have Suspend and Resume feature enabled, this notification is available automatically. Submit a request at Zuora Global Support only if you wish to have access to Suspend and Resume feature.
Suspend Subscription	AmendmentProcessed	A Suspend Subscription amendment has been submitted and processed. The AmendmentProcessed notification for Suspend Subscription amendment is in Limited Availability. If you already have Suspend and Resume feature enabled, this notification is available automatically. Submit a request at Zuora Global Support only if you wish to have access to Suspend and Resume feature.
TermsAndConditions	AmendmentProcessed	A term and condition amendment has been submitted and processed.
UpdateProduct	AmendmentProcessed	An update product amendment has been submitted and processed.
Completed Status	Bill Run Completion	A bill run has completed successfully.
Error Status	Bill Run Completion	A bill run has not completed successfully.
Completed Status	Billing Preview Run Completion	A billing preview run has completed successfully.
Error Status	Billing Preview Run Completion	A billing preview run has completed with error.
Day(s) Before/After Invoice Due Date	Invoice Due	This event sends a notification for each invoice that matches the criteria for the Invoice Due Date. You can choose the number of days before or after the invoice due date to send the notification, and you can create multiple notifications. For example, you can send notifications at 5, 7, and 10 days past due. This notification is triggered by a scheduled job at 4:15 am UTC time for tenants in EU Cloud Data Center and US Cloud Data Center 1, or 4:15 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in US Cloud Data Center 2. For more information about data centers, see Zuora data centers. Please also see Invoices Past Due, Account Summary notification for an Account-level notification of all overdue invoices on an account.
Invoice Posted Manually	Invoice Posted	Generate an event when a draft invoice is posted manually from the invoice detail page. This event will trigger a notification when you click post in a Bill run page. This also allows you to manually trigger a notification when you click post invoice from the individual (draft) invoice's page in the Zuora UI.
Invoice Posted via API	Invoice Posted	Generate an event when a draft invoice is posted via API.
Invoice Posted within a Bill Run of Auto-Post	Invoice Posted	Trigger the notification when invoices are posted within a bill run and the bill run has auto-post. This is to support existing email notification behavior from within a bill run.
Invoices past due, account summary	Invoices Past Due, Account Summary	Summary information of past due posted invoices of customer accounts, generally delivered on monthly basis. The invoice past due event applies to the account level, rather than the invoice level. The past due invoices will be checked first, and if any exist they will be included in a single notification. The past due calculation is performed according to the relevant date fields on invoices, not on the account. The time when the notification is sent is determined according to the account's billing day or a specific day of this month. To set a specific day of the month, edit the notification and set the Notification delivery day field. The Notification delivery day can be set up to 365 days after the invoice due date. This notification is triggered by a scheduled job at 4:15 am UTC time for tenants in EU Cloud Data Center and US Cloud Data Center 1, or 4:15 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in US Cloud Data Center 2. For more information about data centers, see Zuora data centers.
Contract Effective Date	Key Date(s)	A subscription notification is sent on the contract effective date. This event only monitors the Contract Effective Date field on the Subscription object. An Amendment or Order that changes an existing subscription but does not change the Contract Effective Date field will not trigger this event. This notification is triggered by a scheduled job at 9:45 am UTC time for tenants in EU Cloud Data Center and US Cloud Data Center 1, or 9:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in US Cloud Data Center 2. For more information about data centers, see Zuora data centers.
Customer Acceptance Date	Key Date(s)	A subscription notification is sent on the customer acceptance date. This notification is triggered by a scheduled job at 9:45 am UTC time for tenants in EU Cloud Data Center and US Cloud Data Center 1, or 9:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in US Cloud Data Center 2. For more information about data centers, see Zuora data centers.
Rate Plan Charge End Date	Key Date(s)	A rate plan charge notification is sent on the date when a charge ends. The notification is triggered by a scheduled job at 8:45 am UTC time for tenants in EU Cloud Data Center and US Cloud Data Center 1, or 8:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in US Cloud Data Center 2. If the subscription is cancelled before today's date, the notification will not be sent. For more information about data centers, see Zuora data centers. When you are creating or editing a notification, you can set when to notify your customers by offsetting the number of days in the Offset field. This event type is only for subscriptions that are in PendingActivation, PendingAcceptance, Active, or Cancelled status. The Key Date(s) notification for Rate Plan Charge End Date is in Limited Availability. If you already have Key Date(s) notification for Rate Plan Charge enabled, this notification is available automatically. Submit a request at Zuora Global Support only if you wish to have access to Rate Plan Charge Key Date(s) Notification.
Rate Plan Charge Start Date	Key Date(s)	A rate plan charge notification is sent on the date when a charge starts. The notification is triggered by a scheduled job at 8:45 am UTC time for tenants in EU Cloud Data Center and US Cloud Data Center 1, or 8:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in US Cloud Data Center 2. If the subscription is cancelled before today's date, the notification will not be sent. For more information about data centers, see Zuora data centers. When you are creating or editing a notification, you can set when to notify your customers by offsetting the number of days in the Offset field. This event type is only for subscriptions that are in PendingActivation, PendingAcceptance, Active, or Cancelled status. The Key Date(s) notification for Rate Plan Charge Start Date is in Limited Availability. If you already have Key Date(s) notification for Rate Plan Charge enabled, this notification is available automatically. Submit a request at Zuora Global Support only if you wish to have access to Rate Plan Charge Key Date(s) Notification.
Service Activation Date	Key Date(s)	A subscription notification is sent on the activation date for services or products within a subscription. This notification is triggered by a scheduled job at 9:45 am UTC time for tenants in EU Cloud Data Center and US Cloud Data Center 1, or 9:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in US Cloud Data Center 2. For more information about data centers, see Zuora data centers.
Subscription End Date	Key Date(s)	A subscription notification is sent on the subscription end date at 9:45 am UTC time for tenants in EU Cloud Data Center and US Cloud Data Center 1, or 9:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in US Cloud Data Center 2. For more information about data centers, see Zuora data centers.
Subscription Resume Date	Key Date(s)	A subscription notification is sent on the date when subscription resumption takes effect. The notification is triggered by a scheduled job at 9:45 am UTC time for tenants in EU Cloud Data Center and US Cloud Data Center 1, or 9:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in US Cloud Data Center 2. For more information about data centers, see Zuora data centers. The Key Date(s) notification for Resume Subscription is in Limited Availability. If you already have Suspend and Resume feature enabled, this notification is available automatically. Submit a request at Zuora Global Support only if you wish to have access to Suspend and Resume feature.
Subscription Start Date	Key Date(s)	A subscription notification is sent on the subscription start date at 9:45 am UTC time for tenants in EU Cloud Data Center and US Cloud Data Center 1, or 9:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in US Cloud Data Center 2. This is the term start date of the original subscription. For more information about data centers, see Zuora data centers.
Subscription Suspend Date	Key Date(s)	A subscription notification is sent on the date when subscription suspension takes effect. The notification is triggered by a scheduled job at 9:45 am UTC time for tenants in EU Cloud Data Center and US Cloud Data Center 1, or 9:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in US Cloud Data Center 2. For more information about data centers, see Zuora data centers. The Key Date(s) notification for Suspend Subscription is in Limited Availability. If you already have Suspend and Resume feature enabled, this notification is available automatically. Submit a request at Zuora Global Support only if you wish to have access to Suspend and Resume feature.
Term End Date	Key Date(s)	A subscription notification is sent on the term end date. This notification is triggered by a scheduled job at 9:45 am UTC time for tenants in EU Cloud Data Center and US Cloud Data Center 1, or 9:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in US Cloud Data Center 2. For more information about data centers, see Zuora data centers.
Term Start Date	Key Date(s)	A subscription notification is sent on the term start date. By default, the contract effective date is set to be the term start date. This notification is triggered by a scheduled job at 9:45 am UTC time for tenants in EU Cloud Data Center and US Cloud Data Center 1, or 9:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in US Cloud Data Center 2. For more information about data centers, see Zuora data centers.
Manual Email For Invoice	Manual Email For Invoice	Send email notification manually from invoice detail page.
Active	New Subscription Created	A new subscription has been created and activated.
Pending Acceptance	New Subscription Created	A new subscription has been created and is in Pending Acceptance status.
Pending Activation	New Subscription Created	A new subscription has been created and is in Pending Activation status.
30 days before auto renewal	Upcoming Renewal	The subscription is within 30 days of its scheduled renewal and the subscription will be automatically renewed. This notification is triggered by a scheduled job at 00:01 am UTC time for tenants in EU Cloud Data Center and US Cloud Data Center 1, or 00:01 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in US Cloud Data Center 2. For more information about data centers, see Zuora data centers.
30 days before renewal	Upcoming Renewal	The subscription is within 30 days of its scheduled renewal. This notification is triggered by a scheduled job at 00:01 am UTC time for tenants in EU Cloud Data Center and US Cloud Data Center 1, or 00:01 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in US Cloud Data Center 2. For more information about data centers, see Zuora data centers.
60 days before renewal	Upcoming Renewal	The subscription is within 60 days of its scheduled renewal. This notification is triggered by a scheduled job at 00:01 am UTC time for tenants in EU Cloud Data Center and US Cloud Data Center 1, or 00:01 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in US Cloud Data Center 2. For more information about data centers, see Zuora data centers.
90 days before renewal	Upcoming Renewal	The subscription is within 90 days of its scheduled renewal. This notification is triggered by a scheduled job at 00:01 am UTC time for tenants in EU Cloud Data Center and US Cloud Data Center 1, or 00:01 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in US Cloud Data Center 2. For more information about data centers, see Zuora data centers.

Standard events for Zuora Payments

Payment notifications (processed and declined) are for electronic payments only, whether the payment was created by API or UI. External payments will not trigger these notifications.

The following table describes the standard events supported by Zuora Payments.

Name	Related Event	Description
Credit Balance Refund Processed	Credit Balance Refund Processed	A credit balance refund was processed successfully.
Gateway Reconciliation Job Completion	Gateway Reconciliation Job Completion	The gateway reconciliation job has completed. This feature is in Limited Availability. If you want to have access to the feature, submit a request at Zuora Global Support.
Manual Email For Payment	Manual Email For Payment	Send email notification manually from payment detail page.
First Attempt	Payment Declined	The payment was declined by the payment gateway upon the first attempt.
15 Day Warning	Payment Method Expiration	The credit card set as the default payment method on the account is within 15 days of expiration. This notification is triggered by a scheduled job at 5:15 am UTC time for tenants in EU Cloud Data Center and US Cloud Data Center 1, or 5:15 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in US Cloud Data Center 2. For more information about data centers, see Zuora data centers. This notification is sent even if the payment method has been closed. Zuora recommends not leaving a closed payment method as the default on an account.
30 Day Warning	Payment Method Expiration	The credit card set as the default payment method on the account is within 30 days of expiration. This notification is triggered by a scheduled job at 5:15 am UTC time for tenants in EU Cloud Data Center and US Cloud Data Center 1, or 5:15 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in US Cloud Data Center 2. For more information about data centers, see Zuora data centers. This notification is sent even if the payment method has been closed. Zuora recommends not leaving a closed payment method as the default on an account.
Manually	Payment Method Updated	The payment method was updated by a system user. A notification is sent only when the default payment method is updated, not other payment methods.
API	Payment Method Updated	The payment method was updated by a system user. A notification is sent only when the default payment method is updated, not other payment methods.
By Payment Method Updater	Payment Method Updated	The payment method was updated by the Payment Method Updater. A notification is sent only when the default payment method is updated, not other payment methods.
Manually	Payment Method Closed	The payment method was closed by a system user.
API	Payment Method Closed	The payment method was closed by a system user.
By Payment Method Updater	Payment Method Closed	The payment method was closed by the Payment Method Updater
Payment Method Updater Batch Started	Payment Method Updater Batch Started	A payment method updater batch was started.
Payment Method Updater Batch Completed	Payment Method Updater Batch Completed	A payment method updater batch was completed.
Payment Processed	Payment Processed	The payment was processed successfully.
Payment Refund Processed	Payment Refund Processed	A payment refund was processed successfully.
Completed Status	Payment Run Completion	Payment run is completed successfully.
Error Status	Payment Run Completion	Payment run is completed with error.
External Credit Balance Refund Processed	Credit Balance Refund Processed	The external credit balance refund was processed successfully.
External Payment Refund Processed	Payment Refund Processed	The external payment refund was processed successfully.
External Payment Processed	Payment Processed	The external payment was processed successfully.
Credit memo and debit memo events
Credit Memo Created Manually from Invoice	Credit Memo Created	Trigger the notification when a credit memo is created from an invoice through the Zuora UI.
Credit Memo Created Manually from Product Rate Plan Charge	Credit Memo Created	Trigger the notification when a credit memo is created from product rate plan charges through the Zuora UI.
Credit Memo Posted Manually	Credit Memo Posted	Trigger the notification when a credit memo is posted from the credit memo detail page or the credit memo list page in the Zuora UI.
Credit Memo Posted via API	Credit Memo Posted	Trigger the notification when a credit memo is posted through the Zuora REST API.
Credit Memo Posted within a Bill Run of Auto-Post	Credit Memo Posted	Trigger the notification when a credit memo is posted within a bill run and the bill run has auto-post. This is to support the existing email notification behavior from within a bill run.
Credit Memo Refund Processed	Credit Memo Refund Processed	Trigger the notification when a credit memo is refunded successfully.
External Credit Memo Refund Processed	Credit Memo Refund Processed	Trigger the notification when an external credit memo is refunded successfully.
Debit Memo Created Manually from Invoice	Debit Memo Created	Trigger the notification when a debit memo is created from an invoice through the Zuora UI.
Debit Memo Created Manually from Product Rate Plan Charge	Debit Memo Created	Trigger the notification when a debit memo is created from product rate plan charges through the Zuora UI.
Debit Memo Posted Manually	Debit Memo Posted	Trigger the notification when a debit memo is posted from the debit memo detail page or the debit memo list page in the Zuora UI.
Debit Memo Posted via API	Debit Memo Posted	Trigger the notification when a debit memo is posted through the Zuora REST API.
Manually email Credit Memo	Email Credit Memo	Send email notification and credit memo PDF from the credit memo detail page in the Zuora UI.
Manually email Debit Memo	Email Debit Memo	Send email notification and credit memo PDF manually from the debit memo detail page in the Zuora UI.

Standard events for Zuora Finance

The following table describes the standard events supported by Zuora Finance.

Name	Related Event	Description
Journal Run Completed Status	Journal Run Completion	Notification sent out when a journal run has completed successfully.
Journal Run Error Status	Journal Run Completion	Notification sent out when a journal run encounters an error.
Trial Balance Completed Status	Trial Balance Completion	Notification sent out when a trial balance has completed successfully.
Trial Balance Error Status	Trial Balance Completion	Notification sent out when a trial balance encounters an error.

Standard events for Zuora Central Platform

The following table describes the standard events supported by Zuora Central Platform.

Name	Related Event	Description
System Health API Concurrency	API Concurrency	On the APIs System Health dashboard, the number of concurrent API requests within a specified time range exceeds the threshold. You can customize the notification as needed with the following event parameters: Interval: the evaluation frequency of the event. Window: the time range that the concurrent API requests occurred in. API Concurrency Type: the type of concurrent API requests. Threshold Type: Number or Percentage. Threshold: the triggering number of concurrent API requests, or percentage (0 - 100) of concurrent request limit. For example, you can define a notification based on this event with the following values: Interval: 30 Window: 60 API Concurrency Type: BigProcess Threshold Type: Percentage Threshold: 80 Zuora evaluates the notification every 30 minutes. During the evaluation, if the number of concurrent Big Process requests over the last 60 minutes is greater than or equal to 16 (80 percent of the concurrent request limit for Big Process Request, which is 20 by default), this notification will be triggered. For more information about concurrent request types and limits, see Concurrent request limits.
System Health API Failure	API Failures	On the APIs System Health dashboard, the number of failed API requests within a specified time range exceeds the threshold. You can customize the notification as needed with the following event parameters: Interval: the evaluation frequency of the event. Threshold: the triggering number or percentage (0 - 100) of failed API requests. Threshold Type: Number or Percentage. Window: the time range that the failed API requests occurred in. Endpoint: the API endpoint of the failed API requests. You can select all API endpoints or a specific one. For example, you can define a notification based on this event with the following values: Interval: 30 Threshold: 10 Threshold Type: Number Window: 60 Endpoint: POST /v1/subscriptions Zuora evaluates the notification every 30 minutes. During the evaluation, if the number of failed subscription creation API requests over the last 60 minutes is greater than or equal to 10, this notification will be triggered.
System Health API Performance	API Performance	On the APIs System Health dashboard, the average response time of all API requests within a specified time range exceeds the threshold. You can customize the notification as needed with the following event parameters: Interval: the evaluation frequency of the event. Threshold: the triggering response time (in milliseconds) of API requests. Window: the time range that the API requests occurred in. Threshold Percentile: the threshold value type. Percentile (P95, P90, or P50) or mean. Endpoint: the API endpoint of the API requests. You can select all API endpoints or a specific one. For example, you can define a notification based on this event with the following values: Interval: 1440 Threshold: 5000 Window: 120 Threshold Percentile: P95 Endpoint: All Zuora evaluates the notification every 1440 minutes. During the evaluation, if the 95th percentile of the response time of all API requests over the last 120 minutes is greater than or equal to 5000 milliseconds, this notification will be triggered.
Completed Status	AQuA Data Export Completion	An AQuA data export is completed.
Async Request Succeeded	Async Request Succeeded	An asynchronous API request is completed successfully. For more information, see Make asynchronous requests.
Async Request Failed	Async Request Failed	An asynchronous API request fails. For more information, see Make asynchronous requests.
System Health Bill Preview Run Long Running	Bill Preview Run Long Running	The execution time of a running bill-preview-run job exceeds the threshold. You can customize the notification as needed with the following event parameters: Interval: the evaluation frequency of the event. Threshold: the triggering execution time of a running job. Note that this notification is triggered on a job basis.
System Health Bill Run Long Running	Bill Run Long Running	On the Bill Run System Health dashboard, the execution time of a running bill-run job exceeds the threshold. You can customize the notification as needed with the following event parameters: Interval: the evaluation frequency of the event. Threshold: the triggering execution time of a running job. Note that this notification is triggered on a job basis.
Completed Status	DataSource Export Completion	A data source export is completed.
System Health HPM Card Attack	HPM Card Attack	The HPM Threat Detection System Health dashboard detects a threat caused by card attacks. The Status on the dashboard turns to Under Attack when card attacks happen. You can customize the evaluation frequency of the event by configuring the Interval event parameter.
System Health HPM Page Attack	HPM Page Attack	The HPM Threat Detection System Health dashboard detects a threat caused by attacks on hosted payment pages. The Status on the dashboard turns to Under Attack when page attacks happen. You can customize the evaluation frequency of the event by configuring the Interval event parameter.
Completed Status	Import Processed	An import of usage records is completed successfully. For more information, see Import Usage Data.
Error Status	Import Processed	An import of usage records is not completed successfully. For more information, see Import Usage Data.
System Health Journal Run Long Running	Journal Run Long Running	On the Journal Run System Health dashboard, the execution time of a running journal-run job exceeds the threshold. You can customize the notification as needed with the following event parameters: Interval: the evaluation frequency of the event. Threshold: the triggering execution time of a running job. Note that this notification is triggered on a job basis.
System Health Notification Callout Failure	Notification Callout Failures	On the Notifications dashboard, the number of failed callout notifications within a specified time range exceeds the threshold. You can customize the notification as needed with the following event parameters: Interval: the evaluation frequency of the event. Window: the time range that the failed callout notifications occurred in. Threshold Type: Number or Percentage. Threshold: the triggering number or percentage (0 - 100) of failed callout notifications.
System Health Notification Callout Performance	Notification Callout Performance	On the Notifications dashboard, the percentile response time of callout notifications within a specified time range exceeds the threshold. You can customize the notification as needed with the following event parameters: Interval: the evaluation frequency of the event. Window: the time range that the callout notifications occurred in. Threshold Percentile: the percentile (P95, P90, or P50). Threshold: the triggering percentile response time (in milliseconds) of callout notifications. For example, you can define a notification based on this event with the following values: Interval: 10 Window: 60 Threshold Percentile: P90 Threshold: 10000 Zuora evaluates the notification every 10 minutes. If the 90th percentile of the response time of callout notifications over the last 60 minutes is greater than or equal to 10000 milliseconds, this notification will be triggered.
System Health Notification Email Failure	Notification Email Failures	On the Notifications dashboard, the number of failed email notifications within a specified time range exceeds the threshold. You can customize the notification as needed with the following event parameters: Interval: the evaluation frequency of the event. Window: the time range that the failed email notifications occurred in. Threshold Type: Number or Percentage. Threshold: the triggering number or percentage (0 - 100) of failed email notifications.
System Health Notification Email Performance	Notification Email Performance	On the Notifications dashboard, the percentile response time of email notifications within a specified time range exceeds the threshold. You can customize the notification as needed with the following event parameters: Interval: the evaluation frequency of the event. Window: the time range that the email notifications occurred in. Threshold Percentile: the percentile (P95, P90, or P50). Threshold: the triggering percentile response time (in milliseconds) of email notifications. For example, you can define a notification based on this event with the following values: Interval: 10 Window: 60 Threshold Percentile: P90 Threshold: 10000 Zuora evaluates the notification every 10 minutes. If the 90th percentile of the response time of email notifications over the last 60 minutes is greater than or equal to 10000 milliseconds, this notification will be triggered.
System Health Payments Failure	Payments Failures	On the Electronic Payments System Health dashboard, the number of failed electronic payments within a specified time range exceeds the threshold. You can customize the notification as needed with the following event parameters: Interval: the evaluation frequency of the event. Window: the time range that the failed electronic payments occurred in. Threshold Type: Number or Percentage. Threshold: the triggering number or percentage (0 - 100) of failed electronic payments.
System Health Payment Run Long Running	Payment Run Long Running	The execution time of a running payment-run job exceeds the threshold. You can customize the notification as needed with the following event parameters: Interval: the evaluation frequency of the event. Threshold: the triggering execution time of a running job. Note that this notification is triggered on a job basis.
System Health Tax Vendor Failure	Tax Vendor Failures	On the Tax Integration dashboard, the number of failed tax calls within a specified time range exceeds the threshold. You can customize the notification as needed with the following event parameters: Interval: the evaluation frequency of the event. Window: the time range that the failed tax calls occurred in. Threshold Type: Number or Percentage. Threshold: the triggering number or percentage (0 - 100) of failed tax calls.
System Health Trial Balance Long Running	Trial Balance Long Running	On the Trial Balance Run System Health dashboard, the execution time of a running trial-balance-run job exceeds the threshold. You can customize the notification as needed with the following event parameters: Interval: the evaluation frequency of the event. Threshold: the triggering execution time of a running job. Note that this notification is triggered on a job basis.
System Health Workflow Failure	Workflow Failures	On the Workflow System Health dashboard, the number of failed workflow tasks within a specified time range exceeds the threshold. You can customize the notification as needed with the following event parameters: Interval: the evaluation frequency of the event. Window: the time range that the failed workflow tasks occurred in. Threshold Type: Number or Percentage. Threshold: the triggering number or percentage (0 - 100) of failed workflow tasks.
System Health Workflow Performance	Workflow Performance	On the Workflow System Health dashboard, the percentile of the execution time of workflows within a specified time range exceeds the threshold. You can customize the notification as needed with the following event parameters: Interval: the evaluation frequency of the event. Window: the time range that the workflows occurred in. Threshold Percentile: the percentile (P95, P90, or P50). Threshold: the triggering percentile execution time (in milliseconds) of workflows. For example, you can define a notification based on this event with the following values: Interval: 30 Window: 60 Threshold Percentile: P95 Threshold: 5000 Zuora evaluates the notification every 30 minutes. If the 95th percentile of the execution time of workflows over the last 60 minutes is greater than or equal to 5000 milliseconds, this notification will be triggered.

Use Cases

Configure email notifications for Upcoming Renewal standard event

Zuora gives you the ability to send automated email notifications to customers for upcoming subscription renewals.

For subscriptions with auto-renew disabled, the subscription stops billing once the subscription term expires. Therefore, you must work with your customers in advance to renew the subscription and avoid a lapse in services. It is best practice to provide non auto-renewal customers with ample notice in case they want to make any changes to their subscription.

For subscriptions with auto-renew enabled, because the customer opted for auto-renewal when they signed up for your service, advanced notification is an optional courtesy.

The following solution shows you how to configure Zuora to automatically send customers an email notification when their subscription is coming up for renewal.

In Zuora, navigate to Settings > Z-Billing Settings > Setup Profiles, Notifications and Email Templates. Then follow these steps:

Click add new notification.

The Add New Notification panel is displayed.

Configure the notification as follows.

Field	Description
Related Event	Select Upcoming Renewal.
Name	Give the notification a name.
Description	Optionally enter a description of the notification.
Active	Select the check box to make the notification active.
Auto-Renewal	Select whether you want to notify customers with auto-renew enabled (true) or disabled (false). In this example, select false to notify only customers whose subscriptions are set not to auto-renew.
How Many Days Before	Enter the number of days before renewal that you want to notify the customer. Enter anywhere from 1 to 90 days.
Email	Select the check box so that customers will be notified by email. Select an email template from the drop-down menu. The drop-down menu displays the default templates and any custom templates you have created for upcoming renewals. The email template determines the email sent to customers. See Creating Email Templates for more information about how to create custom templates. In this example, select Upcoming Renewal Default Email Template (Manual Renewal).

Click add new notification to complete the configuration. Your new notification appears on the Define Notification list. See Create and Edit Notifications for more information about configuring notifications.

To view and edit the email template, click on the email template name to the right of the new notification in the Define Notification list. The email template page is displayed.
Edit the email template information as required. See Creating Email Templates for more information.
Scroll to the bottom of the email template page to see the email subject and body, as well as the available merge fields. Edit the email text and use the merge fields to personalize the email that each customer receives. See Email Template Merge Fields for more information.
Click save.

Configure notifications for the API Performance event

Zuora System Health dashboard for API collects metrics on API performance, usage, failure, and concurrency limit in your Zuora tenant. The API performance metrics include percentile response time of API requests within a specified time range. You can leverage these metrics to monitor the performance of each API endpoint in near real time.

To ensure stability and prevent latency, Zuora provides you the ability to send email or callout notifications when declines in API performance arise. With this ability, you do not need to monitor API performance metrics from the System Health dashboard repeatedly.

You can configure notifications with different triggering thresholds for API performance. It is best practice to set up a notification with a generic threshold for all API requests, and individual notifications with practical thresholds for specific API requests.

Perform the following steps to create a notification definition for the API Performance event:

Click your avatar on the upper-right corner, and then click Administration.
On the Administration Settings page, click Setup Profiles, Notifications and Email Templates.
In the Notifications section, if System is not selected by default, select System from the drop-down list.
Click Add New Notification.

In the Add New Notification window, specify the following required fields:

Field	Description
Related Event	Select API Performance from the drop-down list.
Name	The name of the notification definition.
Active	Select the checkbox to enable this notification.
Interval	The evaluation frequency of the event.
Threshold	The triggering average response time (in milliseconds) of API requests.
Window	The time range that the API requests occurred in.
Threshold Percentile	The threshold value type. Percentile (P95, P90, or P50) or mean.
Endpoint	The API endpoint of the API requests.

For more information about configuring notifications, see Create and edit notifications.

Click Add New Notification at the bottom of the window.
You can find the newly created notification definition from the table in the Notifications section.

For example, if you create a callout notification with the following values:

Interval: 1440
Threshold: 5000
Window: 120
Threshold Percentile: P95
Endpoint: All

Zuora evaluates this notification every 1440 minutes. During the evaluation, if the 95th percentile of the response time of all API requests over the last 120 minutes is greater than or equal to 5000 milliseconds, this notification will be triggered.

Notifications for other System Health dashboard events

You can configure notifications for not only the API Performance event, but also events from other System Health dashboards. These events include Payments Failures, HPM Card Attack, Workflow Performance, and so on. The notification configuration process for other events is similar to the process for the API Performance event. For all supported System Health events and event parameters, see Standard events for Zuora Central Platform.