Skip to main content

Invoke Custom Service in a Workflow

Learn how to invoke a published Custom Service from a Yeeflow Workflow. The Invoke custom service action allows workflows to execute reusable business logic and use returned results in later workflow steps.

Overview

After a Custom Service is published, you can invoke it from a Workflow using the Invoke custom service action.

This allows workflows to:

  • Execute reusable business logic

  • Pass workflow data into a Custom Service

  • Receive returned values

  • Use the results in subsequent workflow steps

Before adding this action, publish the Custom Service the workflow will call.

For information about creating and publishing Custom Services, see:


Add Invoke Custom Service Action

You can add the Invoke custom service action from the Workflow Designer.

Steps

  1. Open the workflow you want to configure.

  2. Open the Workflow Designer.

  3. From the left action panel, go to:

Integration → Invoke custom service

  1. Drag the Invoke custom service action into the workflow.

After adding the action, configure the service settings.

Invoke custom service in the Integration group of the Workflow Designer.


Configure Invoke Custom Service Action

The configuration panel includes:

  • Action name

  • Description

  • Service

  • Connection variables

  • Input variables

  • Output variables


Action Name

Enter a name for the workflow action.

The action name helps identify this step in the workflow.

Description

Add an optional description to explain the purpose of this action.


Select Service

In the Service field, select the published Custom Service you want to invoke.

The service selector displays available services from:

  • This application: Custom Services created in the current application.

  • Shared: Custom Services shared from other applications.

You can use the search box to quickly find a service.

Only published Custom Services can be selected. Use App to filter to this application, Shared to filter to services shared with it, or All for both.

Service selector search and All, App, and Shared filters.

If you need to create or manage Custom Services, click Manage services.

You can also access Custom Services from:

Application Settings → Integrations → Custom services

For more information, see:


Configure Service Variables

After selecting a Custom Service, the configuration panel displays the variables defined in that service.

The available variable types include:

  • Connection variables

  • Input variables

  • Output variables

These variables are configured when creating the Custom Service and are used to pass data into the service and receive returned results.


Configure Connection Variables

If the selected Custom Service requires external connections, the required Connection variables will be displayed.

Connection variables are defined in the Custom Service and provide the required connection information when the service is executed.

Assign the required connections before running the workflow. Use test connections during validation and confirm they are authorized for the resources and operations the service needs.

If the service does not require connections, this section will remain empty.

For more information about Connection variables, see:


Configure Input Variables

Input variables define the data passed from the Workflow to the Custom Service.

The input variables displayed here are defined in the selected Custom Service.

When a Custom Service is created, its required input variables are configured in the service settings. The Workflow then provides values for these inputs when the service is invoked.

You can provide input values in two ways:

Map Existing Workflow Values

You can map existing workflow data to the Custom Service input variables.

Available values may include:

  • Form fields

  • Data List fields

  • Workflow variables

  • Attachments

  • Previous action outputs

Use Expression Editor

If the required value needs to be generated dynamically, you can use the Expression Editor.

The Expression Editor allows you to:

  • Reference workflow data

  • Combine multiple values

  • Create dynamic values

  • Build custom input logic

Map every required input before publishing. Match the service’s input types and place the action after the workflow fields or previous results it needs are available.


Configure Output Variables

Output variables store the values returned by the Custom Service.

The output variables are defined in the selected Custom Service.

Output variables showing the numeric Added Number output mapped to a workflow variable.

Map each needed service output to a compatible workflow variable before publishing. For example, map the Excel service’s numeric Added Number output to a Number variable, then use it in a later step.

Output values can be used for:

  • Updating Data Lists

  • Conditions

  • Notifications

  • Other workflow actions


Workflow Execution

When the workflow reaches the Invoke custom service action:

  1. The workflow passes the configured input values to the Custom Service.

  2. The Custom Service executes the defined logic.

  3. The service returns output values.

  4. After a successful call, the workflow can use the returned values in the mapped variables.

Place the action at the appropriate position in the workflow based on when the Custom Service needs to be executed.


Publish Workflow

After configuring the Invoke custom service action:

  1. Save the workflow.

  2. Run a sample workflow in a test application. Check that the service receives the intended inputs, returns the expected outputs, and affects only the intended test records. Try an invalid input to verify the intended failure handling.

  3. Publish the workflow.

The Custom Service will execute automatically when the workflow reaches this action.


Troubleshooting

The Custom Service is not available in the Service list

Check that:

  • The Custom Service has been published.

  • You have permission to access the service.

  • The service exists in the current application or has been shared with the application.


Input variables cannot be configured

Check that:

  • The selected Custom Service has the required input variables.

  • The workflow provides available values.

  • The value type matches the input variable type.


The workflow stops when invoking the Custom Service

Check that:

  • Required input values are provided.

  • Test the service in TEST RUN with equivalent inputs, then verify the workflow’s input mapping and required connections. If the service writes records, check the target before retrying.

  • The service logic returns the expected output.


Output variables are empty

Check that:

  • The Custom Service returns output values.

  • Output variables are mapped correctly.

  • The service execution completed successfully.


Related Articles

Did this answer your question?