Sign in
Event Coordination

Wait for Event

Waits for a specific event to be signaled by another process, workflow, or session. This endpoint blocks until the event is signaled or the timeout is reached. Useful for coordinating between multiple browser sessions or workflows.

post/v1/events/{event_name}/wait

Path parameters

event_namestring required

The name of the event to wait for

Request body

timeoutMsinteger

Timeout in milliseconds to wait for the event. Defaults to 60000ms (1 minute).

Response

Event was signaled successfully

dataobject

The event data that was signaled

Example response

{
  "data": {
    "message": "Task completed",
    "result": "success",
    "timestamp": "2024-01-01T12:00:00Z"
  }
}

Changes

Changed in 1 of the 33 revisions of this API.1