Visão geral das notificações#
O Apidog permite que você se integre a aplicações de terceiros para enviar notificações a destinatários designados quando determinados eventos ocorrerem. Quando um evento específico é acionado, as notificações são enviadas em tempo real para plataformas como Slack. Os canais de notificação atualmente compatíveis incluem:Somente administradores do projeto podem configurar as definições de notificação. Atualmente, as notificações por email estão disponíveis apenas para os seguintes eventos:Teste automatizado concluído/com falha
Integração contínua concluída/com falha
Tarefas agendadas concluídas/com falha
Destinos de notificação#
Destinos de notificação são destinatários que recebem mensagens por meio de um canal específico quando determinados eventos acontecem.Para configurar notificações, primeiro você precisa criar um destino de notificação especificando um nome, selecionando um canal e configurando suas definições. Cada canal tem um processo de configuração exclusivo. As seções abaixo orientarão você na configuração passo a passo.Slack#
O Apidog oferece suporte ao envio de eventos de notificação para um Canal específico no Slack por meio da integração de apps do Slack — Incoming WebHooks — no Canal especificado e da configuração da URL do Webhook dos Incoming WebHooks, que pode enviar mensagens de eventos para o Canal do Slack.Descrição dos campos de configuração:| Campo de configuração | Obrigatório | Descrição |
|---|
| Nome da notificação | Não | Dê um nome à notificação integrada de terceiros para registrar sua finalidade. |
| Eventos de acionamento | Sim | Eventos compatíveis: alterações de API, alterações de schema, alterações de documento, importação de dados, testes de automação |
| URL do serviço | Sim | URL do Webhook em "Incoming WebHooks - Integration Settings" |
Administradores do projeto podem usar funções de integração de terceiros para associar apps do Slack — Incoming WebHooks adicionados no Slack — Canais a eventos de notificação do projeto no Apidog, a fim de enviar alterações de API relacionadas, alterações de documentação, conclusões de testes etc. para o Canal especificado no Slack.Etapa 1: Abrir detalhes do canal
No canal do Slack, clique na opção "Open channel details" no canto superior direito.Etapa 2: Instalar Incoming WebHook
Em Integrations - Apps do Canal específico, instale e adicione Incoming WebHook.Etapa 3: Visualizar Incoming WebHooks
Depois que a instalação for concluída, clique no botão à direita de Incoming WebHooks - View.Etapa 4: Configurar Incoming WebHooks
Isso abrirá a página de descrição de Incoming WebHooks; clique em Configuration para configurar.Etapa 5: Adicionar ao Slack
Etapa 6: Selecionar Canal e Adicionar Integração
Selecione o Canal para o qual enviar mensagens de eventos de notificação do Apidog e clique em Add Incoming WebHooks integration.Etapa 7: Obter URL do Webhook
Obtenha e copie a URL do Webhook.Etapa 8: Criar destino de notificação no Apidog
Clique em "Settings" > "Notifications" > "Notification Targets" > e crie um novo Destino de notificação.Preencha o nome do destino de notificação.
Escolha Slack como o canal de notificação.
Cole a URL do Webhook obtida nas configurações de Incoming WebHooks em Service URL.
Teams#
O suporte ao envio de notificações para o Microsoft Teams permite que Workflows no Teams usem essas mensagens como acionadores para ações adicionais — como publicar mensagens automaticamente em um grupo ou canal — ajudando as equipes a se manterem informadas sobre eventos importantes do Apidog.Especificamente, você pode configurar um Webhook Trigger dentro de um Workflow. Quando determinados eventos de notificação no Apidog forem acionados (por exemplo, alterações de API, atualizações de documentação ou conclusões de testes automatizados), o Apidog enviará uma requisição POST para a URL HTTP POST especificada do acionador, carregando o payload do evento.| Campo | Obrigatório | Descrição |
|---|
| Nome | Sim | Um nome que descreva a finalidade deste destino de notificação |
| URL HTTP POST | Sim | A URL na qual o Webhook Trigger no Workflow recebe requisições POST |
Etapa 1: Criar um workflow no Teams
Em Microsoft Teams → Workflow, clique em Create, e você pode começar rapidamente selecionando o modelo Post to a channel when a webhook request is received.Etapa 2: Definir nome do fluxo e conta
Defina um nome para o fluxo, selecione a conta apropriada e clique em Next.Etapa 3: Escolher grupo e canal
Escolha o grupo e o canal nos quais você deseja receber a notificação e clique em Create flow.Etapa 4: Obter URL HTTP POST
Depois que o fluxo for criado, a URL HTTP POST na etapa do acionador será exibida. Você pode copiá-la diretamente ou encontrá-la posteriormente na etapa do acionador do fluxo.Etapa 5: Configurar destino de notificação no Apidog
Cole esta URL HTTP POST na configuração do destino de notificação no Apidog.Etapa 6: Criar evento de notificação
Crie um evento de notificação no Apidog e associe-o ao destino de notificação do Teams configurado.Etapa 7: Verificar notificação do Teams
Quando este evento de notificação for acionado, o workflow criado anteriormente publicará automaticamente uma mensagem no canal do Teams selecionado.Webhook#
Oferece suporte ao envio de eventos de notificação para o Servidor HTTP. Você pode enviar mensagens de eventos para o Servidor HTTP especificando um endereço de URL para receber requisições POST.Descrição dos campos de configuração:| Campo de configuração | Obrigatório | Descrição |
|---|
| Nome da notificação | Não | Dê um nome à notificação integrada de terceiros para registrar a finalidade da notificação. |
| Evento de acionamento | Sim | Eventos compatíveis: alterações de API, alterações de modelo de dados, alterações de documento, importação de dados, testes de automação |
| URL do servidor | Sim | Endereço de URL do Servidor HTTP para receber requisições |
| Autenticação por assinatura | Não | O conteúdo enviado é criptografado pelo algoritmo de criptografia HMAC SHA1, usando um token como KEY para exibir o valor em hexadecimal (requer um token configurado), e contém o prefixo sha1= |
Administradores do projeto podem usar a integração de terceiros para associar seu Servidor HTTP auto-hospedado aos eventos de notificação do projeto no Apidog, a fim de receber notificações de alterações de API relevantes, alterações de documento e conclusões de testes de automação em seu Servidor HTTP.Para integrar a notificação do Apidog a um servidor HTTP auto-hospedado, clique em "Settings" > "Notifications" > "Notification Targets" > e crie um novo Destino de notificação.1.
Preencha o nome do destino de notificação.
2.
Escolha Webhook como o canal.
3.
Cole a URL do Servidor HTTP auto-hospedado no campo Service URL.
4.
Se a verificação de assinatura estiver habilitada, copie e cole a chave no campo Signature Key.
Jenkins#
Ele oferece suporte ao envio de eventos de notificação para o serviço Jenkins. Ao configurar a URL do Webhook do Jenkins, as mensagens de eventos podem ser enviadas para o Jenkins.Descrições dos campos de configuração:| Campo de configuração | Obrigatório | Descrição |
|---|
| Nome da notificação | Não | Dê um nome à notificação de integração de terceiros para registrar sua finalidade. |
| Eventos de acionamento | Sim | Alterações de API, alterações de modelo de dados, importação de dados, testes de automação. Notificações em tempo real serão acionadas quando qualquer um dos eventos acima ocorrer. |
| URL do serviço | Sim | A URL é configurada no plugin Generic Webhook Trigger. |
| Autenticação por assinatura | Não | Enviada para o plugin Generic Webhook Trigger por meio do cabeçalho Authorization Bearer. |
Administradores do projeto podem usar a funcionalidade de integração de terceiros para associar a URL do Webhook configurada no plugin Generic Webhook Trigger do Jenkins aos eventos de notificação do projeto no Apidog, a fim de acionar automaticamente uma ação de build no Jenkins quando eventos como alterações de API, alterações de documento e conclusões de testes de automação forem acionados, e visualizar mensagens no histórico de builds.Etapa 1: URL do Webhook configurada no plugin Jenkins Generic Webhook Trigger
Crie uma nova visualização no Jenkins Dashboard:Clique na visualização da etapa anterior para acessar Configure>Build Triggers e selecione Generic Webhook Trigger. A URL do Webhook é "http://"+"your service address"+"/generic-webhook-trigger/invoke"O token personalizado é compatível:Etapa 2: Criar um novo destino de notificação
Clique em "Settings" > "Notifications" > "Notification Targets" > e crie um novo Destino de notificação.Preencha o nome do destino de notificação.
Escolha Jenkins como o canal
Se um token personalizado for usado, copie e cole o Token no campo Signature Token.
Email#
As notificações podem ser enviadas por email para endereços de email especificados. Atualmente, as notificações por email estão disponíveis apenas para os seguintes eventos:Teste automatizado concluído/com falha
Integração contínua concluída/com falha
Tarefas agendadas concluídas/com falha
| Campo | Obrigatório | Detalhes |
|---|
| Nome | Sim | Um nome descritivo que destaque a finalidade ou as características do destino de notificação. |
| Endereço de email de notificação | Sim | Insira o(s) endereço(s) de email para receber notificações. Você pode selecionar endereços de email de membros do projeto ou digitar manualmente um endereço. Há suporte a vários endereços de email. |
1.
Preencha o nome do destino de notificação.
2.
Escolha Email como o canal
Eventos de notificação#
Você pode criar eventos de notificação para especificar quais eventos acionarão notificações para destinatários designados (destinos de notificação). Para configurar um evento de notificação, você precisa configurar:Nome do evento de notificação
Evento de acionamento#
Você pode escolher entre os seguintes eventos de notificação para acionar a notificação:| Evento de acionamento | Detalhes |
|---|
| Endpoint alterado | Endpoint criado
Endpoint atualizado
Endpoint excluído |
| Schema alterado | Schema criado
Schema atualizado
Schema excluído |
| Documento alterado | Documento criado
Documento atualizado
Documento excluído |
| Importação de dados | Importação (importação manual)
Importação (sincronização automática) |
| Componente de resposta alterado | Componente de resposta criado
Componente de resposta atualizado
Componente de resposta excluído |
| Branch de sprint alterada | Branch de sprint mesclada
Branch de sprint criada
Branch de sprint arquivada
Branch de sprint excluída
Branch de sprint recuperada |
| Versão da API alterada | Versão da API criada
Versão da API excluída |
| Esquema de segurança alterado | Esquema de segurança criado
Esquema de segurança atualizado
Esquema de segurança excluído |
Para notificações relacionadas a testes automatizados (por exemplo, teste automatizado concluído, integração contínua concluída, tarefa agendada concluída), você precisa configurar as definições individualmente para cada cenário de teste. Essa abordagem é mais flexível e atende melhor a casos de uso reais.
Destinos de notificação#
Escolha quais destinos de notificação receberão a notificação quando um evento de acionamento ocorrer. Você pode escolher entre os destinos de notificação que já foram configurados no projeto e selecionar vários destinos, se necessário.No entanto, as notificações por email são compatíveis apenas com três eventos específicos:Teste automatizado concluído/com falha
Integração contínua concluída/com falha
Tarefas agendadas concluídas/com falha
