Email Transacional

Permite a configuração de e-mail transacional aplicando um template na mensagem trafegada.

Ao contrário do output Email esse output envia os dados na medida que forem chegados, sem nenhum agrupamento por janelas.

Todos os templates são criados pelo próprio time interno da Blip. Atualmente não permitimos templates customizados pelo próprio usuário para evitar mal uso da ferramenta.

Parâmetros

Parâmetros aceitos para esse tipo de sindicância de destino:

Campo	Descrição	Valor
transactional_email.to	E-mails dos destinatários	Tipo: []string Obrigatório
transactional_email.cc	E-mails em cópia	Tipo: []string Valor padrão: -
transactional_email.bcc	E-mails em cópia oculta	Tipo: []string Valor padrão: -
transactional_email.subject	Assunto do e-mail	Tipo: string Obrigatório
transactional_email.template_id	Template do e-mail	Tipo: enum[ALERT] Obrigatório

Requisição

curl --location '<HOST>/v1/configs' \
--header 'Content-Type: application/json' \
--header 'Authorization: <ACCESS-TOKEN>' \
--data '{
    "output": {
        "type": "TRANSACTIONAL_EMAIL",
        "transactional_email": {
          "to": [
            "[e-mail]"
          ],
          "cc": [
            "[e-mail]"
          ],
          "bcc": [
            "[e-mail]"
          ],
          "subject": "SUBJECT",
          "template_id": "ALERT"
        }
    }
}'

Resposta

A resposta desse endpoint será no seguinte formato:

{
  "id": "FIREHOSE-ID",
  "output": {
    "type": "TRANSACTIONAL_EMAIL",
    "transactional_email": {
      "to": [
        "*"
      ],
      "cc": [
        "*"
      ],
      "bcc": [
        "*"
      ],
      "subject": "SUBJECT",
      "template_id": "ALERT"
    }
  }
}

Templates

Para cada template a mensagem trafegada precisa ter uma estrutura específica. Caso seja necessário a criação de um novo template, entre em contato com o nosso time.

ALERT

Template que permite envio de alertas através do firehose via e-mail. A mensagem de alerta precisa seguir o seguinte formato para conseguir construir o template:

{
  "alerts": [
    {
      "annotations": {
        "Custom annotation": "Custom annotation content",
        "description": "Some export errors occured in the last 15 minutes",
        "summary": "Some export errors occured"
      },
      "labels": {
        "alertname": "Alert name",
        "grafana_folder": "Grafana Folder"
      },
      "status": "resolved",
      "values": {
        "B": 10,
        "C": 1
      }
    }
  ]
}