Deploy, Execute, and Manage Custom Scripts for Tool Automation¶

The Agent Platform now allows admins to import, deploy, and manage custom scripts directly from the Settings console.

A powerful script deployment wizard enables users to easily upload, configure, and deploy custom scripts in isolated containers. By leveraging container isolation, this feature enhances security while providing flexibility in configuring runtime and scaling settings.

Once deployed, these scripts can be run via the API node’s endpoint when bulding the tool flow. Additionally, the custom scripts can be embedded in the Function node of the tool automation flow and executed when the node flow is run.

On the Manage Custom Scripts page, admins can upload a complete script project file, including all definitions and logic, without writing any code in the function node. This allows them to seamlessly port their code or project from a local system into the product and start using it immediately.

You can import a custom script with reusable functions and invoke it from anywhere within the platform using a secure API key at the endpoint. This adds flexibility and offers the following benefits to the tools' automation flow:

Task Automation – Automate repetitive or complex tasks that would otherwise require manual intervention.
Secure API Integration – Integrate custom scripts into the apps using API endpoints and secure authentication.
Customization – Implement custom logic or workflows tailored to unique business needs.
Data Processing – Transform, filter, or validate data in a way that aligns with specific operational requirements.
Error Handling – Create tailored error-checking and fallback mechanisms beyond standard system behavior.

You can import a script by uploading the file in one of the supported formats, validating it, configuring runtime settings and system resources, and deploying scripts after reviewing errors.

The key steps in managing custom scripts are:

Access Script Deployment Wizard¶

To access the custom scripts wizard, follow the steps below:

Log in to Agent Platform.
Access the Settings console and click Manage Custom Scripts on the left menu.

Import and Deploy a Custom Script¶

To import and add a custom script, follow the steps below:

Access the script deployment wizard.
Click + Import or + Import new.

Note

To complete the configuration, perform each step in order without skipping any.

Step 1: General Details¶

In the General Details window, follow these steps:

Add a Script name.
Add a Description to define the purpose and capabilities of your custom script.
Select Base Language (the language in which the script is imported and executed) and Language Version. The available options are JavaScript 20.19.0 and Python 3.10.15. More versions will be supported soon.

Note

The default version is auto-selected when you select the language.

To upload the script, click Choose File under Project File, then select the file from your local system.

Important Considerations

Supported file formats include .zip, .gz, and .tar.
The max file size is 1 GB. Larger files will result in a validation error.
Click Validate to check the file for errors.

Important

The uploaded file must match the recommended project structure. Click Download sample project to access the .zip folder of the script definitions and follow its structure when uploading your file.
The structure is different for different base languages. Ensure that the correct file structure is followed for the chosen language.
The file naming convention should be followed to avoid any errors.

Key Considerations for File Validations:

Validation checks confirm if the file matches the sample project structure.
Errors during validation are displayed via messages.
The list of validations includes the following:
- Adherence to the sample file’s structure and the allowed file format.
- The main file shouldn’t be empty
- 1 GB is the limit for the project file upload

If there are no errors, the system proceeds to the next page, Runtime Settings. If errors or warnings are present, you must resolve them before proceeding.

Custom Script Requirements and Guidelines

To ensure your custom script runs correctly within the platform, follow these guidelines:

Main Entry Point Required

Your project must include a main.py (for Python) or main.js (for JavaScript) at the root directory of the archive file. This file serves as the main entrypoint for the service. Only the functions defined in this file will be exposed for execution via API endpoints or tool integrations.

Support for Modular Code

You can organize your code across multiple files for better structure and maintainability. However, keep in mind that only functions in main.py/main.js will be exposed. Additional files can be used for helper functions or reusable logic, which can be imported into the main file.

Custom Dependencies (Optional)

If your code depends on specific packages, include a requirements.txt (for Python) or package.json (for JavaScript) file at the root directory in your project. These are optional, only include them if your code has external dependencies.

Use Relative Imports

When importing between files in your project, make sure to use relative imports. Refer to the provided sample files for examples.

Use of Environment Variables

Access environment variables in your scripts as follows:

Python:

import os

os.getenv('')

JavaScript:

process.env.<key_name>

Step 2: Runtime Settings¶

Configure Runtime variables (environment variables and execution timeout) to control how your script runs, stores configuration data, and stops executing. The key steps include:

Enter the Key and the Value to declare environment variables as key-value pairs that are accessible from your function.
(Optional) Click + Add to add additional key-value pairs, and the Delete icon to remove.

Note

The following default environment variables are available:

