Webhooks
Um webhook é uma notificação automatizada enviada pelo servidor do TARGPatrol para você sempre que um evento específico ocorre no sistema, como a criação, atualização ou conclusão de uma tarefa. Os webhooks são essenciais para otimizar processos, integrar-se com outros sistemas e responder a mudanças em tempo real. Quando um evento (por exemplo, a mudança de status de uma tarefa) ocorre no TARGPatrol, o sistema envia uma solicitação POST para uma URL pré-definida. Esta solicitação inclui um payload — um objeto JSON contendo detalhes do evento, como o ID da tarefa, o status e outros dados relevantes.
Como configurar webhooks no TARGPatrol
Para criar um webhook
Faça login no TARGPatrol.
Navegue até a"Gestão" -> "Webhooks"seção.
Adicione um novo webhook:
Clique noAdicionar Webhookbotão.
Digite a URL onde as notificações serão enviadas. Certifique-se de que seu servidor esteja pronto para lidar com solicitações POST e processar dados JSON.
Selecione os tipos de eventos que irão acionar o webhook. O TARGPatrol suporta vários gatilhos.
Opcional: Adicione cabeçalhos de solicitação: Se necessário, especifique cabeçalhos como Content-Type para personalizar o formato da solicitação.
Clique"Salvar"botão.
Teste o webhook:
Após salvar, o TARGPatrol permite que você teste o webhook simulando um evento.
Por exemplo, se seu webhook estiver configurado para disparar quando a tarefa.criada, você receberá uma notificação quando uma nova tarefa for criada.
Webhook TASK_STEP_COMPLETED
Selecione TASK_STEP_COMPLETED para enviar um webhook separado sempre que um passo da tarefa for concluído. No seletor de eventos, ele é exibido como "tarefa.passo concluído".
O payload contém a organização, a tarefa agendada e a história da tarefa, a execução da tarefa, a localização, o executante e o indicador de check-in on-demand. O objeto do passo pode incluir:
id, nome, ordem e ordem real: identificação do passo, ordem global e ordem de execução real.
pointId e pointHistoryId: referências de checkpoint quando o passo usa um ponto.
stepGroupId: a referência do grupo quando o passo pertence a um grupo de passos.
estado, status, iniciadoAt e terminadoAt: estado de execução, resultado e timestamps.
Campos opcionais são omitidos quando não aplicam. Seu endpoint deve identificar o evento pelo tipo TASK_STEP_COMPLETED e lidar com cada etapa concluída de forma independente.
Visualizar Logs de Webhook no TARGPatrol
Acesse os logs de webhook:
Abrir o“Webhooks”seção no TARGPatrol.
Clique no URL de webhook ou seu ícone para visualizar seus detalhes.
Uma janela exibirá uma lista de eventos acionados, incluindo seu status, payloads de solicitação e respostas do servidor.
Verifique erros: Se um webhook falhar, a solicitação correspondente será marcada com um ícone de erro nos logs. O TARGPatrol desativará automaticamente um webhook após 25 solicitações falhadas consecutivas.
Dicas para Gerenciar Webhooks
Trate erros com elegância:Webhooks operam em tempo real, mas se seu servidor não responder, o TARGPatrol reatribui a solicitação automaticamente.
Monitorar e analisar erros:Problemas recorrentes, como tempos de espera, podem indicar problemas de desempenho do servidor ou configurações de roteamento incorretas.
Fique informado:O TARGPatrol envia alertas de e-mail quando novos webhooks são criados, erros ocorrem ou um webhook é desativado automaticamente. Isso mantém você informado sobre a saúde da sua integração.
Use HTTPS para segurança:Os webhooks do TARGPatrol só suportam URLs HTTPS seguras para garantir a segurança dos dados.
Configurar webhooks no TARGPatrol permite que você automatize tarefas, integre com outros sistemas e gerencie dados em tempo real de forma eficaz. siga as dicas para gerenciar webhooks para evitar armadilhas comuns e garantir uma integração suave. Use HTTPS para segurança, monitore erros para resolver problemas rapidamente e fique informado sobre o status dos seus webhooks com alertas do TARGPatrol. Com a configuração correta, você otimizará os fluxos de trabalho e aumentará a produtividade da sua equipe.