Structure and Overview

SDK Structure

Service Clients and Methods

The functionality of the Catalytic platform is grouped into into several service clients that are exposed as properties of the main SDK Client. The available service clients are summarized in the following tables. Click on the Service Client or method name to see more details in the reference documentation.

NameMethodsDescription
accessTokensgetGets a specific Access Token by ID
findFetch all of your Access Tokens
createCreates a new Access Token with your email and password
Not supported for teams with SSO enabled
createWithWebApprovalFlowCreates a new Access Token to be approved via the Account page in
the Catalytic Web App
Supported for all teams with or without SSO
waitForApprovalWaits for an Access Token created with createWithWebApprovalFlow
to be approved in the Catalytic Web App
getApprovalUrlGets the URL that the user should be directed to to approve the
Access Token created with createWithWebApprovalFlow
openUrlA helper method for desktop apps to open the token approval URL
that works across Windows, OSX and Linux
revokeRevokes an Access Token so it can no longer be used
usersgetGets a specific User by id, email or username
findSearch for Users by name, or get all users.
workflowsgetGets a specific Workflow by id
findSearch for Workflow by name or owner
exportExport an existing Workflow
importImport a Workflow
instancesgetGets a specific Instance by id
findSearch for Instances by name or owner
startStart an Instance of a Workflow
stopStop an Instance
getInstanceStepGet an Instance Step by ID
getInstanceStepsFind Instance Steps
completeInstanceStepComplete a Step
reassignInstanceStepReassign an Instance Step
filesgetGets metadata of a File by id
findSearch for Files by name, workflowId or instanceId
downloadDownloads a File by id
getFileStreamGets a readable stream of a File by id
uploadUploads one or more new Files
dataTablesgetGets metadata of a Data Table by id
findSearch for Data Tables by name
downloadDownloads a File by id
getFileStreamGets a readable stream of a Data Table by id
uploadUploads a new Data Table
replaceReplaces an existing Data Table

πŸ“˜

Promises and Callbacks

All asynchronous client methods accept an optional callback as the final argument. If no callback is provided, a Promise will be returned.

Entities

Each Service Client provides operations over one or more Entity types. These Entities are documented in detail at the end of the Service Client section that manages them. The full set of Entities managed by the SDK is listed below for quick reference.

Service ClientEntityDescription
accessTokensAccessTokenAccess Tokens allow a developer to authenticate
SDK requests on behalf of a specific Catalytic User
usersUserRepresents a user that can log into your Catalytic team
workflowsWorkflowA Workflow is an automation you build on the Catalytic platform.
It is a template of the process you want to run each time your Workflow is started.
instancesInstanceWhen you start a Workflow, you create an Instance. That Instance
contains data stored in fields and tracks the status of your automation workflow.
Each Step in your Workflow becomes an Instance Step in your Instance.
InstanceStepEach step in a Workflow Instance represents a single action to be taken
in the course of running the instance
FieldFields hold the data in your Workflows and can be used to configure which
steps your Workflow Instance takes and which are skipped.
filesFileA File can be associated with a Field in a Workflow or an Instance, or with a cell in
a Data Table.