UPLOADS_DIR: Read-only access to all files uploaded via the Public APIs. Use this to access data that was submitted to your account.
WORKSPACE_DIR: Read-write directory for your function's file operations. Any data your function needs to store or modify will be saved here.
Both directories are accessible only while your container is deployed. Once undeployed, these storage locations will no longer be available.

Define the Execution timeout in seconds. The allowed range is 30 to 600 seconds.

Why Script Timeout?

Prevents resource overuse: Stops long-running or infinite-loop scripts from consuming excessive memory or CPU.
Ensures responsiveness: Keeps systems responsive by limiting how long a task can delay other operations.
Supports fail-safe mechanisms: If a script fails to complete in time, the timeout can trigger error handling or retries.

Click Next.

Step 3: Resource Allocation¶

On this page, you define scaling parameters (minimum and maximum replicas) and hardware requirements to ensure the script performs optimally under varying loads and to customize the deployment. The key steps include:

Set limits for auto-scaling to ensure optimal performance by defining the following Scaling parameters:

Min and Max Replicas: Defines the minimum and maximum number of pods per service that can be created for the service to handle increased load.

Note

The allowed range for both parameters is between 1 and 10.
The default value is 1.

Min replica should be lower than or equal to the Max Replica.
Average Compute Utilization: A metric based on which scaling of the service happens. Indicates average compute utilization in percentage per pod. The default value is 75, and the allowed range is between 1 and 100. This metric is disabled when Min replica and Max replica are the same.

Select the required hardware for the deployment. The unit is No. of vCPUs with memory. The profiles are virtualized for standardization. The available profiles are listed below:

Hardware configuration	Actual CPU Core and Memory Available	Credits per Hour
2 vCPUs with 8GB memory	1.5 vCPUs with 6.5GB memory	0.144
4 vCPUs with 16GB memory	3.5 vCPUs with 13.5GB memory	0.288
1 vCPU with 2GB memory	0.7 vCPUs with 1.1GB memory	0.07698
2 vCPUs with 4GB memory	1.5 vCPUs with 2.5GB memory	0.15396
4 vCPUs with 8GB memory	3.5 vCPUs with 6GB memory	0.30792

Click Next.

Step 4: Review the Provided Details¶

The next step is to review all the configuration details before deploying the script.

Review each section- General Details, Runtime Settings, and Resource Allocation to ensure all information is accurate. You can return to any section to modify the configured values if needed.
Read all the Terms and Conditions, and select Accept to enable deployment.
(Optional) Click Save as Draft to save a copy and deploy it later. A success message is displayed, and the label “Draft” is displayed for the script.
Click Deploy.

The following message is displayed when the script deployment progresses, and the status changes to “Deploying”.

Once the script is deployed successfully, the following message is displayed, and the status changes to “Deployed”.

Email Notification

After a custom script is deployed, a confirmation email with the subject line "Custom script deployed successfully - API Endpoint Available" is sent to the admin. The following information for the account is also displayed:

Credits remaining for the account
Total allocation

View Deployed Scripts and their Statuses¶

Once a script is deployed or saved as a draft, a table listing all scripts and their statuses becomes available on the Manage Custom Scripts page. This allows users to monitor deployment progress and take necessary actions as follows:

Search Script

Enter the script name in the search field to retrieve a matching entry from the list.

View Summary

The summary table displays the following fields:

Script Name: The name provided by the user.
Status: The current deployment status of the script.
Added by: The user who added the custom script.
Updated on: The timestamp when an action (deployment, re-deployment, or undeployment) was done on the script.
Action: Perform actions on the script like undeploy, delete, or export. Refer here for more information.

Information on Script Deployment Statuses¶

The following table illustrates the various statuses and the actions that can be performed from the Overview, Deployment History, Endpoint, and API Keys pages.

Status	Description	Actions you can perform
Status	Description	Overview	Deployment history	Endpoint	API keys	Re-deployment
Draft	The draft copy of the custom script that you can modify and deploy later.	Export Delete Deploy	Deploy Custom Script	Deploy Custom Script	Create a New API Key	No
Deploying	The script is being deployed. A success message is displayed once the deployment completes successfully. If the deployment fails, a failure message is shown.	Export Delete	Rename deployment version	Endpoint not activated	· Create API keys	No
Ready to Deploy	The script is set up and ready to deploy.	Export Delete Deploy	Rename deployment version	Endpoint not activated	· Create API keys	Yes
Deployed	The deployed custom script.	Redeploy Undeploy Export	View configuration and deployment details. Rename deployment version	Redeploy script View dedicated endpoint code (CURL, JS, and Python). Copy script code.	Create API keys Manage API keys	Yes
Deployment failed	The script deployment failed	Deploy Delete Export	View configuration and deployment details except duration. Rename deployment version.	The endpoint is not activated since the script is not deployed.	Create API keys	Yes

