Los webhooks son notificaciones a las que puedes suscribirte y que te permiten recibir actualizaciones de la API cuando ocurren cosas con tus archivos enviados, como que se vean, se impriman o cuando se descarguen tus archivos.

Digify enviará los detalles del evento como JSON a su URL webhook. Para empezar, necesitarás crear un Digify Webhook y proporcionar lo siguiente:

Una description adecuada para el webhook
URL para Digify para POST webhook
Username y password para la autenticación básica

Los webhooks de Digify se envían en los siguientes eventos:

Cuando se viewed el archivo.
Cuando se printed el archivo.
Cuando se downloaded el archivo.

Los eventos webhook contienen los siguientes atributos:

1. AccessType - El valor del atributo viene determinado por el permiso de archivo establecido.

Anyone - Cualquiera con el enlace del archivo puede acceder al archivo. Los atributos RecipientUserEmail, RecipientFirstName y RecipientLastName estarán vacíos.
Anyone with email - cualquiera que tenga el enlace al archivo y haya proporcionado una dirección de correo electrónico puede acceder al archivo. El atributo RecipientUserEmail devolverá la dirección de correo electrónico proporcionada por el destinatario.
Verified user - Los usuarios de Digify que hayan verificado su correo electrónico o creado una cuenta pueden acceder al archivo. Los atributos RecipientUserEmail, RecipientFirstName y RecipientLastName devolverán los datos del usuario.

(Nota: Si el usuario ha verificado su dirección de correo electrónico, pero no ha creado una cuenta Digify, el atributo RecipientFirstName devolverá la dirección de correo electrónico del destinatario y el atributo RecipientLastName estará vacío).

2. EventTime - La hora en la que se activó el evento.

3. FileGUID - El ID asignado al archivo enviado.

4. FileName - El nombre del archivo enviado.

5. Enlace - El enlace del archivo enviado.

6. RecipientFirstName - Nombre del destinatario.

7. RecipientLastName - El apellido del destinatario.

8. RecipientUserEmail - Dirección de correo electrónico del destinatario

9. Type - El tipo de evento webhook. Puede ser View, Print o Download.

Ejemplo de Webhook

Evento de vista

El evento de vista se activará en los siguientes escenarios:

Si el permiso está configurado como "Restrict", el webhook se envía cuando cada destinatario abre el archivo por primera vez.
Si el permiso es "Public" y RequestEmail es "false", el webhook se enviará cuando el primer destinatario abra el archivo.
Si el permiso es "Public" y RequestEmail es "true", el webhook se envía cada vez que se abre el archivo.

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 de impresión

El evento de impresión se activará cuando los destinatarios impriman el archivo.

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 de descarga

El evento de descarga se activará cuando los destinatarios descarguen el archivo.

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

Las traducciones son generadas por inteligencia artificial y pueden contener imprecisiones.