Callout Notification for Completed AQuA Jobs
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 notification.
-
Navigate to Z-Billing Settings > Setup Profiles, Notifications, and Email Templates.
-
Click add new notification.
Only callout notification is supported.
-
Select AQuA Data Export Completion from the Event Category drop-down.
-
Enter an Event Name.
-
Enter an event Description (optional).
-
Enter information for the following fields:
Field Name | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Active | Activates the notification. You can also activate the notification at a later time. | ||||||||||||||||||
Partner Name | The partner field indicates the unique ID of a data integration partner. | ||||||||||||||||||
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 | ||||||||||||||||||
Add Parameter | Adds parameters to the callout.
| ||||||||||||||||||
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. |
-
Click add new notification.