client.getWaiters - Upstash Documentation

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#

eventIdstringrequired#

The identifier of the event to look up.

Response#

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

Waiterobject#

Show properties

urlstringrequired#

URL to call upon notify

deadlinenumberrequired#

Unix timestamp for when the wait will time out

headersRecord<string, string[]>required#

Headers sent in case of notify

timeoutUrlstring#

URL to call upon timeout

timeoutBodyunknown#

Body used in timeout request

timeoutHeadersRecord<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",});