↓ Hoppa till huvudinnehållet
  1. Dokumentation/

Installationsguide

1. Installera PocketHook
#

Ladda ner PocketHook från App Store och öppna den på din iPhone, iPad eller Mac.

2. Konfigurera Din Server
#

PocketHook behöver en HTTPS-slutpunkt för att kommunicera. Du kan använda:

  • Agent Server — Självhostad AI-agent med LLM, verktyg, bakgrundsuppgifter och minne
  • Ditt eget API — Vilken server som helst som accepterar POST-förfrågningar och returnerar JSON
  • n8n — Självhostad arbetsflödesautomatisering med webhook-utlösare
  • OpenClaw — Självhostad AI-assistent med flerkanalsmeddelanden

Serverkrav
#

Din server måste:

  • Acceptera POST-förfrågningar med JSON-kropp
  • Returnera JSON-svar
  • Vara tillgänglig via HTTPS (HTTP avvisas av säkerhetsskäl)
  • Valfritt stödja Bearer token-autentisering

3. Anslut i PocketHook
#

  1. Öppna PocketHook och gå till Inställningar
  2. Ange din Server-URL (måste vara HTTPS)
  3. Ange ditt Autentiseringstoken (om din server kräver autentisering)
  4. Tryck på Testa Anslutning för att verifiera

PocketHook Inställningsskärmen

4. Förfrågansformat
#

PocketHook skickar meddelanden som en JSON-array:

[{
  "sessionId": "uuid-v4",
  "action": "sendMessage",
  "chatInput": "ditt meddelande har"
}]

5. Svarsformat
#

Din server bör svara med ett JSON-objekt:

{
  "msg": "Meddelande visat for anvandaren",
  "shortcut": "ValfrittGenvagensNamn",
  "data": { "nyckel": "varde" },
  "url": "https://optional-url.com"
}
FältTypObligatorisktBeskrivning
msgstringJaText som visas i chatten
shortcutstringNejiOS Shortcut att köra
dataobject | arrayNejData som skickas till Shortcut
urlstringNejURL att öppna eller visa

För flerstegsautomatiseringar, returnera en array med svar:

[
  { "msg": "Steg 1...", "shortcut": "ForstaGenvagen" },
  { "msg": "Steg 2...", "shortcut": "AndraGenvagen", "data": { "input": "varde" } }
]

6. Snabbstart med Starter-servern
#

Använd vår starter server-mall för att komma igång på några minuter:

git clone https://github.com/pockethook-app/pockethook-server.git
cd pockethook-server
bun install
cp .env.example .env
# Redigera .env med ditt hemliga token
bun dev

Starter-servern inkluderar inbyggda kommandon (ping, hello, help, time) och exempel på att utlösa Shortcuts. Se API-referensen för den fullständiga protokollspecifikationen.

7. Använda SDK
#

Installera pockethook-sdk-paketet för att bygga typsäkra svar:

bun add pockethook-sdk
import { text, shortcut, responses, toResponse } from "pockethook-sdk";

// Enkelt textsvar
return toResponse(text("Hej fran min server!"));

// Utlos en Shortcut
return toResponse(shortcut("Kor...", "MinGenvag", { nyckel: "varde" }));

// Flerstegsautomatisering
return toResponse(responses([
  { msg: "Steg 1", shortcut: "Forsta" },
  { msg: "Steg 2", shortcut: "Andra" }
]));