> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rails.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Ping

A simple heartbeat mechanism to verify WebSocket connection health. This request is available even without any subscription.

<Note>
  Prefer this application-level `ping` message over WebSocket control frames when validating connectivity. Because it is handled as a normal data message, it confirms end-to-end reachability across the same path used by your subscriptions and requests. Control frames are processed separately by WebSocket infrastructure and can still succeed when application data is not flowing reliably.
</Note>

#### Request

```json theme={null}
{
  "message": "ping",
  "content": {
    "clientRequestId": "4cc68b60-ed2d-42aa-a21e-cb5486f8fd1a"
  }
}
```

| Field                     | Type   | Required | Description                           |
| ------------------------- | ------ | -------- | ------------------------------------- |
| `message`                 | string | Yes      | `ping`                                |
| `content.clientRequestId` | string | No       | Client-generated UUID for correlation |

#### Response

```json theme={null}
{
  "resultType": "pong",
  "data": {
    "clientRequestId": "4cc68b60-ed2d-42aa-a21e-cb5486f8fd1a",
    "statusCode": 200
  }
}
```

| Field                  | Type   | Required | Description                           |
| ---------------------- | ------ | -------- | ------------------------------------- |
| `resultType`           | string | Yes      | `pong`                                |
| `data.clientRequestId` | string | No       | Client-generated UUID for correlation |
| `data.statusCode`      | number | Yes      | `200`                                 |