v4

OpenAPI 3.1.02026-08-0255174167.5 KB

events

Wait for an event

Long-polls until the next event of eventType arrives on the account (optionally matching filters/regexFilters), or until timeout seconds elapse. Useful for one-shot waits such as receiving an inbound SMS code. For a continuous stream, use Open an event stream instead.

post/api/v1/events/wait

Headers

Authorizationstring required

Your Dial API key, sent as Authorization: Bearer sk_live_...

Request body

eventTypestring required

Event type to wait for.

filtersobject

Exact-match on top-level event fields.

regexFiltersobject

Regex-match on top-level event fields.

timeoutinteger

Max seconds to wait.

Response

The matching event.