client.getWaiters

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

Show child attributes

url · string · required

URL to call upon notify

deadline · number · required

Unix timestamp for when the wait will time out

headers · Record<string, string[]> · required

Headers sent in case of notify

timeoutUrl · string

URL to call upon timeout

timeoutBody · unknown

Body used in timeout request

timeoutHeaders · Record<string, string[]>

Headers sent in case of time out

Usage

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

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

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