SDK Overview

Use Python to create guardrails and routing logic for your Flows

Sym provides a comprehensive SDK that you can use to craft complex workflows-as-code that align perfectly with your business processes.

The Sym SDK has two main components:

  • Integrations that interact with third party services.
  • Workflow handlers that you can use to inject custom logic into your process.

The SDK's API-level documentation can be found at our SDK Docs.

Distribution

The Sym SDK is distributed as a Python 3 library on pip

$ pip install sym-sdk
Collecting sym-sdk
  Downloading sym_sdk-0.1.1-py3-none-any.whl (146 kB)
     |████████████████████████████████| 146 kB 6.4 MB/s
Installing collected packages: sym-sdk
Successfully installed sym-sdk-0.1.1

Integrations

The SDK exposes a set of integrations, which allow your workflow to connect to external services such as Slack and PagerDuty. Use integrations to check and manage memberships, send additional messages, or call out to external services. Check out the SDK docs for a full list of integrations. Tutorials for how to configure each SDK Integration are listed in the "Integrating Services" Category of our docs.

Workflow Handlers

Under the hood, each Sym Flow consists of a series of discrete steps that can be interrupted or redirected with custom logic wrapped in Handler functions. The two types of Handlers are reducers and hooks.

Reducers are prefixed with get_, and take in an Event and return a single value.
Hooks are prefixed with on_ or after_, and allow you to alter control flow inserting custom logic before or after an Event is processed.

📘

Handlers are defined in the sym.sdk.annotations module.


What’s Next