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.

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.

Procedure

The high-level steps for creating a callout notification are as follows:

  1. Create a callout template.
  2. Set up a callout notification.

Create a callout template

To create a callout template, perform the following steps:

  1. Navigate to Extension Studio > Events & Notifications in the left navigation menu.
  2. Click the Callout Templates tab. The Callout Templates page opens.
  3. Click + Add New Callout Template.
  4. In the Create Callout Template dialog, enter the following information:
    • Name: Specify a name for the callout template.
    • Related Event: Select System > Aqua > 2610 - AQUA Data Export Completion.
    • HTTP Method: Select the method in which you want to send the callout data.
    • Request URL: Specify the webpage or URL to which you want to send the callout data. This is the path to the receiver service of the callout.
    • Merge Fields: Add the following merge fields to the callout request body.
      • Aqua.JobId: The job ID created for the AQuA request.
      • Aqua.JobStatus: The job status.
      • Aqua.PartnerName: The unique ID of a data integration partner.
      • Event.Category: This identifies that this is an AQuA callout notification.
      • Event.Timestamp: The AQuA job execution timestamp.
    • Authentication Type: Select the authentication type and specify other relevant fields that vary depending on the type.
    • Retriable: Select this checkbox to apply the callout retry rules. For more information, see Configure callout settings.
    For more information about all available fields, see Manage callout templates.
  5. Click Save.

Set up a callout notification

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

  1. Navigate to Extension Studio > Events & Notifications in the left navigation menu.

  2. Click + Add New Notification.

  3. Create the notification step-by-step with the following information:

      Configuration details
    Step 1: Define Trigger Click On An Event Occurrence.
    Step 2: Select Event Select System > Aqua > 2610 - AQUA Data Export Completion.
    Step 3: Set Filters

    Enter 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 using the stateless mode instead of the stateful mode to extract bulk data. See Bulk data extraction from Zuora using AQuA for best practices.
    Step 4: Set Delivery Options From the Delivered By Callout list, select the callout template you just created.
    Step 5: Define Target Accounts

    Select a communication profile.

    For more information, see Communication profiles.
    Step 6: Finalize Notification Details Specify the following basic information:
    • Name: The notification name.
    • Description: The notification description.
    • Active: Toggled on by default, indicating the notification will be sent when the AQUA Data Export Completion event occurs.
    Step 7: Review Notification Review the notification settings.

    For more information, see Create a notification.

  4. Click Done.