Catalytic for Developers

Welcome, developers

Catalytic speaks your language. Our developer tools allow you to code, customize and create more with our platform.

Get Started    

Workflows

A 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.

📘

Lean More About Workflows

In you're interested in learning more about what Workflows are or how they work on the Catalytic platform, see The Catalytic Help Docs Section on Workflows

The Workflows client allows you to access your Workflow definitions. These can then be used to start Instances. It provides the following methods:

MethodDescription
Get
GetAsync
Gets a specific Workflow by Id
Find
FindAsync
Search for Workflow by Name or Owner
Export
ExportAsync
Export an existing Workflow
Import
ImportAsync
Import a Workflow

🚧

Creating or Editing Workflows

Currently, the SDK does not support creating or editing Workflow definitions. Instead, you must create and edit your Workflows through the Catalytic Web App. Future versions of the SDK will support creating and editing Workflows.

📘

Starting a Workflow

To start an Instance of a Workflow, use the Start an Instance method.

Quickstart Example

/*
 * This example demonstrates getting Workflows by ID and by name
 */
using Catalytic.Sdk;
using Catalytic.Sdk.Entities;
using System;
using System.Linq;

namespace Catalytic.Sdk.Examples
{
    class Program
    {
        static void Main(string[] args)
        {
            var catalytic = new CatalyticClient(AccessToken.Default);
            var workflowById = catalytic.Workflows.Get("c9f2beec-10c0-4f2f-b4e0-1d884c7e053c");
            var workflowsByName = catalytic.Workflows.Find(Where.Text.Matches("SDK Examples")).Workflows;
            Console.WriteLine($"Found {workflowsByName.Count()} Workflows by name and 1 by Id");
        }
    }
}

Updated a day ago

Workflows


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.