Skip to main content
POST
Probe a WebSocket trigger's connection

Authorizations

hookie_session
string
cookie
required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Headers

Idempotency-Key
string

Makes a POST safe to retry for 24 hours: the same key, credential, path and body returns the stored response (Idempotent-Replayed: true) instead of running again. 422 if the key was used for a different request; 409 while the first is in flight.

Required string length: 1 - 255

Path Parameters

project_id
string
required
ws_trigger_id
string
required

Response

Short-lived probe succeeded. The body is the WsListener DO's own result — ok is the only guaranteed field; the DO may include the first frames it saw.

ok
enum<boolean>
required
Available options:
true