Skip to content
Dashboard
Theme
Theme

Webhook relay for `ohauthcat listen` (sandbox only)

GET /v1/dev/relay: Webhook relay for `ohauthcat listen` (sandbox only).

View Markdown

GET /v1/dev/relay

A WebSocket (subprotocol ohauthcat.relay.v1) that streams the environment’s events, and the events sent with POST /v1/dev/trigger, as they happen. Sandbox environments only (sandbox_required). The first message is {"type":"hello","environment","secret":"whsec_…","heartbeat_seconds","max_session_seconds"}; every event is {"type":"event","id","event_type","test","body","signature"} where body is the raw webhook body and signature is its OhAuthCat-Signature value (ADR-008) under the relay secret, so the local app verifies it like a real delivery. The server pings every heartbeat_seconds, closes with 1001 when it shuts down and with 1000 after max_session_seconds; reconnect then. At most 5 open relays per environment on each API server (rate_limited, param relay). The relay only sends: a data message from the client closes it with 1008.

Scope
webhooks:read
Auth
Secret key (sk_…)
Since
1.0
  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

Errors share one shape; see the error code catalogue.

curl -X GET \
"https://api.ohauthcat.com/v1/dev/relay" \
-H "Authorization: Bearer $OHAUTHCAT_API_KEY"