10 Minute Quickstart

Follow along with this guide to get your first Sym workflow up and running!

Overview

If you’re worried about how much time it will take to get your first Sym flow set up, don’t be. We’ve built an easy-install experience that gets your first flow provisioned in minutes, and your first users piloting Sym in hours.

This section walks you through setting up Sym and getting your first workflow up and running.

Prerequisites

To use Sym, you'll need: Terraform, Python 3, and a Sym Organization ID.

📘

You'll need a Sym Organization and Org ID

Go here to create your account and get started with Sym.

Steps

1. Install Sym in your Slack workspace

Sym's setup starts in Slack. If you haven't already, install the Sym app for your Slack workspace by clicking this link. After installing our app, you can run /sym, which will guide you through the rest of the process.

520

2. Install the symflow CLI to manage Sym

The symflow CLI is where you can log in, manage users and other resources, and make updates to your Terraform and Python configurations. For methods other than brew, please refer to this page.

~/Documents/sym/
> brew install symopsio/tap/symflow

~/Documents/sym/
> symflow login
...
Org ID: # enter your Sym Organization ID and then follow your browser to complete login!

3. Initialize Sym and generate your first Sym workflow

Sym provides a symflow init command which will create a new directory for your configuration with the environment and version files, and a symflow generate command which will generate the rest of the files required for your Flows. You'll need to provide your Slack workspace ID, which you can find by running /sym whoami in Slack.

For more information, see:

~/Documents/sym/
❯ symflow init
Welcome to Sym! This command will generate a new directory containing the Terraform files needed to start building your first Sym Flow.

What should we name the directory? example-flow
Slack Workspace ID (You can find this in Slack by running /sym whoami): T1234567
Environment Name This is where your Sym Flows will be deployed (e.g. prod, staging, sandbox) [prod]: prod

Successfully generated your Sym Terraform configuration! Run the following to add your first Flow:
cd example-flow  && symflow generate

~/Documents/sym/
❯ cd example-flow && symflow generate

Welcome to Sym! This command will generate new files required to configure a Sym Flow in the current directory.

If you don't see the Flow type you're looking for below, check out the docs here for a full list and how to configure them:
https://docs.symops.com/docs/integrations-overview

[?] Please select the type of Flow you would like to create: approval-only
 > approval-only
   aws-iam
   aws-lambda
   aws-sso
   okta

What would you like to name this Flow? This name should be unique:approval-flow
Generating a Sym Flow of type "approval-only" named "approval-flow"...

Successfully generated your Terraform configuration! Run the following to check the configuration:
terraform init && terraform plan

When you are ready to apply your configuration, run the following:
terraform apply

After everything is configured:
Run /sym in Slack
... to see your new Flow in action!

~/Documents/sym/example-flow
# etc.

4. Run your first Sym workflow in Slack

Once you apply your initial configuration, you can run /sym again from anywhere in Slack to see an example Flow in action.

📘

By default, Sym posts to #sym-requests. Please make sure it exists!

Blocked on Slack?

If you’re stuck waiting for approval to add Sym to Slack, you can always use the Sym web app or set us up in a test workspace and then come back later. It's really easy to point Sym to different Slack workspaces as needed.

Easy onboarding

Once you have your first Flow set up, the collaborative nature of Slack makes it easy to get new teams onboarded. Direct folks to start using our Slack App and have them learn by doing.