Dokumentation - Benachrichtigungen

Allgemein

Benachrichtigungen sind sehr nützlich, um bei bestimmten Ereignissen auf dem Laufenden zu bleiben. Sie können zum Beispiel eine E-Mail- oder Slack-Benachrichtigung konfigurieren, die jedes Mal gesendet wird, wenn ein Geheimnis eingesehen wurde. Die Benachrichtigung enthält die ID und die Beschreibung des Geheimnisses sowie einige Details zum Betrachter, wie die IP-Adresse.

Arten der Benachrichtigung

Sie können Benachrichtigungen so konfigurieren, dass sie über zugestellt werden:

  • E-Mail
  • Slack
  • Webhook (HTTP POST)

Veranstaltungstypen

Sie können Benachrichtigungen für die folgenden Ereignisse konfigurieren:

  • Geheimnis geschaffen
  • Secret gesehen
  • Secret erloschen

E-Mail-Benachrichtigungen

E-Mail-Benachrichtigungen können konfiguriert werden unter Benachrichtigungen > E-Mail. Im Moment ist es nicht möglich, mehrere Empfänger für die E-Mails zu haben.

Die Status abschnitt der Seite zeigt an, wann die letzte Benachrichtigungs-E-Mail gesendet wurde.

Slack-Benachrichtigungen

Slack-Benachrichtigungen können konfiguriert werden unter Benachrichtigungen > Slack.

Slack-Benachrichtigungen verwenden die eingehenden Webhooks von Slack. Sie können mehr über diese Funktion lesen unter Slacks Dokumentation.

Die Status abschnitt der Seite zeigt an, wann die letzte Benachrichtigung gesendet wurde und ob sie erfolgreich war.

Webhook-Benachrichtigungen

Webhook-Benachrichtigungen können konfiguriert werden unter Benachrichtigungen > Webhook.

Webhook-Benachrichtigungen können verwendet werden, um Benachrichtigungen an jede Anwendung mit eingehender HTTP-API zu senden.

Die folgenden JSON nutzdaten werden als POST anfrage, wenn der Webhook ausgeführt wird. Die Anfrage Content-Type wird eingestellt auf 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"
      }

Die Status abschnitt der Seite zeigt an, wann die letzte Benachrichtigung gesendet wurde und ob sie erfolgreich war.