Key Considerations

Every time an action is taken for a script, the Updated on field captures the latest timestamp.
Hover over a "Deployment failed" status to view the error tooltip explaining the reason for failure.

Actions¶

In addition to deploy, the following actions can be performed on a custom script based on its deployment status.

Export¶

Downloads the .Zip folder of the project to the user’s local system. To export, follow the steps below on the Manage Custom Scripts page:

Click the Ellipses icon under Actions. Then, click Export.

Alternatively, click the deployed script entry and select Export on the Overview page.

To see when Export is available, please refer to the table here.

Note

You can view the status of the export while it is in progress, upon completion, or if it fails.
You can cancel an export in progress.

Undeploy the Script¶

This action lets you undeploy the script from all its deployed locations on the platform.

Key Considerations

An undeployed script can be redeployed. Learn more.
Once a script is redeployed, its data and configurations are restored. You can edit the script name and other parameters in the deployment flow.
The message “No custom scripts deployed yet” is displayed for the Function node if there are no deployed scripts.
A script does not appear in the Script dropdown list for the Function node if it is not deployed.

To undeploy, follow the steps below on the Manage Custom Scripts page:

Click the Ellipses icon under Actions. Then, click Undeploy.

You can also select a script entry and click Proceed to Undeploy on its Overview page.

Click Undeploy in the confirmation window.

A success message is displayed, and the script’s status changes to Ready to Deploy.

To see when undeploy is available, please refer to the table here.

Email Notification

After a custom script is undeployed, a confirmation email with the subject line "Your custom script has been undeployed successfully" is sent to the admin. The following information for the account is also displayed:

Credits remaining for the account
Total allocation

Delete Script¶

This action permanently deletes a deployed script, including its configurations and definitions, from the system.

Important

You cannot delete a deployed script.
Once a script is deleted, its data and configurations cannot be restored.

To delete, follow the steps below on the Manage Custom Scripts page:

Click the Ellipses icon under Actions. Then, click Delete.

Alternatively, select a script entry and click Proceed to Delete on its Overview page.

Click Delete in the confirmation window.

A success message is displayed, and the script is permanently removed.

To see when delete is available, please refer to the table here.

Redeploy Script¶

This action lets you redeploy a script by editing the description, project file, runtime settings, and resource allocation (except name, base language, and version number) in the Import Custom Script flow mentioned here. Redeploy is only available for the “Deployed” status.

To re-deploy, select the script with the “Deployed” status, and click Re-deploy in the Overview page.

The system redirects to the following page.

After redeployment, the Overview page is updated with the latest deployment information.

Script Overview¶

The configuration details of the latest deployed version of a script can be viewed on the Overview page. To view this page, click the required script on the Manage Custom Scripts page.

Note

You can view this page for all the statuses of a deployed script.

The information available on this page includes the configurations you have set for the following:

Script name and the assigned status
General Details
Runtime Settings
Resource Allocation

The actions you can perform on the script on the Overview page depend on the assigned status. See the table here for more details.

Refer here to import and deploy a custom script.

Deployment History¶

The Deployment History page helps view key information about the script’s previous and current deployments or undeployments. It helps track actions performed on the script, its version history, and deployment statuses.

Key Considerations

Deployment history information is only available for the statuses “Deployed,” “Deployment Failed,” “Deploying,” and “Ready to Deploy.”
For the “Draft” status, the following window is displayed.

Click Deploy custom script and follow the steps for import and deploy.

Information about un-deployment is displayed only when the status is 'Ready to Deploy', indicating that the script is currently undeployed.
Hover over a failed status to view the reason.

The following script deployment or un-deployment details are displayed:

Deployment name and version (the first version starts with v1). The version is auto-generated and appended to the script name. You can edit this name if required.
A green Check icon for the latest running deployment. This icon does not appear for failed deployments or undeployed scripts.
An Edit icon to edit the script name.

To edit the deployed/undeployed script’s name, click the Edit icon. In the following window, enter the new name and click Confirm.

Note

Please follow the suggested naming convention to avoid errors.

A success message is displayed, and the deployment name is changed.

Deployed on: The timestamp of the latest deployment/un-deployment.
Duration: The duration of the deployment. Shows “-” for all statuses except “Deployed.”
Deployed by: The system user who deployed/undeployed the version.

To view the detailed deployment/undeployment summary, click the Expand arrow.

