Webhooks sind Benachrichtigungen, die Sie abonnieren können, um API-Updates zu erhalten, wenn etwas mit Ihren gesendeten Dateien geschieht, z. B. wenn sie angesehen oder gedruckt werden oder wenn Ihre Dateien heruntergeladen werden.

Digify POST die Ereignisdetails als JSON an Ihre Webhook-URL. Um zu beginnen, müssen Sie einen Digify-Webhook erstellen und Folgendes angeben:

Eine geeignete Beschreibung für den Webhook
URL für Digify zum POST des Webhooks
Benutzername und Passwort für die grundlegende Authentifizierung

Digify-Webhooks werden bei den folgenden Ereignissen gesendet:

Wenn die Datei angezeigt wird.
Wenn die Datei gedruckt wird.
Wenn die Datei heruntergeladen wird.

Die Webhook-Ereignisse enthalten die folgenden Attribute:

1. AccessType - Der Wert des Attributs wird durch die eingestellte Dateiberechtigung bestimmt.

Anyone - Jeder, der über den Dateilink verfügt, kann auf die Datei zugreifen. Die Attribute RecipientUserEmail, RecipientFirstName und RecipientLastName werden leer sein.
Jeder mit E-Mail - Jeder, der den Dateilink hat und eine E-Mail-Adresse angegeben hat, kann auf die Datei zugreifen. Das Attribut RecipientUserEmail gibt die vom Empfänger angegebene E-Mail-Adresse zurück.
Verifizierter Benutzer - Digify-Benutzer, die ihre E-Mail verifiziert oder ein Konto erstellt haben, können auf die Datei zugreifen. Die Attribute RecipientUserEmail, RecipientFirstName und RecipientLastName geben die Details des Benutzers zurück.

(Hinweis: Wenn der Benutzer seine E-Mail-Adresse verifiziert hat, aber kein Digify-Konto erstellt hat, gibt das Attribut RecipientFirstName die E-Mail-Adresse des Empfängers zurück und das Attribut RecipientLastName ist leer)

2. EventTime - Die Zeit, zu der das Ereignis ausgelöst wurde.

3. FileGUID - Die der gesendeten Datei zugewiesene ID.

4. FileName - Der Name der gesendeten Datei.

5. Link - Der Link für die gesendete Datei.

6. RecipientFirstName - Der Vorname des Empfängers

7. RecipientLastName - Der Nachname des Empfängers

8. RecipientUserEmail - Die E-Mail Adresse des Empfängers

9. Type - Der Webhook-Ereignistyp. Es kann View, Print oder Download sein.

Beispiel Webhook

Ansicht-Ereignis

Das View-Ereignis wird in den folgenden Szenarien ausgelöst:

Wenn die Berechtigung auf "Restrict" gesetzt ist, wird der Webhook gesendet, wenn jeder Empfänger die Datei zum ersten Mal öffnet.
Wenn die Berechtigung auf "Public" und RequestEmail auf "false" gesetzt ist, wird der Webhook gesendet, wenn der erste Empfänger die Datei öffnet.
Wenn die Berechtigung auf "Public" und RequestEmail auf "true" gesetzt ist, wird der Webhook jedes Mal gesendet, wenn die Datei geöffnet wird.

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"
}

Druck-Ereignis

Das Druckereignis wird ausgelöst, wenn Ihre Empfänger Ihre Datei drucken.

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"
}

Download-Ereignis

Das Download-Ereignis wird ausgelöst, wenn Ihre Empfänger Ihre Datei herunterladen.

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"
}

Bitte beachten Sie, dass die Übersetzungen von KI generiert werden und Ungenauigkeiten enthalten können.