Quando as entregas de webhook falham, é importante que as pessoas certas sejam notificadas para que possam resolver o problema rapidamente. Agora você pode configurar um Contato técnico dedicado para a sua empresa, garantindo que as notificações relacionadas à API sejam enviadas para a equipe responsável pela manutenção das suas integrações.
Visão geral
O Contato técnico permite que sua empresa defina o endereço de e-mail que deve receber e-mails de notificação da API, como falhas na entrega de webhook.
Anteriormente, essas notificações eram enviadas para um destinatário inferido, como o e-mail do parceiro, o proprietário da aplicação OAuth ou a pessoa que criou a assinatura do webhook. Em muitos casos, esses destinatários já não eram mais responsáveis pela integração, causando problemas que passaram despercebidos.
Ao configurar um Contato técnico, você pode garantir que as notificações da API cheguem à equipe apropriada e ajudar a reduzir o tempo de inatividade causado por falhas de webhook não percebidas.
Se nenhum Contato técnico estiver configurado, o processo de notificação continuará a funcionar como antes.
Como usar
- Na sua barra lateral, vá para Configurações
- Abra Configuração avançada
- Selecione Notificações da API
- No campo Contato técnico, insira o endereço de e-mail que deve receber as notificações da API
- Clique em Salvar
Para remover o Contato técnico, limpe o campo de Contato técnico. Uma vez removido, as notificações seguirão o fluxo de destinatário padrão.
Se você não conseguir salvar o endereço de e-mail do Contato técnico, o endereço de e-mail pode não estar em um formato válido. Verifique se você inseriu um endereço de e-mail válido e tente salvar novamente.
Como as notificações são enviadas
Quando uma entrega de webhook falha, Factorial notifica os destinatários na seguinte ordem:
- E-mail do parceiro
- Contato técnico da empresa (se configurado)
- Proprietário da aplicação OAuth
- Autor da assinatura do webhook
- Administradores da empresa
Se nenhum Contato técnico foi configurado, esta etapa é pulada e o fluxo de notificação restante continua inalterado.
Quando uma entrega de webhook atinge seu estado final de falha após todas as tentativas de reenvio terem sido esgotadas, os administradores da empresa continuam a receber a notificação como a última alternativa.
Dicas e melhores práticas
- Configure um endereço de e-mail compartilhado da equipe (por exemplo, a caixa de entrada da sua equipe de Engenharia ou TI) em vez do endereço de e-mail de um indivíduo
- Revise regularmente o Contato técnico configurado para garantir que permaneça atualizado
- Use uma caixa de correio monitorada para que as falhas de webhook possam ser tratadas o mais rápido possível
FAQ
-
É obrigatório configurar um Contato técnico?
Não. Se você não configurar um Contato técnico, Factorial continuará usando o fluxo de notificação existente sem alterações.
-
Quem deve ser configurado como Contato técnico?
Recomendamos usar uma caixa de correio compartilhada monitorada, de propriedade da equipe responsável pela manutenção das suas integrações de API, em vez do endereço de e-mail de um funcionário individual.
-
Essa mudança afeta as assinaturas de webhook existentes?
Sim. Uma vez que um Contato técnico é configurado, ele se torna parte da cascata de destinatários de notificação para falhas na entrega de webhook. Nenhuma alteração nas assinaturas de webhook existentes é necessária.
-
O que acontece se eu remover o Contato técnico?
O Contato técnico é removido do fluxo de notificação, e as notificações de falha de webhook seguem a mesma cascata de destinatários usada antes da introdução deste recurso.