Enviar alerta por email

Saiba mais sobre a coleção Enviar alerta por email.

Para acessar a coleção Enviar alerta por email e usar as funcionalidades presentes nesse artigo, você precisa ter a permissão PIPELINE:CREATE. Aprenda mais na documentação sobre Papéis.

O objetivo da coleção Enviar alerta por email é receber qualquer conteúdo JSON na entrada, além das variáveis, ​​e enviá-lo por email.

Parâmetros estáticos de configuração da cápsula

• smtp-email: conta para autenticação com o servidor de email.

• de: endereço do remetente.

• environment: especifica o ambiente do alerta, por exemplo, test ou prod.

• destinatário: destinatário para quem o email deve ser enviado. Para usar uma lista, especifique um array JSON em formato de string.

• pipeline: o nome do pipeline (campo de texto livre).

• descricao-alerta: título que será usado no cabeçalho do email.

• assunto: assunto personalizado para identificar o email.

Parâmetros dinâmicos de configuração da cápsula

Os parâmetros também podem ser configurados dinamicamente. Para isso, informe os parâmetros dentro do objeto "emailParams": {}.

Os parâmetros informados dinamicamente são substituídos por parâmetros estáticos.

Entrada

{
  "logger": {
    "status": 200,
    "body": {
      "soap:Envelope": {
        "soap:Body": {
          "Erros": {
            "DescricaoErro": "Código de documento 1 não encontrado."
          },
          "ProcessamentoOK": false
        }
      }
    }
  },
  "emailParams": {
    "pipeline": "confirmar-ticket-gera",
    "descricao-alerta": "Erro ao consultar dados para integração.",
    "destinatario": "
[e-mail]
",
    "environment": "TEST",
    "assunto": "Erro Pedido"
  }
}

Saída

Sucesso

{  "success" : true }

Erro

{   
    "timestamp": 1559243275088,   
    "error": "Error",   
    "code": 500
}