Notifications: Callout

Task use

You use the callout task to establish communication and transfer data between Zuora and other systems.

You can also use the callout task to perform operations that are only possible with Zuora APIs. 

For example, you can create, update or delete multiple records of the same object in a single callout task. To do so, you need to perform a callout to the object update operation and include the array of records in the request body. You can use an iterate statement in Liquid to iterate the array in the request body. 

Here is an example request body for updating the Notes field of multiple accounts in Zuora with the data in the payload.

{
  "objects": [
  {% for account in Data.Account %}
    {
      "Id": "{{account.Id}}",
      "Notes":"{{account.Notes}}"
    }{% if forloop.last == false %} , {% endif %}
  {% endfor %}
  ],
  "type": "Account"
}

You can create/update a “Notification: Callout” task in the following ways:

• Create/update a task by selecting a template from the Select Callout to Zuora API dropdown list.
  1. On the Headers tab, click the dropdown list under Select Callout to Zuora API.
  2. Select the template from the list. You can enter a few letters in the text field and filter the template quickly.
  3. After you select the template, information for API type, URL endpoint, available merge fields/arrays, authentication, and API validation options are preloaded. You can further complete the task configuration manually if needed.

• Create/update a task by manually entering all the required fields.

Headers

You can use the Zuora system constants or your own constants to refer to endpoints and credentials for Zuora and other systems. To learn about how to define a constant, see Global Constants of Workflow. For the available Zuora system constants, see the following table.

You need to wrap constants with double curly brackets.

You can set up a retry strategy for the callout task by specifying the "max retry count" and "window retry time (min)" fields.

To allow the logs of callouts sent via this task to be included in the Callout History report, check the Customer Notification History checkbox in the Headers tab. When this option is enabled, you must also specify the customer account ID to which the history will be attached. 
To receive a valid response, you must set appropriate values for each field while configuring the callout. For example, the Body must be in valid JSON format if you specify JSON as the response header's Content-Type.

Body

You can specify the request body of the callout task in one of the following ways:

• form-data
• raw
• binary

Note that you can use Liquid statements in the request body when selecting the raw data option.

Authentication

You select the authorization type and specify details in the Authentication tab. Zuora recommends that you use OAuth 2.0 to authenticate to the Zuora REST API. 

When sending callouts to Zuora, you can select zuora as the authorization type to use the credentials of your Zuora tenant. When this option is selected, you do not need to specify Zuora credentials in the header.

When setting up Mutual TLS Authentication, ensure that the certificate data you entered must contain the content of a PEM file having the private key appended.

{{Data.Request.Headers.Date}}

{{Data.HMAC.Signed}}

Response

• Payload Placement: Use this field to specify the location where the data generated from this task will be stored. The default placement for a callout task is Callout. If multiple callout tasks use the same payload placement, the data for each task will be appended to the same array as a separate object. If you want the data from a downstream task to replace the data from an upstream task, select the Replace Payload option.
• Zuora API Validation: This option is selected by default when configuring a callout to a Zuora API, ensuring that Workflow will retry failed requests due to API limits being reached, lock issues, or temporary errors. Workflow automatically validates the Zuora API tasks, and the tasks are marked as failed if the validation fails due to errors like business logic, API issues, and so on. Then, the API execution is stopped.
  If you want to proceed with the API execution for the failed tasks, go to the Settings tab of the Callout task and disable the Zuora API Validation option. Then the error tasks will continue to generate downstream tasks and write callout responses into the payload.