Standard events for Zuora Platform
Describes the standard events supported by Zuora 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:
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:
For example, you can define a notification based on this event with the following values:
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. Because of the defined polling interval, some API failures might not be instantly picked up by the notification system, which can cause a temporary discrepancy between the notification record and the API System Health dashboard. The impact of such a discrepancy should be minimal, and it will be auto-rectified over time. |
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:
For example, you can define a notification based on this event with the following values:
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. |
Audit Trail Change Event |
Audit Change Event |
A setting change occurs, or a Notification or Workflow object change occurs.
You can customize the notification with the following event parameters:
For example, a notification with the following configuration will be triggered when the billing settings in your tenant are updated:
Whereas a notification with the following configuration will be triggered when a notification-related object is updated:
Note that this event is available only if you have the Zuora Protect feature enabled. |
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:
This notification is triggered on a job basis, and the mute parameters are separately handled against each bill-preview-run job. For more information, see Mute notifications for System Health dashboard events. |
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:
This notification is triggered on a job basis, and the mute parameters are separately handled against each bill-run job. For more information, see Mute notifications for System Health dashboard events. |
System Health Custom Object Records High Usage |
Custom Object Records High Usage |
The number of custom object records of a specific custom object definition exceeds 80% and is below 99% of the maximum record limit. Zuora evaluates this event on a daily basis. For more information about the maximum limit of custom object records, see Zuora Editions. |
System Health Custom Object Records Max Usage |
Custom Object Records Max Usage |
The number of custom object records of a specific custom object definition equals or exceeds 99% of the maximum record limit. Zuora evaluates this event on a daily basis. For more information about the maximum limit of custom object records, see Zuora Editions. |
System Health Data Connect Failure |
Data Connect Failures |
On the Zuora Connector for Salesforce CRM dashboard, the number of syncing failed records within a specified time range exceeds the threshold. You can customize the notification as needed with the following event parameters:
|
System Health Data Connect Performance |
Data Connect Performance |
On the Zuora Connector for Salesforce CRM dashboard, the average record sync latency within a specified time range exceeds the threshold. You can customize the notification as needed with the following event parameters:
|
Completed Status |
DataSource Export Completion |
A data source export is completed. |
System Health HPM Attack |
HPM 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 HPM attacks happen. You can customize the notification as needed with the following event parameters:
This notification is triggered on an attack-event basis, and the mute parameters are separately handled against each attack event. For more information, see Mute notifications for System Health dashboard events. |
Completed Status |
Import Processed |
An import of usage records is completed successfully. For more information, see Import Usage Data. |
Failed 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:
This notification is triggered on a job basis, and the mute parameters are separately handled against each journal-run job. For more information, see Mute notifications for System Health dashboard events. |
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. All callout failures, including temporary failures that the system will retry and permanent failures that have reached the maximum number of delivery attempts, are counted toward this event. You can customize the notification as needed with the following event parameters:
|
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:
For example, you can define a notification based on this event with the following values:
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 Bounced Email Alert |
Notification Email Bounce Alert |
On the Notifications dashboard, the number of bounced emails within a specified time range exceeds the threshold. You can customize the notification as needed with the following event parameters:
|
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:
|
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:
For example, you can define a notification based on this event with the following values:
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:
|
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:
This notification is triggered on a job basis, and the mute parameters are separately handled against each payment-run job. For more information, see Mute notifications for System Health dashboard events. |
System Health SFDC CPQ Connector Sync Failure |
SFDC CPQ Connector Sync Failure |
On the Integration Hub System Health dashboard, a data sync between Salesforce CPQ and Zuora fails within a specified time range. You can customize the notification as needed with the following event parameters:
|
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:
|
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:
This notification is triggered on a job basis, and the mute parameters are separately handled against each trial-balance-run job. For more information, see Mute notifications for System Health dashboard events. |
System Health Workflow Failure |
Workflow Failures |
On the Workflow System Health dashboard, the number of failed workflow runs within a specified time range exceeds the threshold. A workflow run is considered a failure if it contains one or more failed workflow tasks. You can customize the notification as needed with the following event parameters:
|
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:
For example, you can define a notification based on this event with the following values:
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. |
System Health Workflow Task Failure |
Workflow Task Failures |
On the Workflow System Health dashboard, the number of failed workflow tasks of a workflow run within a specified time range exceeds the threshold. You can customize the notification as needed with the following event parameters:
This notification is triggered on a task basis, and the mute parameters are separately handled against each task. For more information, see Mute notifications for System Health dashboard events. |
Note that System Health events are pre-defined by Zuora and are evaluated as custom events. If multiple notification definitions are configured for the same System Health event, multiple notifications may be triggered when the conditions for more than one definition are met.