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

Guia de Configuração

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. Você pode usar:

  • Servidor Agent — Agente de IA auto-hospedado com LLM, ferramentas, tarefas em segundo plano e memória
  • Sua própria API — Qualquer servidor que aceite requisições POST e retorne JSON
  • n8n — Automação 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 requisições POST com corpo JSON
  • Retornar respostas JSON
  • Ser acessível via HTTPS (HTTP é rejeitado por segurança)
  • Opcionalmente suportar autenticação Bearer token

3. Conectar no PocketHook
#

  1. Abra o PocketHook e vá para Configurações
  2. Insira sua URL do Servidor (deve ser HTTPS)
  3. Insira seu Token de Autenticação (se seu servidor exigir autenticação)
  4. Toque em Testar Conexão para verificar

Tela de Configurações do PocketHook

4. Formato da Requisição
#

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 usuário",
  "shortcut": "NomeDoAtalhoOpcional",
  "data": { "chave": "valor" },
  "url": "https://optional-url.com"
}
CampoTipoObrigatórioDescrição
msgstringSimTexto exibido no chat
shortcutstringNãoAtalho iOS a ser executado
dataobject | arrayNãoDados passados ao Atalho
urlstringNãoURL para abrir ou exibir

Para automações com múltiplas etapas, retorne um array de respostas:

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

6. Início Rápido com o Servidor Starter
#

Use nosso template de servidor starter para começar 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 Referência da API para a especificação 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" }
]));