Webhook relay for `ohauthcat listen` (sandbox only)
GET /v1/dev/relay: Webhook relay for `ohauthcat listen` (sandbox only).
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":; every event is {"type": 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
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Responses
Section titled “Responses”- 101 Switching Protocols (WebSocket)
- 400 Invalid request. Codes: parameter_invalid, parameter_missing, version_unsupported and resource-specific codes from the catalogue. Error
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 429 Code: rate_limited. Retry-After is set. Error
- 503 Code: service_unavailable. Retry-After is set; writes are paused. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
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"const response = await fetch("https://api.ohauthcat.com/v1/dev/relay", { method: "GET", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, },});const data = await response.json();import osimport requests
response = requests.get( "https://api.ohauthcat.com/v1/dev/relay", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},)data = response.json()