1. Instalar o PocketHook#
Descarregue o PocketHook da App Store e abra-o no seu iPhone, iPad ou Mac.
2. Configure o Seu Servidor#
O PocketHook necessita de um endpoint HTTPS para comunicar. Pode utilizar:
- Servidor Agent — Agente de IA auto-alojado com LLM, ferramentas, tarefas em segundo plano e memoria
- A sua propria API — Qualquer servidor que aceite pedidos POST e devolva JSON
- n8n — Automatizacao de fluxos de trabalho auto-alojada com acionador webhook
- OpenClaw — Assistente de IA auto-alojado com mensagens multicanal
Requisitos do Servidor#
O seu servidor deve:
- Aceitar pedidos POST com corpo JSON
- Devolver respostas JSON
- Ser acessivel via HTTPS (HTTP e rejeitado por seguranca)
- Opcionalmente suportar autenticacao Bearer token
3. Ligar no PocketHook#
- Abra o PocketHook e va a Definicoes
- Introduza o seu URL do Servidor (deve ser HTTPS)
- Introduza o seu Token de Autenticacao (se o seu servidor exigir autenticacao)
- Toque em Testar Ligacao para verificar
4. Formato do Pedido#
O PocketHook envia mensagens como um array JSON:
[{
"sessionId": "uuid-v4",
"action": "sendMessage",
"chatInput": "a sua mensagem aqui"
}]
5. Formato da Resposta#
O seu servidor deve responder com um objeto JSON:
{
"msg": "Mensagem apresentada ao utilizador",
"shortcut": "NomeDoAtalhoOpcional",
"data": { "chave": "valor" },
"url": "https://optional-url.com"
}
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
msg | string | Sim | Texto apresentado no chat |
shortcut | string | Nao | Atalho iOS a executar |
data | object | array | Nao | Dados passados ao Atalho |
url | string | Nao | URL para abrir ou apresentar |
Para automatizacoes com multiplos passos, devolva um array de respostas:
[
{ "msg": "Passo 1...", "shortcut": "PrimeiroAtalho" },
{ "msg": "Passo 2...", "shortcut": "SegundoAtalho", "data": { "input": "valor" } }
]
6. Inicio Rapido com o Servidor Starter#
Utilize o nosso modelo de servidor starter para comecar em minutos:
git clone https://github.com/pockethook-app/pockethook-server.git
cd pockethook-server
bun install
cp .env.example .env
# Edite .env com o seu token secreto
bun dev
O starter inclui comandos integrados (ping, hello, help, time) e exemplos para acionar Atalhos. Consulte a Referencia da API para a especificacao completa do protocolo.
7. Utilizar o SDK#
Instale o pacote pockethook-sdk para construir respostas type-safe:
bun add pockethook-sdk
import { text, shortcut, responses, toResponse } from "pockethook-sdk";
// Resposta de texto simples
return toResponse(text("Ola do meu servidor!"));
// Acionar um Atalho
return toResponse(shortcut("A executar...", "MeuAtalho", { chave: "valor" }));
// Automatizacao com multiplos passos
return toResponse(responses([
{ msg: "Passo 1", shortcut: "Primeiro" },
{ msg: "Passo 2", shortcut: "Segundo" }
]));