Notify

Notify Event

Notify an event to all waiters listening for that event ID.

This endpoint broadcasts an event to all active waiters that are waiting for the specified event. Each waiting workflow step receives the event data and continues execution.

Important: This is an "unsafe notify" operation - if there are no active waiters when the notification is sent, the event is lost and will not be delivered later. For guaranteed delivery within a specific workflow run, use the /v2/notify/{workflowRunId}/{eventId} endpoint instead.

post/v2/notify/{eventId}

Request

Base URL
https://qstash-eu-central-1.upstash.io
Auth
- HTTP bearer
- or API key in query parameter qstash_token
TypeScript
https://skmtc.dev/upstash/apis/upstash-workflow-rest-api/docs/v2/notify/:eventId/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

eventIdstring required

The event ID that waiters are listening for.

Request body

object required

Response

Event notification sent successfully

messageIdstring

The ID of the notification message that was published.

deduplicatedboolean

Whether this notification was deduplicated.

errorstring

Error message if the notification failed.

workflowRunIdstring

The workflow run ID if the notification was sent within a workflow.

workflowCreatedAtinteger

The timestamp when the workflow run was created (Unix timestamp in milliseconds).

Changes

No recorded changes to this operation across all 12 revisions of this API.