Loading
Workato
Copied to clipboard

Connector Recipes

Contents

The provided connector features an hierarchy of the Workato recipes. Namely, there are four main recipes that need to be started manually once the connector is deployed. In case a parent recipe is launched successfully, its interconnected sub-recipes will be started automatically.

The following outlines and describes the recipes structure for the provided connector on the Workato platform. Note that the connector may feature more recipes in the future. Therefore, make sure to check this article for updates regularly.

Buy Product Flow

This recipe is triggered by your deployed connector once purchase or update subscription requests are generated on your target application. Therefore, the Workato platform will process all insertions and updates of the subscription objects and passes corresponding information to the CloudBlue Connect platform.

Note that this recipe features several checks for filtering out events that are not interconnected with purchases and purchases that are not associated with Connect products.

Once your target application (e.g., Zuora) sends Account, Tier 1, and Asset (Subscription) data to Workato via your connected application API, the Workato system processes and passes required data to the CloudBlue Connect platform as the Asset (Subscription) Purchase Requests.

The Buy Product Flow recipe also includes the following sub-recipes that can be activated automatically once this recipe is activated:

Get orders by subscription

This recipe is used to get fulfillment requests by their identifier on your target application.

For example, in case the Zuora platform is integrated, fulfillment requests are represent Orders and their identifiers represent Subscription Numbers. Therefore, this recipe helps you collect orders on the Zuora platform by specifying their subscription number.

Save Connect Response

The Save Connect Response recipe, as the name implies, is used to save Connect response data and pass this data to your target application. In general, the response data includes required subscription information, fulfillment request identifier, and information on possible errors on Connect.

In case the Zuora platform is integrated, this recipe is used to save subscription, order number, and error information as custom fields within the order custom object on Zuora.

Update Orders custom object

This recipe is used to update required subscription and fulfillment request information on your target application.

Namely, in case the Zuora platform is integrated, this recipe updates required variables (i.e.,object_id, order_number, fr_id) and saves them within the custom object on Zuora.

Change subscription

This recipe is triggered by your deployed HTTP connector that searches for subscription changes and collects item-related data from your target application. This recipe also features several checks for filtering out events that are not interconnected with subscription changes and actions that are not associated with Connect products.

For instance, in case you work with the Zuora platform, the Workato system processes your Zuora orders and passes required item data and passes to the CloudBlue Connect platform as one of the following objects: Asset (Subscription) Change Request, Asset (Subscription) Cancel Request, or Asset (Subscription) Suspend/Resume Request.

Get Order Action Attributes

The Get Order Action Attributes recipe is used for item mapping on the CloudBlue Connect platform.

Namely, in case the Zuora platform is integrated, the Workato system updates and returns ProductRatePlanID and quantity variables.

GetQuantity

This Get Quantity recipe, as the name suggests, is used to get required item quantity information based on the specified charge type (e.g., one time purchase, recurring purchases, and so on).

Get Product by RatePlanId

This recipe is used to process ProductRatePlanID (on the Zuora platform) and return mapped Connect Product Item ID based on this identifier.

Save Connect Response

As mentioned before, recipe is used to save Connect response data and pass this data to your target application. This recipe can be automatically activated in case the Change Subscription recipe is launched and it is required to register corresponding response data.

Update Orders custom object

As mentioned before, this recipe is used to update required subscription and fulfillment request information on your target application. This recipe is activated automatically once the Save Connect Response recipe is launched and it is required to update order custom object on the Zuora platform.

Update Provisioned Subscriptions and Orders

This recipe is used to register approved subscription requests on the CloudBlue Connect platform and to update corresponding information on your target application.

For example, in case the Zuora platform is integrated, the Workato system processes approved Connect subscription requests and updates Zuora subscription and order object with corresponding status.

Note that this recipe can also be used to set up trigger date for updating subscriptions and completing orders on target application.

Get Orders Trigger Dates

The Get Orders Trigger Dates recipe is used to check if the aforementioned trigger date for your target application is configured and activated. Namely, this recipe provides the same functionality as assigning the effective date for your subscription requests on the Connect platform.

Save Connect Response

As mentioned before, recipe is used to save Connect response data and pass this data to your target application. This recipe can be automatically activated in case the Update Provisioned Subscriptions and Orders recipe is launched and it is required to register required response data.

Update Orders custom object

As mentioned before, this recipe is used to update required subscription and fulfillment request information on your target application. This recipe is also activated automatically once the Save Connect Response recipe is launched and it is required to update order custom object on the Zuora platform.

Usage update

This recipe is used to register new usage files that are created on the CloudBlue Connect platform. Once a new usage file is provided, the Workato system formats required usage records and submits them to your target application.

If the Zuora platform is integrated, the Workato system converts Connect usage records to the format that is used on Zuora. Therefore, required records will be available from the Usage module on the Zuora platform.

Get Product by RatePlanId

This recipe is used to process ProductRatePlanID (on the Zuora platform) and return mapped Connect Product Item ID based on this identifier. This recipe can also be automatically activated the Usage Update recipe.

Contact us Contact us
Revolutionize your business

Talk with a CloudBlue expert today to get started