Skip to main content
The getWaiters method retrieves all waiters that are currently listening for a given event. A waiter represents a workflow run that is paused at a context.waitForEvent step and is waiting for the specified eventId.

​
Arguments

​
eventId
string
required
The identifier of the event to look up.

​
Response

Returns a list of Waiter objects describing workflows that are waiting on the given event.
​
Waiter
object

​
Usage

import { Client } from "@upstash/workflow";

const client = new Client({ token: "<QSTASH_TOKEN>" });

const result = await client.getWaiters({
  eventId: "my-event-id",
});
⌘I