Groner Bot · Gatilhos
Documentação para quem vai integrar
Uma página pronta com os endereços, os campos e as respostas de cada fluxo disparado por outro sistema, para entregar a quem vai fazer a integração.
Onde fica
Para que serve
Quem integra o seu site ou sistema precisa saber exatamente o que mandar e o que volta. A "Documentação da API" reúne todos os fluxos de Webhook num só lugar, com exemplo de chamada e botão para testar cada um.
Passo a passo
-
No menu lateral, clique em "Documentação da API".
-
Leia os quadros do topo, "Teste e produção", "Autenticação", "Corpo", "Limites" e "Resposta".
-
Clique num fluxo da lista para abrir o endereço, o corpo esperado, as respostas e o botão de teste.
-
Clique em "Baixar OpenAPI" para levar a documentação para a ferramenta de integração do seu time.
Campos e opções importantes
- Teste e produção
- Cada fluxo mostra os dois endereços. O de teste roda em simulação.
- Limites
- A página mostra quantas chamadas por segundo cada endereço aceita.
Dúvidas comuns
Posso mandar essa página para um fornecedor?
Sim, mas cuidado ao compartilhar a tela ou o arquivo com os endereços e tokens completos, porque eles dão acesso aos fluxos.
Por que meu fluxo não aparece na lista?
Só aparecem os fluxos criados com o gatilho Webhook.