Skip to main content

Getting started with Claway

Claway is Blockway's AI agent for teams. Your agent answers in WhatsApp, Telegram, Slack, Teams and other chat apps, in the Claway App, and over HTTP for tools such as n8n. You manage it from the OPS dashboard.

There are two ways to run Claway. Everything else in these docs works the same on both; only the address you use differs.

Claway BoxHosted Claway
What it isAn appliance on your own networkA server Blockway runs for you
OPS dashboardhttps://<box>/ (self-signed certificate)http://<server-ip>:8443/
Webhookshttps://<box>/webhooks/agenthttp://<server-ip>:8443/webhooks/agent
OpenAI-compatible APIhttps://<box>/v1http://<server-ip>:8443/v1
Agent home on the machine/opt/claway/opt/claway

<box> is the Box's IP address or its .local name; <server-ip> is the address Blockway gave you for your hosted server. These docs never show real addresses.

1. Sign in to OPS​

On a Claway Box​

  1. Plug the Box into your network and power it on. With a screen attached, the Box shows its address and a QR code.
  2. Open https://<box>/ from a computer on the same network. Your browser warns about the certificate: the Box uses a self-signed certificate, so accept it for this address.
  3. The first time, the Box asks you to activate it. Enter:
    • the 8-character activation code shown on the Box screen,
    • your licence (CLAW-...), from Blockway,
    • an operator password (at least 10 characters),
    • the admin mobile number (with country code) of the first person who may sign in to the Claway App.
  4. Scan the QR code it shows into an authenticator app (1Password, Google Authenticator, Authy, iOS Passwords). It is shown only once.

On hosted Claway​

Blockway sends you the OPS address, your operator password and an authenticator QR code. Scan the QR code into an authenticator app.

Every sign-in​

Sign in with the operator password and the current 6-digit code from your authenticator app. The operator guide walks through each OPS page.

2. Connect a chat app​

In OPS, open Connectors. Each row is one platform (WhatsApp, Telegram, Slack, Microsoft Teams, Email, ...) with its live status, a Setup wizard for the first connection and Manage for later changes.

Then set up how the agent behaves in each chat in Personas (persona guide) and give it your documents in KB (knowledge base guide).

3. Invite people to the Claway App​

The Claway App (iOS, Android, desktop and web) gives each employee a private chat with the agent. Sign-in is by mobile number plus a one-time code, and only numbers on your roster can sign in. Add people in OPS → Users. See Claway App.

4. Connect n8n, Zapier or your own software​

Two connectors in OPS → Connectors open Claway to other software. Both require a secret of at least 16 random characters and check it on every call.

  • Webhook: POST .../webhooks/agent with a message, get the agent's answer back, synchronously or through a callback URL. Best for n8n's HTTP Request node, Zapier and Make. See Webhooks.
  • API server: an OpenAI-compatible API at .../v1. Best for n8n's OpenAI Chat Model and AI Agent nodes, Open WebUI, and any OpenAI SDK. See API server.

5. Keep it up to date​

OPS → System shows the installed version and, when a newer one is available, an Update now button.

Getting help​

Email support@claway.io. Before you do, the escalation guide lists what to check and what to send.

Where to go next​

  • Operator guide: running Claway for a team.
  • End-user cheat sheet: one page to hand to the people who chat with the agent.
  • Features: what the agent can do: tools, skills, memory, scheduled jobs and more.
  • Using the claway CLI: for administrators with shell access to the Box or server. There the agent's home is /opt/claway, not ~/.claway as on a personal install.