REST API e webhooks
O 2Sync se conecta aos seus sistemas: CRM, site, chatbot, gerenciador de tarefas ou mensageiro. A REST API permite ler e alterar registros e ler a wiki, e os webhooks avisam o seu servidor sobre eventos no projeto.
Onde ficam as configurações
Abra a Caixa de feedback e clique em Configurações.
Vá para a aba Feedback e API. Os gerentes do projeto a veem.
O bloco API para o seu backend guarda o segredo do projeto. Clique em Mostrar para vê-lo. Mantenha o segredo só no servidor: no código de uma página qualquer pessoa consegue lê-lo. Se ele vazar, clique em Gerar um novo segredo; o antigo deixa de funcionar na hora.
REST API
Cada requisição envia o segredo no cabeçalho Authorization: Bearer <segredo>.
Requisição | O que faz |
|---|---|
| lista registros com filtros |
| um registro pela chave |
| cria um registro |
| altera um registro, por exemplo o status |
| páginas da wiki |
| bancos de dados e suas linhas |
| envia feedback para a caixa |
Status: NEW, BACKLOG, IN_PROGRESS, DONE. Tipos: TICKET (ideia), PROBLEM, TASK. Páginas privadas não ficam disponíveis pela API.
Exemplo: criar uma tarefa e designá-la a um colega.
curl -X POST https://2sync.ru/api/public/v1/items \
-H "Authorization: Bearer <segredo>" \
-H "Content-Type: application/json" \
-d '{"title":"Atualizar o banner","type":"TASK","assignee":"ana@example.com"}'Webhooks
Um webhook é um endereço no seu servidor para onde o 2Sync envia um POST com JSON quando algo acontece no projeto.
Informe o endereço no bloco Webhooks.
Marque os eventos necessários. Se não marcar nenhum, todos são enviados.
Clique em Adicionar webhook e depois em Testar para enviar um evento de teste.
Eventos: registro criado e alterado, comentário em registro, página criada e alterada, comentário em página, linha de banco de dados adicionada e alterada, novo feedback na caixa.
Cada requisição é assinada: o cabeçalho X-Bplan-Signature traz sha256=…, um HMAC do corpo da requisição com o segredo do webhook, e X-Bplan-Event traz o nome do evento. O botão Segredo mostra o segredo do webhook. Verifique a assinatura para aceitar requisições só do 2Sync. Páginas privadas nunca vão para os webhooks.
Abaixo do endereço do webhook aparece a última resposta do seu servidor. Desativar pausa o webhook.
Perguntas frequentes
Posso enviar feedback do meu próprio app?
Sim, com POST /api/public/v1/feedback. Campos opcionais: email, name, pageUrl e screenshot (imagem em base64). O feedback chega na caixa marcado como API.
Quantos webhooks posso adicionar?
Até 10 por projeto.