The following information, configured by the user during the import and deploy or un-deploy step, is displayed:

Additionally, the following details are available:

Deployed by: Name of the user who deployed/undeployed the script.
Start Time: Date and time when the deployment or un-deployment started.
End Time: Date and time when the deployment or un-deployment ended.
Time Taken to Deploy: Total duration between the start and end times.
Status: Final status of the deployment/un-deployment (Success or Failed).

Statuses and Deployment Details¶

Deployment history information is displayed based on the status as follows:

Deployed

Deployment Failed

Ready to Deploy

Deploying

Endpoint¶

The Endpoint page displays code viewers of the activated endpoint for the deployed script in different formats. This allows users to easily copy the code in their preferred format and integrate it into their applications.

Note

The code is view-only and cannot be edited.

The available formats include:

cURL: Displays the API endpoint information for the script.
JavaScript: Displays the payload JSON code in JS format.
Python: Displays the payload JSON code in Python format.

Clicking Copy copies the selected endpoint format to the clipboard, allowing you to paste it into your applications or code editors. A success message confirms the copy action.

For the statuses 'Deploying,' 'Deployment Failed,' and 'Ready to Deploy,' the page displays the following message along with an option to deploy the script.

To deploy the script and activate the endpoint (obtain the code), click Deploy.

API Keys¶

Agent Platform provides secure access to deployed scripts through authenticated requests. You must create an API key to manage access to a deployed script’s endpoint across the platform.

Note

You can create API keys for a script regardless of its deployment status. The keys can be used once the script is successfully deployed.

Create an API Key¶

To add an API secret key, follow these steps:

Navigate to the API Keys page.
Click Create a New API Key or Create New Key.
Enter a unique name for the key. By default, “Secret Key” is displayed, which you can change.
Click Generate Key.

Click Copy and Close.

Important

Your secret API key is shown only once when generated. Save the key in a safe location. Do not share it or expose it in browsers or other client-side code.
If you lose a secret key, a new one must be generated.

A success message is displayed once the API key is generated. The added API Key is listed on the page.

Delete an API Key¶

To delete an API key, follow the steps below:

On the API Keys page, hover over the required key.
Click the Delete icon.
Click Delete in the confirmation window.

A success message is displayed, and the API key is removed from the list.

Note

A deleted API key becomes invalid and can no longer be used to access the script on the platform.

Search API Key¶

To look up a specific API key, type the name (partial or full) in the Search field.

Example: Use Custom Script via the API Node Endpoint¶

To add a deployed custom script via the endpoint into the API node, follow the steps below:

Click Define Request in the API node configuration window.
Enter or select the following details in the Edit Request dialog box:
- Select the request type from the list.
- Copy the cURL from the Endpoint section of the custom script wizard.
- Paste it in the text field of the Edit Request page.
- In the Auth Profiles section, select the required option from the list of configured profiles to enable user authentication for the node. Learn more about Auth Profiles.
If authentication is not required, select None (the default option).
- In the Headers tab, specify the Key and Value pair details. For example, Key: Content-Type Value: application/json.
- The Body tab is displayed for all request types except GET. Select the body content type from the drop-down list:
  - application/x-www-form-urlencoded: Allows file uploads through HTTP POST requests. Add key/value pairs encoded by the platform.
  - application/json: Transmits data between servers and web applications using JSON format without processing.
  - application/xml: Sends XML payload for SOAP services using POST methods, with the option to include node values.
  - Custom: Allows sending request payload in non-standard formats, such as for handling blogs or custom variables.
- Click the Test button at the top-right corner of the dialog. The API response is displayed on the Response tab.
- Click Save at the top-right corner of the dialog.
Please refer to the API node for more information.

Related Links¶
- Settings Console - Learn more about other Agent Platform admin features.
- API Node - Learn more about configuring the API node via endpoint.

Send Feedback

Deploy, Execute, and Manage Custom Scripts for Tool Automation¶

Access Script Deployment Wizard¶

Import and Deploy a Custom Script¶

Step 1: General Details¶

Step 2: Runtime Settings¶

Step 3: Resource Allocation¶

Step 4: Review the Provided Details¶

View Deployed Scripts and their Statuses¶

Information on Script Deployment Statuses¶

Actions¶

Export¶

Undeploy the Script¶

Delete Script¶

Redeploy Script¶

Script Overview¶

Deployment History¶

Statuses and Deployment Details¶

Endpoint¶

API Keys¶

Create an API Key¶

Delete an API Key¶

Search API Key¶

Example: Use Custom Script via the API Node Endpoint¶

Related Links¶