Ir para o conteúdo principal
  1. Documentação/

Guia de Configuracao

1. Instalar o PocketHook
#

Baixe o PocketHook na App Store e abra-o no seu iPhone, iPad ou Mac.

2. Configure Seu Servidor
#

O PocketHook precisa de um endpoint HTTPS para se comunicar. Voce pode usar:

  • Servidor Agent — Agente de IA auto-hospedado com LLM, ferramentas, tarefas em segundo plano e memoria
  • Sua propria API — Qualquer servidor que aceite requisicoes POST e retorne JSON
  • n8n — Automacao de fluxos de trabalho auto-hospedada com gatilho webhook
  • OpenClaw — Assistente de IA auto-hospedado com mensagens multicanal

Requisitos do Servidor
#

Seu servidor deve:

  • Aceitar requisicoes POST com corpo JSON
  • Retornar respostas JSON
  • Ser acessivel via HTTPS (HTTP e rejeitado por seguranca)
  • Opcionalmente suportar autenticacao Bearer token

3. Conectar no PocketHook
#

  1. Abra o PocketHook e va para Configuracoes
  2. Insira sua URL do Servidor (deve ser HTTPS)
  3. Insira seu Token de Autenticacao (se seu servidor exigir autenticacao)
  4. Toque em Testar Conexao para verificar

Tela de Configuracoes do PocketHook

4. Formato da Requisicao
#

O PocketHook envia mensagens como um array JSON:

[{
  "sessionId": "uuid-v4",
  "action": "sendMessage",
  "chatInput": "sua mensagem aqui"
}]

5. Formato da Resposta
#

Seu servidor deve responder com um objeto JSON:

{
  "msg": "Mensagem exibida ao usuario",
  "shortcut": "NomeDoAtalhoOpcional",
  "data": { "chave": "valor" },
  "url": "https://optional-url.com"
}
CampoTipoObrigatorioDescricao
msgstringSimTexto exibido no chat
shortcutstringNaoAtalho iOS a ser executado
dataobject | arrayNaoDados passados ao Atalho
urlstringNaoURL para abrir ou exibir

Para automacoes com multiplas etapas, retorne um array de respostas:

[
  { "msg": "Etapa 1...", "shortcut": "PrimeiroAtalho" },
  { "msg": "Etapa 2...", "shortcut": "SegundoAtalho", "data": { "input": "valor" } }
]

6. Inicio Rapido com o Servidor Starter
#

Use nosso template 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 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. Usando 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("Executando...", "MeuAtalho", { chave: "valor" }));

// Automacao com multiplas etapas
return toResponse(responses([
  { msg: "Etapa 1", shortcut: "Primeiro" },
  { msg: "Etapa 2", shortcut: "Segundo" }
]));