Os webhooks oferecem uma maneira para aplicativos externos receberem notificações em tempo real quando determinados eventos ocorrem na plataforma.
Para usar webhooks, é necessário ativá-los e gerar tokens. Ao usar dois secrets separados para um único URL de webhook, você adiciona uma camada extra de segurança. Se um secret for comprometido ou precisar ser substituído por qualquer motivo, você poderá atualizar e substituir os secrets sem interromper o serviço de webhook ou comprometer segurança de dados.
Ativar webhooks
Para ativar webhooks, siga estas etapas:
No portal da plataforma CCAI, clique em Configurações > Configurações do desenvolvedor. Se o menu Configurações não aparecer, clique em Menu.
Acesse o painel Webhooks e clique na opção Webhooks para ativar.
Em URL, insira um URL de webhook. Esse URL é o endpoint que recebe notificações em tempo real. Verifique se o webhook pode receber solicitações HTTP.
Clique em Gerar. Isso gera o secret principal, que é o token de segurança principal usado para autenticar e validar payloads de webhook recebidos. Ele funciona como o principal meio de proteger a comunicação do webhook.
Copie e salve o token em um local seguro.
Gere um secret secundário. O segredo secundário serve como token de segurança de backup ou failover. Ele é fornecido como uma medida de segurança adicional para melhorar a confiabilidade e a disponibilidade das notificações de webhook. Se, por qualquer motivo, o secret principal for comprometido ou se houver problemas com o uso dele, o secret secundário poderá assumir e continuar garantindo a comunicação.
Copie e salve o token em um local seguro.
Clique em Salvar.
Rotacionar secrets
Como prática recomendada de segurança, faça a rotação dos segredos do webhook periodicamente. Esse processo envolve gerar novas chaves secretas para os webhooks primário e secundário e atualizá-las no aplicativo para continuar recebendo notificações sem problemas.
Depois da configuração inicial dos webhooks, não é possível gerar um novo segredo principal diretamente. No entanto, é possível gerar um novo segredo secundário e fazer a rotação dos segredos para mudá-los.
Para fazer a rotação de secrets, siga estas etapas:
No portal da plataforma CCAI, clique em Configurações > Configurações do desenvolvedor. Se o menu Configurações não aparecer, clique em Menu.
Clique em Girar secrets.
Clique em Salvar.
Gerar novos secrets
Para fazer a rotação dos secrets e ter duas novas chaves secretas, siga estas etapas:
No portal da plataforma CCAI, clique em Configurações > Configurações do desenvolvedor. Se o menu Configurações não aparecer, clique em Menu.
Clique em Gerar para criar um novo secret secundário.
Clique em Alternar secrets para tornar o novo secret secundário o principal.
Clique em Gerar para criar um segundo novo secret secundário que vai substituir o antigo secret principal.
Clique em Salvar.