Skip to main content
POST
/
v1
/
events
/
{event_name}
/
wait
Wait for Event
curl --request POST \
  --url https://api.anchorbrowser.io/v1/events/{event_name}/wait \
  --header 'Content-Type: application/json' \
  --header 'anchor-api-key: <api-key>' \
  --data '{
  "timeoutMs": 123
}'
{
  "data": {
    "message": "Task completed",
    "result": "success",
    "timestamp": "2024-01-01T12:00:00Z"
  }
}

Authorizations

​
anchor-api-key
string
header
required

API key passed in the header

Path Parameters

​
event_name
string
required

The name of the event to wait for

Body

application/json
​
timeoutMs
integer

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

Response

Event was signaled successfully

​
data
object

The event data that was signaled

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