Skip to main content

Go Workflow SDK

Build stateful, long-running, reliable workflows using the Dapr Workflow Go SDK with Catalyst. The Dapr Workflow Go SDK provides a powerful way to orchestrate complex business processes using Go.

Resources​

Prerequisites:

Installation​

Install the Dapr Workflow SDK via go get:

go get github.com/dapr/go-sdk/client
go get github.com/dapr/go-sdk/workflow

Core Application​

Use the essential components of a Dapr Workflow application (Workflows and Activities) to build and run a workflow application.

Develop a Workflow Definition

Learn how to define workflows as functions that take a WorkflowContext

Develop an Activity Definition

Create activities that perform the actual work orchestrated by workflows

Dapr Client​

Connect to the Dapr Workflow API and start, get status, and manage workflow executions.

Workflow Client Usage

Learn how to create and configure the workflow client, including workflow and activity registration

Start a Workflow

Schedule new workflow instances via the Go SDK

Get Workflow Results

Retrieve workflow instance data such as the current status, input, custom status, and output

Failure Detection​

Explore how your application can detect failures using timeouts.

Workflow Timeouts

Each workflow timeout controls the maximum duration of a different aspect of a workflow execution

Activity Timeouts

Each activity timeout controls the maximum duration of a different aspect of an activity execution

External Events​

Wait for external input and send events to running workflows.

Wait for External Event

Wait for external input, such as human approvals or system responses

Raise Workflow Event

Send an event to a running workflow instance from a client or another workflow

Control Workflow Progression​

Interrupt a workflow execution with pause, resume, or terminate actions.

Pause a Workflow

Pause a running workflow instance

Resume a Workflow

Resume a paused workflow instance

Terminate a Workflow

Terminate a workflow execution and its activities

Advanced Features​

Durable Timers

Use timers to make a workflow execution pause or sleep for a fixed time period

Continue-As-New

Continue the workflow execution with a new workflow execution using the same workflow ID

Observability​

Configure and use observability features to monitor and debug workflows.

Workflow Visibility

Use the Catalyst workflow dashboard to view workflow executions, states, and success rates

Getting Started​

Workflow Quickstart

Get started with workflows in Catalyst

Workflow Patterns

Learn about common workflow patterns

Dapr Workflow Documentation

Comprehensive Dapr workflow guide