Skip to main content

Callout Notification for Completed AQuA Jobs

Zuora

Callout Notification for Completed AQuA Jobs

  1. Last updated
  2. Save as PDF

You can configure a callout notification to be sent after an AQuA job has completed, using the Zuora notification framework. You must have the Callout Notification feature enabled. Submit a request with Zuora Global Support for assistance. 

Callout notifications that you configure through the Zuora user Interface have higher precedence than callout notifications that you specify in AQuA queries.

If you configure a callout notification through the Zuora user interface, then submit an AQuA query with notifyUrl specified, the value of notifyUrl will be ignored. Zuora recommends that you check whether your organization has set up any Post Query with Notification calls before you configure a callout notification through the Zuora user interface.

Set up a callout notification

Perform the following steps to set up a notification. Remember only callout notification is supported.

  1. Log in to the Zuora application with administrative privileges.

  2. Click your username at the upper right corner and click Billing.

  3. On the Billing Settings page, click Setup Profiles, Notifications, and Email Templates.

  4. To add a callout notification, in the Notifications section, click add new notification.

  5. In the Add New Notification dialog, select AQuA Data Export Completion from the Related Event list, enter an event name, and optionally a description.

  6. Enter information for the following fields as needed:

Field name Description

Active

Activates 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.

Partner Name

The partner field indicates the unique ID of a data integration partner.
This is the same partner name used for the incremental load with AQuA version 1.1.
Only one notification can be configured for each partner.
For stateful AQuA callouts, this field is required.
For stateless AQuA callouts, this field can be null.

Zuora highly recommends you use the stateless mode instead of the stateful mode to extract bulk data. See Bulk data extraction from Zuora using AQuA for best practices.

Callout

Select Callout as the notification type.

Base URL

The webpage or URL for which you would like to send the callout data. This is the path to the
receiver service of the callout.

Add Parameter

Adds parameters to the callout.

Parameter Name

Specifies the name for the callout. This field defaults to a name
associated with the Parameter Value.

Parameter Value

Specifies the object and field name that can be passed
in as a parameter.

Parameter Value

Description

Aqua.JobId

The job ID created for the AQuA
request.

Aqua.JobStatus

The AQuA job status.

Aqua.PartnerName

The unique ID of a data integration
partner.

Aqua.Result

The status of the AQuA job execution.

Event.Category

This identifies that this is an AQuA
 callout notification.

Event.Timestamp

The AQuA job execution timestamp.

HTTP Method

Select the method in which you want to send the callout data: POST, PUT, GET, or DELETE. 

Retry

This is disabled by default. Enable this if you want the callout attempt to be retried based on the Callout Options set up for your customer notifications.

Callout Authentication

Select this option to enable the callout for this event.

Username

The username associated with the receiver service of the callout.

Password

The password associated with the username.

Domain (optional)

Domain associated with the username. 

  1. Click add new notification.