Documentação das notificações

Geral

As notificações são muito úteis para se manter atualizado sobre determinados eventos. Por exemplo, pode configurar uma notificação por e-mail ou Slack para ser enviada sempre que um segredo for visualizado. A notificação inclui o ID e a descrição do segredo, bem como alguns detalhes do visualizador, como o endereço IP.

Tipos de notificação

Pode configurar as notificações para serem entregues através de:

  • Email
  • Slack
  • Webhook (HTTP POST)

Tipos de eventos

É possível configurar notificações para os seguintes eventos:

  • Segredo criado
  • Segredo visto
  • Segredo expirado

Notificações por correio eletrónico

As notificações por correio eletrónico podem ser configuradas em Notificações > Correio eletrónico. De momento, não é possível ter vários destinatários para as mensagens de correio eletrónico.

O Estado a secção da página mostra quando foi enviado o último e-mail de notificação.

Notificações do Slack

As notificações do Slack podem ser configuradas em Notificações > Slack.

As notificações do Slack utilizam os webhooks de entrada do Slack. Pode ler mais sobre esta funcionalidade em Documentação do Slack.

O Estado a secção da página mostra quando é que a última notificação foi enviada e se foi bem sucedida.

Notificações Webhook

As notificações Webhook podem ser configuradas em Notificações > Webhook.

As notificações Webhook podem ser utilizadas para enviar notificações a qualquer aplicação com API HTTP de entrada.

O seguinte JSON será enviado como um ficheiro POST quando o webhook é executado. O pedido Content-Type é definido como application/json.

      {
        event_type: "one of secret_created, secret_viewed, secret_expired",
        secret_id: "the ID of the secret",
        created_at: "timestamp when the secret was created",
        description: "description of the secret, if set",
        viewed_at: "timestamp when the secret was viewed, if viewed",
        viewed_by_ip: "IP address of the viewed, if viewed",
        viewed_by_user_agent: "HTTP User Agent of the viewer, if viewed",
        expires_at: "timestamp when the secret expires, if set",
        expired: "a boolean indicating if the secret has expired"
      }

O Estado a secção da página mostra quando é que a última notificação foi enviada e se foi bem sucedida.