Les webhooks sont des notifications auxquelles vous pouvez vous abonner et qui vous permettent de recevoir des mises à jour de l'API lorsque des choses se produisent dans les fichiers que vous avez envoyés, comme la visualisation, l'impression ou le téléchargement de vos fichiers.

Digify enverra les détails de l'événement sous forme de JSON à votre URL webhook. Pour commencer, vous devez créer un webhook Digify et fournir les éléments suivants :

une description appropriée pour le webhook
L'URL de Digify pour le POST du webhook
Un nom d'utilisateur et un mot de passe pour l'authentification de base

Les webhooks de Digify sont envoyés dans les cas suivants :

Lorsque le fichier est visualisé.
Lorsque le fichier est imprimé.
Lorsque le fichier est téléchargé.

Les événements webhook contiennent les attributs suivants :

1. AccessType - La valeur de l'attribut est déterminée par l'autorisation de fichier définie.

Anyone - Toute personne possédant le lien du fichier peut accéder au fichier. Les attributs RecipientUserEmail, RecipientFirstName et RecipientLastName seront vides.
Anyone with email - Toute personne possédant le lien vers le fichier et ayant fourni une adresse électronique peut accéder au fichier. L'attribut RecipientUserEmail renvoie l'adresse électronique fournie par le destinataire.
Verified user - Les utilisateurs de Digify qui ont vérifié leur adresse électronique ou créé un compte peuvent accéder au fichier. Les attributs RecipientUserEmail, RecipientFirstName et RecipientLastName renvoient les détails de l'utilisateur.

(Remarque : si l'utilisateur a vérifié son adresse électronique, mais n'a pas créé de compte Digify, l'attribut RecipientFirstName renverra l'adresse électronique du destinataire et l'attribut RecipientLastName sera vide).

2. EventTime - L'heure à laquelle l'événement a été déclenché.

3. FileGUID - L'identifiant attribué au fichier envoyé.

4. FileName - Nom du fichier envoyé.

5. Link - Le lien du fichier envoyé.

6. RecipientFirstName - Le prénom du destinataire.

7. RecipientLastName - Le nom de famille du destinataire.

8. RecipientUserEmail - L'adresse électronique du destinataire.

9. Type - Le type d'événement du webhook. Il peut s'agir de View, Print ou Download.

Exemple de webhook

Événement de visualisation

L'événement de visualisation sera déclenché dans les scénarios suivants :

Si l'autorisation est définie sur "Restrict", le webhook est envoyé lorsque chaque destinataire ouvre le fichier pour la première fois.
Si l'autorisation est définie sur "Public" et que RequestEmail est défini sur "false", le webhook est envoyé lorsque le premier destinataire ouvre le fichier.
Si la permission est définie sur "Public" et que RequestEmail est défini sur "true", le webhook est envoyé à chaque fois que le fichier est ouvert.

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

Événement d'impression

L'événement d'impression sera déclenché lorsque vos destinataires imprimeront votre fichier.

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

Événement de téléchargement

L'événement de téléchargement sera déclenché lorsque vos destinataires téléchargeront votre fichier.

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

Les traductions sont générées par une intelligence artificielle et peuvent contenir des inexactitudes.