POST
/
v2
/
notify
/
{eventId}
curl -X POST https://qstash.upstash.io/v2/notify/myEvent \
  -H "Authorization: Bearer <token>" \
  -d "Hello World!"
[
  {
    "waiter": {
      "url": "https://my-workflow.com/path",
      "headers": {
        "Upstash-Workflow-Runid": [
          "wfr_melCHYvPkVhDqIhhk2"
        ],
        "Upstash-Workflow-Url": [
          "https://my-workflow.com/path"
        ]
      },
      "deadline": 1729869206
    },
    "messageId": "msg_26hZCxxbG2TT3AnHEr1w"
  }
]
Notify workflows waiting for an event to resume them. See our documentation to learn more.

Request

eventId
string
required
Event id to notify
body
string
Event data passed to the notified workflows

Response

The response contains a list of notified waiter objects and id of the message sent as a result of the notify request.
type NotifyResponse = { waiter: Waiter, messageId: string }[]
More information about the Waiter object:
Waiter
If there were no workflows waiting for the event, the result is an empty list.
curl -X POST https://qstash.upstash.io/v2/notify/myEvent \
  -H "Authorization: Bearer <token>" \
  -d "Hello World!"
[
  {
    "waiter": {
      "url": "https://my-workflow.com/path",
      "headers": {
        "Upstash-Workflow-Runid": [
          "wfr_melCHYvPkVhDqIhhk2"
        ],
        "Upstash-Workflow-Url": [
          "https://my-workflow.com/path"
        ]
      },
      "deadline": 1729869206
    },
    "messageId": "msg_26hZCxxbG2TT3AnHEr1w"
  }
]