How to call a Temporal endpoint

With a Temporal integration set up in FlowEQ, you can use the Temporal: Call Endpoint step to trigger automated workflows in the background.

The Temporal: Call Endpoint step allows you to construct and send HTTP requests to your Temporal.io instances, bringing the results into your workflow. This step is highly flexible, enabling your team to interact with Temporal for various use cases, such as retrieving workflow details, initiating workflows, or interacting with any other exposed Temporal API endpoint.

Guides to Specific Fields 

Title

Endpoint Nickname

Endpoint Path

Enter Values (Optional)

HTTP Method

Title

The Title field appears at the top of Sidekick when your team reaches this step in the flow. We recommend giving this step a clear and concise title that explains its purpose and how it fits into the overall workflow.

Example

Get workflow status from Temporal

Endpoint Nickname

The Endpoint Nickname field allows you to assign a user-friendly label to the API endpoint you're calling. This nickname simplifies referencing the endpoint in variables throughout your FlowEQ workflow.

Using Nicknames and Dot Notation in Variables

Since Temporal variables rely on specific data structures returned by the API, they won’t appear in FlowEQ’s variable picklist within Flow Builder. You will need to manually construct these variables using dot notation to navigate through the API response and access the desired data.

Dot notation allows you to traverse the hierarchy of the API response, starting from the Temporal instance nickname, through the endpoint nickname, and down to the specific fields within the API response.

Example

Let’s say the endpoint nickname is getWorkflowDetails, and you want to create a variable to display the status of a workflow returned in the response.

To manually create this variable in FlowEQ, you would write it like this:

<%= temporal.teamWorkflows.getWorkflowDetails.status %>

Where:

• <%= and %> are the standard wrappers used for FlowEQ variables.
• temporal refers to Temporal variables.
• teamWorkflows is the instance nickname used to set up the Temporal integration.
• getWorkflowDetails is the endpoint nickname you entered earlier for the endpoint call.
• status is the specific field within the API response that you want to access.

By using this structure, you can directly access the specific data returned by the API, such as the status of a workflow, and incorporate it into your workflow.

Endpoint Path

This field is where you specify the API path you want to call. This path should match the structure of the Temporal API you are working with.

Fetch values automatically

You can also use variables in the path to dynamically, either by using the ➕ to access the variable picker on the far right of the Endpoint Path field, or from a team member directly in Sidekick with an input field (see Enter Values Manually below) to pass in new information, making it flexible based on the data already present in your workflow.

Example

/workflows/<%= zendesk_ticketId %>/<%= input_1 %>/run 

Enter Values Manually (Optional)

The Enter Values section allows you to add prompts for additional fields that will appear in Sidekick, enabling team members to provide any missing information needed to complete the API call. This is especially helpful if the team member has the information available from the customer on a phone call, but it isn't readily available in a ticket field or other option in the variable picker.

Use the label field to define that question for the team member to answer or the data you want them to add to the call. Then, place the cursor in the Endpoint Path field where you want their entered data to appear in the call, then click the green Insert Placeholder button. You can configure multiple fields for an agent to insert, and you can reorder the prompts by using the Order field.

HTTP Method

This field specifies the HTTP method for the request being made to the Temporal API. Currently, the only supported method is GET, meaning this step retrieves data from the Temporal API.