For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
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:
Interval: the frequency at which the event is evaluated. It defines how often the system checks whether the event conditions are met.
Window: the time range over which concurrent API requests are measured. It defines the rolling time window used for evaluation.
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.
Mute Active: a boolean field indicates whether to mute this notification for a designated duration ( Mute Hour ) after triggering it a certain number of times ( Mute Limit ).
Mute Limit: the number of times Zuora will trigger this notification before muting it.
Mute Hour: the duration (in hours) for which Zuora will mute this notification.
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 frequency at which the event is evaluated. It defines how often the system checks whether the event conditions are met.
Threshold: the triggering number or percentage (0 - 100) of failed API requests.
Threshold Type: Number or Percentage.
Window: the time range over which failed API requests are measured. It defines the rolling time window used for evaluation.
Endpoint: the API endpoint of the failed API requests. You can select all API endpoints or a specific one.
Mute Active: a boolean field indicates whether to mute this notification for a designated duration ( Mute Hour ) after triggering it a certain number of times ( Mute Limit ).
Mute Limit: the number of times Zuora will trigger this notification before muting it.
Mute Hour: the duration (in hours) for which Zuora will mute this notification.
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.
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:
Interval: the frequency at which the event is evaluated. It defines how often the system checks whether the event conditions are met.
Threshold: the triggering response time (in milliseconds) of API requests.
Window: the time range over which API requests are measured. It defines the rolling time window used for evaluation.
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.
Mute Active: a boolean field indicates whether to mute this notification for a designated duration ( Mute Hour ) after triggering it a certain number of times ( Mute Limit ).
Mute Limit: the number of times Zuora will trigger this notification before muting it.
Mute Hour: the duration (in hours) for which Zuora will mute this notification.
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.
AQUA Data Export Completion (formerly known as 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.
A setting change occurs, or a Notification or Workflow object change occurs.
Setting change: changes on Billing, Payments, Commerce, Finance, Revenue, tenant, user management, and other settings tracked by Audit Trail. For a complete list of supported settings, see Audit setting change event.
Object change: changes on Notification or Workflow-related objects, including communication profile, email template, notification definition, workflow definition, and other objects tracked by Audit Trail. For a complete list of supported Notification and Workflow objects, see Audit object change event.
You can customize the notification with the following event parameters:
Action: the change action on the object, such as CREATED, UPDATED, DELETED, ADDED_TO_COLLECTION, or REMOVED_FROM_COLLECTION.
Namespace: the change type, such as Billing, Payments, or UserManagement, indicating the setting type. You can also specify Notifications or Workflow, indicating the object type.
For example, a notification with the following configuration will be triggered when the billing settings in your tenant are updated:
Action: UPDATED
Namespace: Billing
Whereas a notification with the following configuration will be triggered when a notification-related object is updated:
Action: UPDATED
Namespace: Notifications
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:
Interval: the frequency at which the event is evaluated. It defines how often the system checks whether the event conditions are met.
Threshold: the triggering execution time of a running job.
Mute Active: a boolean field indicates whether to mute this notification for a designated duration ( Mute Hour ) after triggering it a certain number of times ( Mute Limit ).
Mute Limit: the number of times Zuora will trigger this notification before muting it.
Mute Hour: the duration (in hours) for which Zuora will mute this notification.
You can customize the notification as needed with the following event parameters:
Interval: the frequency at which the event is evaluated. It defines how often the system checks whether the event conditions are met.
Threshold: the triggering execution time of a running job.
Mute Active: a boolean field indicates whether to mute this notification for a designated duration ( Mute Hour ) after triggering it a certain number of times ( Mute Limit ).
Mute Limit: the number of times Zuora will trigger this notification before muting it.
Mute Hour: the duration (in hours) for which Zuora will mute this notification.
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.
DataSource Export Completion (formerly known as Completed Status)
DataSource Export Completion
A data source export is completed.
Mediation Event Store Query Status Change
Event Store Query Status Changed
The execution status of an event store query changes. Status changes include when a query is submitted, starts running, completes successfully, or fails due to an error.
This event provides visibility into the full lifecycle of event store queries and enables monitoring of query execution and outcomes. You can use this event for the following use cases:
Tracking the progress and completion of event store queries
Detecting and responding to query failures
Triggering downstream operations or additional processing after a query completes
This event is available only if the Mediation feature is enabled.
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:
Interval: the frequency at which the event is evaluated. It defines how often the system checks whether the event conditions are met.
Mute Active: a boolean field indicates whether to mute this notification for a designated duration ( Mute Hour ) after triggering it a certain number of times ( Mute Limit ).
Mute Limit: the number of times Zuora will trigger this notification before muting it.
Mute Hour: the duration (in hours) for which Zuora will mute this notification.
You can customize the notification as needed with the following event parameters:
Interval: the frequency at which the event is evaluated. It defines how often the system checks whether the event conditions are met.
Threshold: the triggering execution time of a running job.
Mute Active: a boolean field indicates whether to mute this notification for a designated duration ( Mute Hour ) after triggering it a certain number of times ( Mute Limit ).
Mute Limit: the number of times Zuora will trigger this notification before muting it.
Mute Hour: the duration (in hours) for which Zuora will mute this notification.
A meter session runs longer than 30 minutes. The system emits a periodic status update every 30 minutes until the meter session completes or fails.
This event provides ongoing visibility into long-running meter sessions without waiting for the final outcome. You can use this event for the following use cases:
Monitoring the progress of long-running meter sessions
Gaining continuous operational visibility into mediation processing
Triggering alerts or operational checks for extended execution times
This event is available only if the Mediation feature is enabled.
Mediation Meter Session Status Change
Meter Session Status Change
The status of a meter session changes, such as from RUNNING to COMPLETED, FAILED, or PAUSED. The event can be triggered both for normal or debug (test) runs.
You can use this event for the following use cases:
Monitoring the lifecycle of meter sessions
Detecting failures and initiating recovery or retry logic
Triggering downstream processing after successful completion
This event is available only if the Mediation feature is enabled.
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:
Interval: the frequency at which the event is evaluated. It defines how often the system checks whether the event conditions are met.
Window: the time range over which failed callout notifications are measured. It defines the rolling time window used for evaluation.
Threshold Type: Number or Percentage.
Threshold: the triggering number or percentage (0 - 100) of failed callout notifications.
Mute Active: a boolean field indicates whether to mute this notification for a designated duration ( Mute Hour ) after triggering it a certain number of times ( Mute Limit ).
Mute Limit: the number of times Zuora will trigger this notification before muting it.
Mute Hour: the duration (in hours) for which Zuora will mute this notification.
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 frequency at which the event is evaluated. It defines how often the system checks whether the event conditions are met.
Window: the time range over which callout notifications are measured. It defines the rolling time window used for evaluation.
Threshold Percentile: the percentile (P95, P90, or P50).
Threshold: the triggering percentile response time (in milliseconds) of callout notifications.
Mute Active: a boolean field indicates whether to mute this notification for a designated duration ( Mute Hour ) after triggering it a certain number of times ( Mute Limit ).
Mute Limit: the number of times Zuora will trigger this notification before muting it.
Mute Hour: the duration (in hours) for which Zuora will mute this notification.
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 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:
Interval: the frequency at which the event is evaluated. It defines how often the system checks whether the event conditions are met.
Window: the time range over which bounced emails are measured. It defines the rolling time window used for evaluation.
Threshold Type: Number or Percentage.
Threshold: the triggering number or percentage (0 - 100) of bounced emails.
Mute Active: a boolean field indicates whether to mute this notification for a designated duration ( Mute Hour ) after triggering it a certain number of times ( Mute Limit ).
Mute Limit: the number of times Zuora will trigger this notification before muting it.
Mute Hour: the duration (in hours) for which Zuora will mute this notification.
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 frequency at which the event is evaluated. It defines how often the system checks whether the event conditions are met.
Window: the time range over which failed email notifications are measured. It defines the rolling time window used for evaluation.
Threshold Type: Number or Percentage.
Threshold: the triggering number or percentage (0 - 100) of failed email notifications.
Mute Active: a boolean field indicates whether to mute this notification for a designated duration ( Mute Hour ) after triggering it a certain number of times ( Mute Limit ).
Mute Limit: the number of times Zuora will trigger this notification before muting it.
Mute Hour: the duration (in hours) for which Zuora will mute this notification.
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 frequency at which the event is evaluated. It defines how often the system checks whether the event conditions are met.
Window: the time range over which email notifications are measured. It defines the rolling time window used for evaluation.
Threshold Percentile: the percentile (P95, P90, or P50).
Threshold: the triggering percentile response time (in milliseconds) of email notifications.
Mute Active: a boolean field indicates whether to mute this notification for a designated duration ( Mute Hour ) after triggering it a certain number of times ( Mute Limit ).
Mute Limit: the number of times Zuora will trigger this notification before muting it.
Mute Hour: the duration (in hours) for which Zuora will mute this notification.
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.
You can customize the notification as needed with the following event parameters:
Interval: the frequency at which the event is evaluated. It defines how often the system checks whether the event conditions are met.
Window: the time range over which failed electronic payments are measured. It defines the rolling time window used for evaluation.
Threshold Type: Number or Percentage.
Threshold: the triggering number or percentage (0 - 100) of failed electronic payments.
Payment Method Type: the payment method the failed payments used, such as CreditCard, PayPal, ACH, or other methods.
Source Type Operator: the operator for the Source Type parameter. Available values are Equal and NotEqual .
Source Type: the way the failed payments were created, such as Manually, PaymentRun, API, or other ways.
Mute Active: a boolean field indicates whether to mute this notification for a designated duration ( Mute Hour ) after triggering it a certain number of times ( Mute Limit ).
Mute Limit: the number of times Zuora will trigger this notification before muting it.
Mute Hour: the duration (in hours) for which Zuora will mute this notification.
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 frequency at which the event is evaluated. It defines how often the system checks whether the event conditions are met.
Threshold: the triggering execution time of a running job.
Mute Active: a boolean field indicates whether to mute this notification for a designated duration ( Mute Hour ) after triggering it a certain number of times ( Mute Limit ).
Mute Limit: the number of times Zuora will trigger this notification before muting it.
Mute Hour: the duration (in hours) for which Zuora will mute this notification.
You can customize the notification as needed with the following event parameters:
Interval: the frequency at which the event is evaluated. It defines how often the system checks whether the event conditions are met.
Window: the time range over which syncing failed records are measured. It defines the rolling time window used for evaluation.
Threshold Type: Number or Percentage.
Threshold: the triggering number or percentage (0 - 100) of syncing failed records.
Mute Active: a boolean field indicates whether to mute this notification for a designated duration ( Mute Hour ) after triggering it a certain number of times ( Mute Limit ).
Mute Limit: the number of times Zuora will trigger this notification before muting it.
Mute Hour: the duration (in hours) for which Zuora will mute this notification.
You can customize the notification as needed with the following event parameters:
Interval: the frequency at which the event is evaluated. It defines how often the system checks whether the event conditions are met.
Window: the time range over which synced records are measured. It defines the rolling time window used for evaluation.
Threshold: the triggering time of latency (in milliseconds). It is based on the rounded-up average latency within the time window.
Mute Active: a boolean field indicates whether to mute this notification for a designated duration ( Mute Hour ) after triggering it a certain number of times ( Mute Limit ).
Mute Limit: the number of times Zuora will trigger this notification before muting it.
Mute Hour: the duration (in hours) for which Zuora will mute this notification.
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 frequency at which the event is evaluated. It defines how often the system checks whether the event conditions are met.
Window: the time range over which failed tax calls are measured. It defines the rolling time window used for evaluation.
Threshold Type: Number or Percentage.
Threshold: the triggering number or percentage (0 - 100) of failed tax calls.
Mute Active: a boolean field indicates whether to mute this notification for a designated duration ( Mute Hour ) after triggering it a certain number of times ( Mute Limit ).
Mute Limit: the number of times Zuora will trigger this notification before muting it.
Mute Hour: the duration (in hours) for which Zuora will mute this notification.
You can customize the notification as needed with the following event parameters:
Interval: the frequency at which the event is evaluated. It defines how often the system checks whether the event conditions are met.
Threshold: the triggering execution time of a running job.
Mute Active: a boolean field indicates whether to mute this notification for a designated duration ( Mute Hour ) after triggering it a certain number of times ( Mute Limit ).
Mute Limit: the number of times Zuora will trigger this notification before muting it.
Mute Hour: the duration (in hours) for which Zuora will mute this notification.
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:
Interval: the frequency at which the event is evaluated. It defines how often the system checks whether the event conditions are met.
Window: the time range over which failed workflow runs are measured. It defines the rolling time window used for evaluation.
Threshold Type: Number or Percentage.
Threshold: the triggering number or percentage (0 - 100) of failed workflow runs.
Mute Active: a boolean field indicates whether to mute this notification for a designated duration ( Mute Hour ) after triggering it a certain number of times ( Mute Limit ).
Mute Limit: the number of times Zuora will trigger this notification before muting it.
Mute Hour: the duration (in hours) for which Zuora will mute this notification.
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 frequency at which the event is evaluated. It defines how often the system checks whether the event conditions are met.
Window: the time range over which workflows are measured. It defines the rolling time window used for evaluation.
Threshold Percentile: the percentile (P95, P90, or P50).
Threshold: the triggering percentile execution time (in milliseconds) of workflows.
Mute Active: a boolean field indicates whether to mute this notification for a designated duration ( Mute Hour ) after triggering it a certain number of times ( Mute Limit ).
Mute Limit: the number of times Zuora will trigger this notification before muting it.
Mute Hour: the duration (in hours) for which Zuora will mute this notification.
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.
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:
Interval: the frequency at which the event is evaluated. It defines how often the system checks whether the event conditions are met.
Window: the time range over which failed workflow tasks are measured. It defines the rolling time window used for evaluation.
Threshold Type: Number or Percentage.
Threshold: the triggering number or percentage (0 - 100) of failed workflow tasks.
Mute Active: a boolean field indicates whether to mute this notification for a designated duration ( Mute Hour ) after triggering it a certain number of times ( Mute Limit ).
Mute Limit: the number of times Zuora will trigger this notification before muting it.
Mute Hour: the duration (in hours) for which Zuora will mute this notification.
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. Additionally, if the Window is larger than the Interval, the evaluation windows will overlap. As a result, the same underlying event may be evaluated multiple times across adjacent windows, which can lead to duplicate notifications being triggered for a single occurrence.
