Entity selection for Callout tasks

Notifications: Callout and Notifications: Asynchronous Callout use the task-level Entity dropdown on the Authentication tab.

Authorization Type requirement

The Entity selector on the Authentication tab is displayed only when Authorization Type is set to Zuora. If you use any other authorization type (for example, OAuth 2.0, Basic Auth, or None), the Entity selector is not available on the Authentication tab.

To configure entity selection for a Zuora Callout:

1. Open the Callout task.
2. Click the Authentication tab.
3. Set Authorization Type to Zuora.
4. In the Entity dropdown, select the target entity.

Entity resolution for Callout tasks

When a Callout task runs with Authorization Type set to Zuora, Workflow resolves the entity for the API request using the following hierarchy:

1. Configured request headers - If the Headers tab includes a Zuora-Entity-Ids header, Workflow uses the value specified in that header. You can enter a static entity ID or a Liquid expression that resolves to an entity ID at run time.
2. Authentication tab Entity setting - If Zuora-Entity-Ids is not defined in the configured headers, Workflow uses the entity selected in the Entity dropdown on the Authentication tab.

Example: Callout to retrieve an account

The following example shows a Callout task that retrieves an account from a specific entity using Zuora tenant credentials.

Authentication tab:

• Authorization Type - Zuora
• Entity — Select the target entity (for example, UK Entity)

Request tab:

• Method - GET
• URL - https://rest.zuora.com/v1/accounts/{{Data.Account.Id}}

When the task runs, Workflow automatically adds the Zuora-Entity-Ids header set to the entity selected on the Authentication tab when sending the request to Zuora.

Example: Dynamic entity using Entity selector

The following example shows a Callout task that retrieves an account from an entity dynamically using Zuora tenant credentials. This could be used when the workflow has the entity defined in a parameter on the workflow or is determined by another step in the workflow.

Authentication tab:

• Authorization Type - Zuora
• Entity - Select the variable for the target entity (for example, {{Workflow.EntityId}} or {{Data.Liquid.EntityId}}). Any defined parameters that are available to this task will be presented in the dropdown to select from.

Request tab:

• Method - GET
• URL -https://rest.zuora.com/v1/accounts/{{Data.Account.Id}}

When the task runs, Workflow automatically adds the Zuora-Entity-Ids header set to the variable defined on the Authentication tab when sending the request to Zuora.

Example: Dynamic entity using request headers

In most cases, a dynamic entity variable should be defined on the Authentication tab Entity selector, but this example shows how this could also be defined as a header, which will be used as a higher priority, when defined.

To target different entities dynamically within the same workflow, configure the Zuora-Entity-Ids header on the Headers tab instead of selecting or configuring the entity or variable on the Authentication tab.

Authentication tab:

• Authorization Type - Zuora

Headers tab:

In this example, Workflow uses the header value to determine the entity. The entity selected on the Authentication tab is used only when the Zuora-Entity-Ids header is not configured.