Circuits JavaScript SDK
Circuits is a Catalyst Serverless component, that enables you to orchestrate tasks and automate workflows in Catalyst. A circuit is essentially a JSON file that helps you systematically define and organize a sequence of tasks to be carried out automatically. You can code your business logic in Basic IO functions, and orchestrate their executions in simultaneously or concurrently.
The Circuits JavaScript SDK package enables you to execute the required Circuit through code.
-
Circuits is currently not available to Catalyst users accessing from the EU, AU, IN, JP, SA or CA data centers.
-
You will not be able to execute Job, Event, or Advanced I/O functions in a Catalyst circuit. This is because Catalyst supports the input and output of a circuit in the JSON format, that is supported by the Basic I/O functions alone.
Prerequisites
You will need to install the following package to be able to use the Circuits SDK methods.
Import Requirement
You will need to import the following modules to use the Circuits SDK methods.
const { Circuits } = require('@zcatalyst/circuits');List of SDK Methods
The following table contains the list of SDK methods that can be used to perform operations with the Circuits component through code.
| Category | SDK Method | Required Scope |
|---|---|---|
| General Operations | Get Circuit Instance | No requirement |
| Circuit Operations | Execute Circuits | Admin |
Last Updated 2026-07-02 14:51:41 +0530 IST
Yes
No
Thank you for your feedback!
Send your feedback to us