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.

Workflow calls (with Upstash-Workflow-RunId header) are exempt from daily quota limits.

POST /v2/notify/{eventId}

Notify Event

cURL

curl --request POST \
  --url https://qstash.upstash.io/v2/notify/{eventId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

201

[
  {
    "waiter": {
      "url": "<string>",
      "headers": {},
      "deadline": 123,
      "timeoutBody": "aSDinaTvuI8gbWludGxpZnk=",
      "timeoutUrl": "<string>",
      "timeoutHeaders": {}
    },
    "messageId": "<string>",
    "deduplicated": true,
    "error": "<string>",
    "workflowRunId": "<string>",
    "workflowCreatedAt": 123
  }
]

Authorizations

bearerAuthbearerAuthQuery

Authorization · string · header · required

QStash authentication token

Path Parameters

eventId · string · required

The event ID that waiters are listening for.

Body

application/jsontext/plainapplication/octet-stream

The event data to send to all waiters. This will be the request payload for waiting workflow steps.

The body is of type object.

Response

201

application/json

Event notification sent successfully

waiter · object

The waiter that was notified.

Show child attributes

messageId · string

The ID of the notification message that was published.

deduplicated · boolean

Whether this notification was deduplicated.

error · string

Error message if the notification failed.

workflowRunId · string

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

workflowCreatedAt · integer<int64>

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