Invoke Endpoint

UiPath.Workato.Activities.InvokeEndpoint

The Invoke Endpoint activity uses the Workato API to call recipes.

After executing the call to the Workato endpoint, the activity outputs endpoint-specific field values (if applicable) and the status of the request (success/failure information) in a ResponseStatus object (ResponseStatus) that you can use in subsequent activities (e.g., conditional logic).

How it works

The following steps and message sequence diagram is an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

1. Complete the Setup steps.
2. Add the Workato Scope activity to your project.
3. Add the Invoke Endpoint activity inside the Workato Scope activity.
4. Click the Configure button inside the Invoke Endpoint activity (this opens the Object Wizard).
5. Select the API Collection that contains the endpoint you want to call from the API Collection drop-down list.
6. Select the Endpoint you want to call from the Endpoint drop-down list.
7. Enter the credentials that will be used to call the endpoint.
8. Enter values for the fields returned in the Object Wizard.
9. Create and enter a ResponseStatus variable for the Output property, as well as, any fields that have a Direction value of Out.

In the Body of the Activity

To enter your Invoke Endpoint property values, you must use the Object Wizard by clicking the Configure button. Both input and output properties for the Operation you select in the Wizard can be specified in the dialog.

To learn more about the Object Wizard, see the Business Activity Frameworks page.

Note:

The properties shown in the property list are those specified in the Workato endpoint you select.

Endpoints with GET verbs have the option to have explicit properties and data types. All other REST verbs (POST, PUT, etc.) will have a single body input field for input properties that is a jObject.

Properties

Common

• DisplayName - The display name of the activity. This field supports only Strings or String variables.

Misc

• Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Output

• ResponseStatus - The status of the request (success/failure information). Enter a ResponseStatus variable (UiPath.BAF.Models.ResponseStatus). The ResponseStatus object includes three properties that you can use in other activities.
  • Success - Boolean - Specifies whether the API request was successful.
  • ErrorCode - String - The response error if the API request is unsuccessful (Success=False).
  • Message - String - The error message.