I webhook sono notifiche a cui ci si può iscrivere e che consentono di ricevere aggiornamenti API quando accadono cose ai file inviati, come la visualizzazione, la stampa o il download dei file.

Digify invierà i dettagli dell'evento come JSON all'URL del webhook. Per iniziare, è necessario creare un webhook Digify e fornire i seguenti elementi:

Una descrizione adeguata per il webhook
URL per il POST del webhook da parte di Digify
Nome utente e password per l'autenticazione di base

I webhook di Digify vengono inviati nei seguenti eventi:

Quando il file viene visualizzato.
Quando il file viene stampato.
Quando il file viene scaricato.

Gli eventi webhook contengono i seguenti attributi:

1. AccessType - Il valore dell'attributo è determinato dall'autorizzazione del file impostata.

Anyone - Chiunque abbia il link al file può accedere al file. Gli attributi RecipientUserEmail, RecipientFirstName e RecipientLastName saranno vuoti.
Anyone with email - Chiunque abbia il link al file e abbia fornito un indirizzo e-mail può accedere al file. L'attributo RecipientUserEmail restituirà l'indirizzo e-mail fornito dal destinatario.
Verified user - Gli utenti di Digify che hanno verificato la propria e-mail o creato un account possono accedere al file. Gli attributi RecipientUserEmail, RecipientFirstName e RecipientLastName restituiranno i dati dell'utente.

(Nota: se l'utente ha verificato il proprio indirizzo e-mail, ma non ha creato un account Digify, l'attributo RecipientFirstName restituirà l'indirizzo e-mail del destinatario e l'attributo RecipientLastName sarà vuoto).

2. EventTime - L'ora in cui l'evento è stato attivato.

3. FileGUID - L'ID assegnato al file inviato.

4. NomeFile - Il nome del file inviato.

5. Link - Il link del file inviato.

6. RecipientFirstName - Il nome del destinatario.

7. RecipientLastName - Il cognome del destinatario.

8. RecipientUserEmail - L'indirizzo e-mail del destinatario.

9. Tipo - Il tipo di evento webhook. Può essere View, Print o Download.

Esempio di webhook

Evento di visualizzazione

L'evento di visualizzazione verrà attivato nei seguenti scenari:

Se l'autorizzazione è impostata su "Restrict", il webhook viene inviato quando ogni destinatario apre il file per la prima volta.
Se l'autorizzazione è impostata su "Public" e RequestEmail è impostata su "false", il webhook viene inviato quando il primo destinatario apre il file.
Se l'autorizzazione è impostata su "Public" e RequestEmail è impostata su "true", il webhook viene inviato ogni volta che il file viene aperto.

Content-Type: application/json
Accept-Encoding: gzip
Cf-Ray: 371d1ddc6be1192c-HKG
Cf-Visitor: {"scheme":"https"}
Authorization: Basic dGVzaDpEZW1vMTIzNA==
Connection: close
Total-Route-Time: 0
Host: requestb.in
Via: 1.1 vegur
Connect-Time: 0
Content-Length: 255
X-Request-Id: c7ab2411-da1b-4a4e-aa40-ebb227d3a443

{
  "RecipientUserEmail": "tester1@email.com",
  "RecipientFirstName": "Digify",
  "RecipientLastName": "Tester1",
  "FileGUID": "1f51447850d247d791a5d9c295af79c5",
  "FileName": "secret.pdf",
  "Type": "View",
  "EventTime": "2017-06-20T07:46:50.6762428Z"
  "AccessType": "Verified User"
}

Evento di stampa

L'evento di stampa viene attivato quando i destinatari stampano il file.

Content-Type: application/json
Accept-Encoding: gzip
Cf-Ray: 371d1ddc6be1192c-HKG
Cf-Visitor: {"scheme":"https"}
Authorization: Basic dGVzaDpEZW1vMTIzNA==
Connection: close
Total-Route-Time: 0
Host: requestb.in
Via: 1.1 vegur
Connect-Time: 0
Content-Length: 255
X-Request-Id: c7ab2411-da1b-4a4e-aa40-ebb227d3a443

{
  "RecipientUserEmail": "tester1@email.com",
  "RecipientFirstName": "Digify",
  "RecipientLastName": "Tester1",
  "FileGUID": "1f51447850d247d791a5d9c295af79c5",
  "FileName": "secret.pdf",
  "Type": "Print",
  "EventTime": "2017-06-20T07:46:50.6762428Z"
  "AccessType": "Verified User"
}

Evento di download

L'evento di download verrà attivato quando i destinatari scaricheranno il file.

Content-Type: application/json
Accept-Encoding: gzip
Cf-Ray: 371d1ddc6be1192c-HKG
Cf-Visitor: {"scheme":"https"}
Authorization: Basic dGVzaDpEZW1vMTIzNA==
Connection: close
Total-Route-Time: 0
Host: requestb.in
Via: 1.1 vegur
Connect-Time: 0
Content-Length: 255
X-Request-Id: c7ab2411-da1b-4a4e-aa40-ebb227d3a443

{
  "RecipientUserEmail": "tester1@email.com",
  "RecipientFirstName": "Digify",
  "RecipientLastName": "Tester1",
  "FileGUID": "1f51447850d247d791a5d9c295af79c5",
  "FileName": "secret.pdf",
  "Type": "Download",
  "EventTime": "2017-06-20T07:46:50.6762428Z"
  "AccessType": "Verified User"
}

Le traduzioni sono generate dall'intelligenza artificiale e possono contenere imprecisioni.