Tipos de notificação

O Zenhook desenha cada tipo de evento como um widget construído a partir do seu próprio histórico. Não há nada a configurar: o payload que já envia decide o widget.

Um tipo de evento é um fluxo: mesmo canal e mesmo título, com os números ignorados. “Pedido 1284 pago” e “Pedido 1285 pago” formam um só fluxo. Mantenha o título estável e coloque o que muda em message, fields ou actor.

Quando um fluxo corresponde a vários tipos, prevalece o primeiro desta lista.

Pipeline

Quando: O título contém deploy, build, release, pipeline ou CI, ou o evento traz um bloco workflow.
Mostra: Se a última execução passou ou falhou, as últimas execuções numa faixa e quantas passaram.

Enviar

json

{
  "title": "api deploy",
  "level": "success",
  "message": "v2.4.0"
}

Erro

Quando: level é error e aconteceu pelo menos duas vezes hoje ou esta semana. Um erro isolado continua a ser um cartão aberto.
Mostra: Que ocorrência do dia é, desde quando, as horas afetadas, a mensagem e o seu link.

Enviar

json

{
  "title": "Falha no webhook de pagamento",
  "level": "error",
  "message": "Assinatura Stripe inválida",
  "linkUrl": "https://…"
}

Dinheiro

Quando: Um campo chamado Valor, Preço, Total, Pagamento, Receita, Amount, Price, Revenue, Paid ou MRR contém um montante.
Mostra: O total do dia no formato monetário de quem lê, o número de pagamentos e a semana.

Enviar

json

{
  "title": "Pagamento recebido",
  "level": "success",
  "fields": [
    {
      "label": "Valor",
      "value": "49,00 €"
    }
  ]
}

Pessoa

Quando: O evento tem um actor (ou user).
Mostra: Quem, com a fotografia ou as iniciais, a empresa e o plano, e quantos hoje e esta semana.

Enviar

json

{
  "title": "Novo registo",
  "actor": {
    "name": "Jane Cooper",
    "email": "[email protected]"
  }
}

Sequência

Quando: Acontece cerca de uma vez por dia, no máximo três vezes, durante três dias seguidos ou mais.
Mostra: Quantos dias seguidos, e a semana em visto.

Enviar

json

{
  "title": "Cópia de segurança noturna",
  "level": "success"
}

Contador

Quando: A predefinição para tudo o que se repete: duas vezes hoje ou três vezes esta semana.
Mostra: A contagem do dia, a diferença para ontem à mesma hora, barras por hora e o pico.

Enviar

json

{
  "title": "Relatório exportado",
  "message": "Receitas do 3.º trimestre, CSV"
}

Cartão aberto

Quando: Um evento isolado, ou o primeiro do seu tipo.
Mostra: Tudo, sem clicar: mensagem, campos e link.

Enviar

json

{
  "title": "Domínio renovado",
  "message": "Renovado automaticamente por um ano.",
  "fields": [
    {
      "label": "Domínio",
      "value": "acme.com"
    }
  ]
}

Todos os campos estão descritos na referência da API de webhook.