Integrações com Webhook

Configure notificações automáticas para eventos importantes na sua plataforma Deepze

Os webhooks permitem que você receba notificações automáticas sempre que novos usuários se cadastram na sua instância. Isso é feito fornecendo uma URL de webhook para a Deepze, que enviará notificações para essa URL quando uma nova conta de usuário for criada.

Visão Geral

A funcionalidade de webhook da Deepze permite que você conecte sua plataforma a serviços externos, enviando notificações automáticas quando eventos específicos ocorrem. Atualmente, a Deepze suporta notificações para novos cadastros de usuários, mas planejamos adicionar mais tipos de eventos no futuro.

Benefícios dos Webhooks

Receba notificações em tempo real sobre novos usuários
Integre com ferramentas de comunicação como Slack ou Discord
Automatize processos baseados em eventos da plataforma
Mantenha sua equipe informada sobre atividades importantes

Configuração de Webhooks

Para configurar webhooks na Deepze, você precisará obter uma URL de webhook de um serviço externo que suporte webhooks, como um canal do Discord ou um workspace do Slack. Esta URL será usada para receber notificações da Deepze.

Configurar através da Interface de Administração

Faça login na sua instância Deepze como administrador.
Navegue até o Painel de Administração.
Clique na aba Configurações localizada no topo.
A partir daí, navegue até a seção Geral das configurações no painel de administração.
Localize o campo URL do Webhook e insira a URL do webhook.
Salve as alterações.

Configuração de webhook no painel de administração

Verificar o Webhook

Para verificar se o webhook está funcionando corretamente, crie uma nova conta de usuário na Deepze. Se o webhook estiver configurado corretamente, você deverá receber uma notificação na URL de webhook especificada.

Dica: Muitos serviços como Discord e Slack oferecem recursos para testar webhooks diretamente em suas plataformas. Utilize esses recursos para garantir que sua URL de webhook está funcionando antes de configurá-la na Deepze.

Formato do Payload do Webhook

O payload do webhook enviado pela Deepze está em texto simples e contém uma mensagem de notificação simples sobre a nova conta de usuário. O formato do payload é o seguinte:

Novo usuário cadastrado: <nome_de_usuário>

Por exemplo, se um usuário chamado "Tim" se cadastrar, o payload enviado seria:

Novo usuário cadastrado: Tim

Nota: A funcionalidade de webhook na Deepze ainda está evoluindo, e planejamos adicionar mais recursos e tipos de eventos no futuro, incluindo payloads mais ricos em formato JSON.

Solução de Problemas

Se você estiver enfrentando problemas com a configuração ou funcionamento dos webhooks, verifique os seguintes pontos:

Checklist de Solução de Problemas

Certifique-se de que a URL do webhook está correta e formatada adequadamente.
Verifique se o serviço de webhook está habilitado e configurado corretamente.
Verifique os logs da Deepze para quaisquer erros relacionados ao webhook.
Verifique se a conexão não foi interrompida ou bloqueada por um firewall ou proxy.
O servidor de webhook pode estar temporariamente indisponível ou experimentando alta latência.
Se fornecida pelo serviço de webhook, verifique se a chave de API do Webhook é inválida, expirou ou foi revogada.

Exemplos de Integração

Abra o Discord e navegue até o servidor onde deseja receber notificações.
Clique com o botão direito no canal desejado e selecione "Configurações do Canal".
Navegue até "Integrações" e clique em "Webhooks".
Clique em "Novo Webhook", dê um nome e, opcionalmente, altere o avatar.
Copie a URL do webhook e use-a na configuração da Deepze.

Acesse o Slack e navegue até o workspace onde deseja receber notificações.
Vá para a página de aplicativos do Slack e procure por "Incoming Webhooks".
Adicione o aplicativo ao seu workspace e selecione o canal para receber as notificações.
Copie a URL do webhook fornecida e use-a na configuração da Deepze.

Documentação