Introduction

Getting started

Walkthrough Guides

CafeX Apps

App Studio

App Studio Components

Data Sets

Workflows

Using CafeX Collaborate App

Reporting

Managing CafeX

Integrating CafeX

Security

How-tos

Workflows

Using a Workflow to Connect to External Systems

Modified on Mon, 1 Sep at 7:20 AM

Workflows can be used to make REST calls and exchange data with third-party systems. This allows you to extend the capabilities of your project beyond the CafeX App and integrate external services directly into your workflows.

 

Making an HTTP Request

A workflow can be configured to perform an HTTP request to an external REST endpoint and return results back to the CafeX App. For example, it can:

  1. Accept a User ID input from the CafeX App.
  2. Perform an HTTP request to a REST endpoint using that User ID.
  3. Receive a response containing user details.
  4. Extract and return the user’s name back to the CafeX App.

 

Example Workflow Steps

A typical workflow that interacts with an external REST endpoint includes these steps:

  1. Workflow Invoked – The workflow is triggered from the CafeX App with necessary input.
  2. Send HTTP Request – The workflow sends a request to the external REST endpoint using the provided input.
  3. Return Response – The workflow receives the response from the endpoint, extracts the required data, and returns it to the CafeX App.

This sequence illustrates the basic process of sending and receiving data through a workflow.


Note: To invoke a workflow from App Studio, you should create a data set than links the App to the workflow. For details, see Configuring Data Sets > Workflow.


Though the same result may sometimes be achievable using a data source, the benefit of workflows is in calling third-party systems using built-in connectors. Connectors simplify integration by hiding technical API details and exposing user-friendly actions such as "Find Document" or "Create Message". This means users don't need to look up the details of the API, which simplifies configuration.


Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article