Criando uma Integração de Alerta de Webhooks

Este artigo explica como criar uma integração para sua conta Cato que usa Webhooks para alertas e notificações do sistema.

Visão Geral

O Aplicativo de Gerenciamento Cato suporta uma variedade de alertas e notificações para diferentes casos de uso e condições relacionados à sua conta. Você pode definir uma integração de Webhook para enviar alertas para plataformas de terceiros como ServiceNow, Jira e Slack, e criar fluxos de automação baseados em alertas. Os Webhooks da Cato suportam cabeçalhos e mensagens HTTP personalizáveis no alerta para atender às necessidades específicas da sua organização.

Criando Integrações de Webhook

Crie uma integração de Webhook para o serviço de bilhetes relevante. Você precisa fornecer o URL do serviço que está recebendo o alerta via Webhook com as informações de autenticação relevantes. Os seguintes métodos de autenticação estão disponíveis:

  • Básico - Autenticação básica com Nome de Usuário e Senha.

  • Bearer - Autenticação Bearer com Token de Autenticação.

  • Personalizado - Alguns serviços usam autenticação personalizada e podem requerer cabeçalhos de autenticação e autorização personalizados. Para esses serviços, escolha Autenticação Personalizada e forneça a chave e o valor relevantes para cada Cabeçalho Personalizado.

Você tem a opção de configurar cabeçalhos HTTP personalizados para o Webhook. Você pode usar o corpo padrão da mensagem de alerta ou personalizar um desses modelos JSON:

Nota

Nota: Se o acesso ao serviço de terceiros for limitado a endereços IP específicos, por favor, consulte este artigo para a lista de endereços IP da Cato que você precisa permitir (você deve estar conectado para visualizar este artigo).

  • Básico - ID da Conta, Nome da Conta, título, assunto, tipo de alerta e o conteúdo do alerta

    Os campos no modelo Básico estão incluídos na maioria dos alertas da Cato

  • Todos os campos - todos os campos predefinidos estão incluídos no modelo

  • ServiceNow - work_notes (conteúdo do alerta), short_description (Nome da Conta e título)

  • Jira - resumo (Nome da Conta e título), descrição (conteúdo do alerta)

  • Personalizado - Defina o conteúdo para o corpo do Webhook, você pode começar com um dos modelos acima e fazer alterações

Personalizando o Conteúdo do Alerta

O campo content no modelo contém o resumo legível gerado do alerta, semelhante ao conteúdo do alerta por e-mail. Você pode escolher esses formatos para o conteúdo: contentText, contentMarkdown, ou contentHTML.

Se você optar por personalizar o corpo, há uma série de campos de dados que você pode usar no conteúdo da mensagem. Assim, você pode definir o corpo personalizado (ou estrutura), e então embutir os campos de dados da Cato. Quando você digita $, os campos de dados disponíveis são exibidos e então selecione o campo necessário. Os campos usam auto-completar para filtrar a lista. Para mais informações sobre os campos da Cato, veja Understanding the JSON Fields for Alert Integrations.

Página de Webhooks

Para criar uma integração de Webhook:

  1. No menu de navegação, clique em Conta > Assinaturas e selecione a aba Integrações.

  2. Clique em Nova Integração > Webhook. O painel Nova Integração de Webhook é aberto.

  3. Configure essas configurações de integração:

    1. Digite o Nome da integração.

    2. Clique no controle deslizante para ativar (verde) ou desativar (cinza) a integração (está ativada por padrão).

  4. Configure os Detalhes da Conexão:

    1. Digite o URL para o serviço que está recebendo o Webhook.

    2. Se necessário, configure o Método de Autenticação e as configurações para o serviço.

    3. Clique em Teste. Se a integração puder se conectar ao serviço, então uma mensagem de Teste passou com sucesso é exibida.

      Se houver um erro de conexão, a página exibirá o código de erro HTTP e a mensagem relatados pelo serviço.

  5. (Opcional) Em Cabeçalhos Personalizados, defina a Chave e o Valor para cada cabeçalho HTTP adicional para a integração.

  6. Em Corpo Personalizado, defina o conteúdo do alerta do Webhook:

    1. Em Começar a partir do modelo, selecione o modelo JSON para a mensagem de alerta.

    2. (Opcional) Em Editar Template, personalize o conteúdo do alerta.

      • Digite $ para embutir outros campos

      • Digite / como o caractere de escape

      Após editar e salvar o conteúdo de um modelo Predefinido, a Integração é então definida como um modelo Personalizado.

  7. Clique em Salvar. A integração de Webhook é salva e adicionada à página de Integrações.

Definindo Notificações de Política com Webhooks

As políticas de Segurança da Cato permitem que você envie notificações quando uma regra é correspondida. Você pode configurar as Configurações para enviar notificações para uma integração específica ou para um Grupo de Assinatura que contém a integração.

rule_webhook.png

Para definir uma notificação de Webhook para uma regra:

  1. Na política relevante, edite a regra e expanda a seção Ações.

  2. Selecione Enviar Notificação.

  3. Defina a Frequência para definir com que frequência o alerta é enviado.

  4. Em Enviar notificação para, selecione Grupo de Assinatura ou Integração e selecione o item relevante.

  5. Clique em Aplicar.

Esse artigo foi útil?

Usuários que acharam isso útil: 0 de 1

0 comentário