Documentació de notificacions

General

Les notificacions són molt útils per mantenir-se al dia amb certs esdeveniments. Per exemple, podeu configurar una notificació per correu electrònic o Slack que s'enviï cada vegada que s'hagi visualitzat un secret. La notificació inclou l'ID i la descripció del secret, així com alguns detalls de l'usuari que ho ha visualitzat, com ara l'adreça IP.

Tipus de notificacions

Podeu configurar les notificacions perquè s'entreguin a través de:

  • Adreça electrònica
  • Slack
  • Webhook (HTTP POST)

Tipus d'esdeveniments

Podeu configurar notificacions per als següents esdeveniments:

  • Secret creat
  • Secret vist
  • Secret caducat

Notificacions per correu electrònic

Les notificacions per correu electrònic es poden configurar a Notificacions > Correu electrònic. En aquest moment no és possible tenir múltiples destinataris per als correus electrònics.

La Estat secció de la pàgina mostra quan es va enviar l'últim correu electrònic de notificació.

Notificacions de Slack

Les notificacions de Slack es poden configurar a Notificacions > Slack.

Les notificacions de Slack utilitzen els webhooks entrants de Slack. Podeu llegir més sobre la funció a la documentació de Slack.

La Estat la secció de la pàgina mostra quan es va enviar l'última notificació i si va ser exitosa.

Notificacions de webhook

Les notificacions de Webhook es poden configurar a Notificacions > Webhook.

Les notificacions de webhook es poden utilitzar per enviar notificacions a qualsevol aplicació amb una API HTTP d'entrada.

El següent JSON payload s'enviarà com a POST sol·licitud quan s'executi el webhook. La sol·licitud Content-Type està configurada per 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"
      }

La Estat la secció de la pàgina mostra quan es va enviar l'última notificació i si va ser exitosa.