Zum Hauptinhalt springen
  1. Dokumentation/

Einrichtungsanleitung

1. PocketHook installieren
#

Lade PocketHook aus dem App Store herunter und oeffne es auf deinem iPhone, iPad oder Mac.

2. Deinen Server konfigurieren
#

PocketHook benoetigt einen HTTPS-Endpoint zur Kommunikation. Du kannst verwenden:

  • Agent Server — Selbstgehosteter AI-Agent mit LLM, Tools, Hintergrundaufgaben und Speicher
  • Deine eigene API — Jeder Server, der POST-Anfragen akzeptiert und JSON zurueckgibt
  • n8n — Selbstgehostete Workflow-Automatisierung mit Webhook-Trigger
  • OpenClaw — Selbstgehosteter AI-Assistent mit Mehrkanal-Messaging

Serveranforderungen
#

Dein Server muss:

  • POST-Anfragen mit JSON-Body akzeptieren
  • JSON-Antworten zurueckgeben
  • Ueber HTTPS erreichbar sein (HTTP wird aus Sicherheitsgruenden abgelehnt)
  • Optional Bearer-Token-Authentifizierung unterstuetzen

3. In PocketHook verbinden
#

  1. Oeffne PocketHook und gehe zu Einstellungen
  2. Gib deine Server-URL ein (muss HTTPS sein)
  3. Gib dein Auth-Token ein (falls dein Server Authentifizierung erfordert)
  4. Tippe auf Verbindung testen zur Ueberpruefung

PocketHook Einstellungsbildschirm

4. Anfrageformat
#

PocketHook sendet Nachrichten als JSON-Array:

[{
  "sessionId": "uuid-v4",
  "action": "sendMessage",
  "chatInput": "deine Nachricht hier"
}]

5. Antwortformat
#

Dein Server sollte mit einem JSON-Objekt antworten:

{
  "msg": "Nachricht fuer den Benutzer",
  "shortcut": "OptionalerKurzbefehlName",
  "data": { "schluessel": "wert" },
  "url": "https://optional-url.com"
}
FeldTypErforderlichBeschreibung
msgstringJaIm Chat angezeigter Text
shortcutstringNeinAuszufuehrender iOS Shortcut
dataobject | arrayNeinAn den Shortcut uebergebene Daten
urlstringNeinURL zum Oeffnen oder Anzeigen

Fuer mehrstufige Automatisierungen gib ein Array von Antworten zurueck:

[
  { "msg": "Schritt 1...", "shortcut": "ErsterKurzbefehl" },
  { "msg": "Schritt 2...", "shortcut": "ZweiterKurzbefehl", "data": { "input": "wert" } }
]

6. Schnellstart mit dem Starter-Server
#

Verwende unsere Starter-Server-Vorlage, um in Minuten loszulegen:

git clone https://github.com/pockethook-app/pockethook-server.git
cd pockethook-server
bun install
cp .env.example .env
# Bearbeite .env mit deinem geheimen Token
bun dev

Der Starter enthaelt integrierte Befehle (ping, hello, help, time) und Beispiele zum Ausloesen von Shortcuts. Siehe die API-Referenz fuer die vollstaendige Protokollspezifikation.

7. Das SDK verwenden
#

Installiere das pockethook-sdk-Paket, um typsichere Antworten zu erstellen:

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

// Einfache Textantwort
return toResponse(text("Hallo von meinem Server!"));

// Einen Shortcut ausloesen
return toResponse(shortcut("Ausfuehrung...", "MeinKurzbefehl", { schluessel: "wert" }));

// Mehrstufige Automatisierung
return toResponse(responses([
  { msg: "Schritt 1", shortcut: "Erster" },
  { msg: "Schritt 2", shortcut: "Zweiter" }
]));