Loading

Documentation

Guides and references to get your first workflow running in minutes.

Getting started

Ship your first workflow in ten minutes

This guide walks you through installing the SaaSyTech CLI, signing in and running a workflow that posts a daily summary to your team.

Overview

A workflow is a sequence of steps that starts with a trigger, such as a schedule or an incoming event, and ends with an action. You can build workflows in the visual editor or describe them as code, and both stay in sync.

You will need Node.js 18 or later and a SaaSyTech workspace. If you do not have one yet, start a free trial.

Install the CLI

Install the package globally with your package manager of choice, then confirm that it is on your path.

terminal
$ npm install -g @saasytech/cli$ saasy --versionsaasy 2.4.0
  1. Check your Node version. Run node --version and make sure it prints 18 or higher.
  2. Install the package. Use the command above. Prefer not to install globally? Run it with npx @saasytech/cli.
  3. Verify. saasy --version should print the installed version.

Authenticate

Sign in from your terminal. A browser window opens so you can approve the session, and the CLI stores a short-lived token on your machine.

terminal
$ saasy loginOpening browser to confirm…✔ Signed in as ana@northwind.dev (workspace: northwind)

For CI pipelines, create an API key in Settings, then Developers and expose it as an environment variable.

terminal
export SAASY_API_KEY="sk_live_••••••••"saasy whoami

Your first workflow

Create a file named daily-summary.yml. It runs every weekday at 9:00, asks the assistant for yesterday’s highlights and posts them to a channel.

Define the trigger

daily-summary.yml
name: daily-summaryon: schedule: "0 9 * * 1-5"steps: - id: highlights uses: assistant.summarize with: source: dashboards/revenue period: yesterday - id: notify uses: chat.post with: channel: "#ops-alerts" text: "${{{{ steps.highlights.output }}}}"

Run and test

Do a dry run first. It executes every step but skips actions that change data, so you can check the output safely.

terminal
$ saasy run daily-summary --dry-run✔ highlights 1.2s✔ notify skipped (dry run)
  1. Review the output. Check the summary text printed by the highlights step.
  2. Publish. Run saasy deploy daily-summary to turn on the schedule.
  3. Watch the first run. Open the run history in the dashboard to follow it live.

Triggers and schedules

Besides schedules, workflows can start from webhooks, incoming messages or changes in a connected app. A single workflow can have several triggers, and each run records which one fired.

Browse the integration directory to see which apps can act as triggers.

Deploy and monitor

Every deploy creates a new immutable version, so you can roll back with one command. Failed runs retry automatically with backoff, and you can subscribe a channel to failures from the dashboard.

Next steps

You now have a live workflow. Connect more tools from the integrations page, or check what changed recently in the CLI and API.