Skip to content
Workflows

Workflow Action - Custom Code

TABLE OF CONTENTS Overview Action Name Action Description Action Details Example Overview The Custom Code action allows you to extend your workflow’s…

2 min read353 words1 explained image
View as markdownOpen in ClaudeOpen in ChatGPT
Each image has a one line explanation. Switch to full detail for the step it belongs to, the fields and buttons involved, examples and the whole procedure.
On this page
  1. Overview
  2. Action Name
  3. Action Description
  4. Action Details
  5. How to Configure
  6. Example

TABLE OF CONTENTS

Overview

The Custom Code action allows you to extend your workflow’s functionality by writing and executing custom JavaScript and Python code. You can include properties from previous steps, perform operations, and return the output to be used in subsequent steps.

Action Name

Custom Code

Action Description

The Custom Code action enables the execution of JavaScript and Python code within a workflow, allowing users to extend the system’s functionality. This action can process data and return output that can be used in the workflow’s subsequent steps.

Action Details
Action Details (image 1 of 1) What this shows The Custom Code action enables the execution of JavaScript and Python code within a workflow, allowing users to extend the system’s functionality. What this shows Illustrates the "Action Details" section of "Workflow Action - Custom Code". This screenshot appears in the "Action Details" section of "Workflow Action - Custom Code". The text alongside this image reads: The Custom Code action enables the execution of JavaScript and Python code within a workflow, allowing users to extend the system’s functionality. This action can process data and return output that can be used in the workflow’s subsequent steps. Immediately after, the guide continues: Action Name: Give your custom code step a name that reflects its purpose. Language: By default, this is set to JavaScript but you can select Python too from the dropdown Property to Include in Code: Code. Image 1 of 1 What this coversThe Custom Code action enables the execution of JavaScript and Python code within a workflow, allowing users to extend the system’s functionality. This action can process data and return output that can be used in the workflow’s subsequent steps. Next stepAction Name: Give your custom code step a name that reflects its purpose. Language: By default, this is set to JavaScript but you can select Python too from the dropdown Property to Include in Code: Code:

How to Configure

  1. Action Name: Give your custom code step a name that reflects its purpose.
  2. Language: By default, this is set to JavaScript but you can select Python too from the dropdown
  3. Property to Include in Code:
    • Add key-value pairs where the key will be used in your code, and the value can either be hardcoded or dynamically mapped from previous workflow steps.
    • Use these key-value pairs within the code by referencing inputData.<key>. For example, if the key is number1, you can access it in the code as inputData.number1.
  4. Code:
    • Write JavaScript/Python code to process the values mapped in the previous step.
    • Ensure the output is in the form of a JavaScript/Python object or array of objects. Example: output = { result: sum }.
Field NameDescriptionMandatory
Action NameThe name of the action that will be displayed in the workflow.Yes
LanguageThe programming language used for the custom code (default is JavaScript).Yes
Property To Include In CodeFields to be used within the code, mapped from previous steps. Use inputData.keyName to access the values within the code.Yes
CodeJavaScript code to perform the desired operation. The output should be a JavaScript object.Yes

Example

javascript
Copy code
// This is wrapped in an async function const sum = inputData.number1 + inputData.number2; // Return the result as a JavaScript object output = { result: sum };

This example adds two numbers from the mapped properties number1 and number2 and outputs their sum.

Was this guide helpful?

Related guides