Notify Workflows

Resume workflows waiting for an event

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

Show child attributes

url

string

required

URL to call upon notify

deadline

number

required

Unix timestamp for when the wait will time out

headers

Record<string, string[]>

required

Headers sent in case of notify

timeoutUrl

string

URL to call upon timeout

timeoutBody

unknown

Body used in timeout request

timeoutHeaders

Record<string, string[]>

Headers sent in case of time out

If there were no workflows waiting for the event, the result is an empty list.