Skip to main content

Workflow.waitForEvent()

The .waitForEvent() method pauses execution until an event is received.

Usage example​

workflow.waitForEvent("event-name", step1);

Parameters​

eventName:

string
The name of the event to wait for

step:

Step
The step to resume after the event is received

Returns​

workflow:

Workflow
The workflow instance for method chaining

Extended usage example​

import { createWorkflow, createStep } from "@mastra/core/workflows";

const step1 = createStep({...});
const step2 = createStep({...});
const step3 = createStep({...});

export const testWorkflow = createWorkflow({...})
.then(step1)
.waitForEvent("event-name", step2)
.then(step3)
.commit();

On this page