List Waiters

List all active waiters for a specific event ID.

Returns information about all workflow runs that are currently waiting for the specified event.

GET /v2/waiters/{eventId}

List Waiters

cURL

curl --request GET \
  --url https://qstash.upstash.io/v2/waiters/{eventId} \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "url": "<string>",
    "headers": {},
    "deadline": 123,
    "timeoutBody": "aSDinaTvuI8gbWludGxpZnk=",
    "timeoutUrl": "<string>",
    "timeoutHeaders": {}
  }
]

Authorizations

bearerAuthbearerAuthQuery

Authorization · string · header · required

QStash authentication token

Path Parameters

eventId · string · required

The event ID to list waiters for.

Response

200

application/json

List of active waiters

url · string

The URL that is waiting for the event notification.

headers · object

The HTTP headers to send with the notification.

Show child attributes

deadline · integer<int64>

The Unix timestamp in seconds when the wait operation times out.

timeoutBody · string<byte>

The body to send if the wait times out.

timeoutUrl · string

The URL to call if the wait times out.

timeoutHeaders · object

The HTTP headers to send with the timeout callback.

Show child attributes