# Webhook relay for `ohauthcat listen` (sandbox only)

<div class="api-op" data-api-operation>
<div class="api-op__main">

<p class="api-endpoint"><span class="method method-get">GET</span> <code>/v1/dev/relay</code></p>

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.

<dl class="api-facts"><div><dt>Scope</dt><dd><code>webhooks:read</code></dd></div><div><dt>Auth</dt><dd>Secret key (<code>sk_…</code>)</dd></div><div><dt>Since</dt><dd>1.0</dd></div></dl>

## Headers

<ul class="api-fields">
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">OhAuthCat-Version</code> <span class="api-field__type">string</span></p>
Minor version; defaults to the environment's pin.
</li>
</ul>

## Responses

<ul class="api-responses">
<li class="api-response"><span class="api-status api-status--neutral">101</span> <span>Switching Protocols (WebSocket)</span></li>
<li class="api-response"><span class="api-status api-status--bad">400</span> <span>Invalid request. Codes: <a href="/errors/parameter_invalid/">parameter_invalid</a>, <a href="/errors/parameter_missing/">parameter_missing</a>, <a href="/errors/version_unsupported/">version_unsupported</a> and resource-specific codes from the catalogue. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">401</span> <span>Codes: <a href="/errors/authentication_required/">authentication_required</a>, <a href="/errors/api_key_invalid/">api_key_invalid</a>. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">403</span> <span>Codes: <a href="/errors/api_key_scope_missing/">api_key_scope_missing</a>, <a href="/errors/ip_not_allowed/">ip_not_allowed</a>, <a href="/errors/plan_limit_reached/">plan_limit_reached</a>. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">429</span> <span>Code: <a href="/errors/rate_limited/">rate_limited</a>. Retry-After is set. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">503</span> <span>Code: <a href="/errors/service_unavailable/">service_unavailable</a>. Retry-After is set; writes are paused. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--neutral">default</span> <span>Any other error, including <a href="/errors/internal_error/">internal_error</a>. Every code is in the error catalogue. <span class="api-field__type">Error</span></span></li>
</ul>

Errors share one shape; see the [error code catalogue](/errors/).

</div>
<div class="api-op__code">

**curl**

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

**Node**

```javascript wrap
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();
```

**Python**

```python wrap
import os
import requests

response = requests.get(
    "https://api.ohauthcat.com/v1/dev/relay",
    headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},
)
data = response.json()
```

</div>
</div>
