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.

1 min read

post/v2/notify/{eventId}

Request example

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

Response

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

post/v2/notify/{eventId}

Authorization

Authorizationstringheaderrequired#

QStash authentication token

1 alternative authorization method available — see the spec for details.

Path parameters

eventIdstringrequired#

The event ID that waiters are listening for.

Body

application/json · text/plain · application/octet-stream

bodyobject#

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

Responses

application/json

Event notification sent successfully

waiterobject#

Show child attributes

urlstring#

The URL that is waiting for the event notification.

headersobject#

The HTTP headers to send with the notification.

Show child attributes

{key}string[]#

deadlineinteger#

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

timeoutBodystring#

The body to send if the wait times out.

timeoutUrlstring#

The URL to call if the wait times out.

timeoutHeadersobject#

The HTTP headers to send with the timeout callback.

Show child attributes

{key}string[]#

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).

Rotate Signing Keys Notify Workflow Run Event