Digest Action Step

Workflow Interface

import { workflow } from '@novu/framework';

workflow(
  workflowId: string,
  handler: WorkflowHandler,
  options?: WorkflowOptions
): WorkflowInstance;

workflowId

number

required

This id should be unique within your organization.

handler

(context: WorkflowContext) => Promise<void>

required

The definition function of the workflow.

options

WorkflowOptions

An optional options object for workflow level configurations

Show properties

payloadSchema

JSON Schema | Zod

The schema to validate the event payload against, can be used to provide default values.

Workflow Context

This context is passed by the workflow engine to provide contextual information about current workflow execution.

subscriber

Subscriber

Show properties

subscriberId

string

required

The id of the subscriber, as passed during /events/trigger request.

firstName

string

Nullable, the first name of the subscriber.

lastName

string

Nullable, the last name of the subscriber.

payload

object

The payload of the event that triggered the workflow, will be validated against the payloadSchema if provided.

step

object

The object that contains all the step functions, read more at Step Functions.