Os webhooks são notificações que pode subscrever e que lhe permitem receber actualizações da API quando acontecem coisas aos seus ficheiros enviados, tais como visualizados, impressos ou quando os seus ficheiros são descarregados.

A Digify irá POSTar os detalhes do evento como JSON para o seu URL de webhook. Para começar, você precisará criar um Webhook Digify e fornecer o seguinte:

Uma descrição adequada para o webhook
URL para o Digify fazer o POST do webhook
Nome de utilizador e palavra-passe para autenticação básica

Os webhooks do Digify são enviados nos seguintes eventos:

Quando o ficheiro é visualizado.
Quando o ficheiro é impresso.
Quando o ficheiro é transferido.

Os eventos de webhook contêm os seguintes atributos:

1. AccessType - O valor do atributo é determinado pela permissão de ficheiro definida.

Anyone - Qualquer pessoa com a ligação do ficheiro pode aceder ao ficheiro. Os atributos RecipientUserEmail, RecipientFirstName e RecipientLastName estarão vazios.
Anyone with email - Qualquer pessoa com a ligação ao ficheiro e que tenha fornecido um endereço de e-mail pode aceder ao ficheiro. O atributo RecipientUserEmail devolverá o endereço de correio eletrónico fornecido pelo destinatário.
Verified user - Os utilizadores Digify que tenham verificado o seu e-mail ou criado uma conta podem aceder ao ficheiro. Os atributos RecipientUserEmail, RecipientFirstName e RecipientLastName devolverão os detalhes do utilizador.

(Nota: Se o utilizador tiver verificado o seu endereço de correio eletrónico, mas não tiver criado uma conta Digify, o atributo RecipientFirstName devolverá o endereço de correio eletrónico do destinatário e o atributo RecipientLastName estará vazio)

2. EventTime - A hora em que o evento foi acionado.

3. FileGUID - O ID atribuído ao ficheiro enviado.

4. FileName - O nome do ficheiro enviado.

5. Ligação - A ligação para o ficheiro enviado.

6. RecipientFirstName - O primeiro nome do destinatário

7. RecipientLastName - O apelido do destinatário

8. RecipientUserEmail - O endereço de correio eletrónico do destinatário

9. Type (Tipo) - O tipo de evento do webhook. Pode ser View, Print ou Download.

Exemplo de webhook

Evento de visualização

O evento de visualização será acionado nos seguintes cenários:

Se a permissão estiver definida como "Restrict", o webhook é enviado quando cada destinatário abre o ficheiro pela primeira vez.
Se a permissão estiver definida como "Public" e RequestEmail estiver definido como "false", o webhook é enviado quando o primeiro destinatário abre o ficheiro
Se a permissão estiver definida como "Public" e RequestEmail estiver definido como "true", o webhook é enviado sempre que o ficheiro é aberto

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 impressão

O evento de impressão será acionado quando os destinatários imprimirem o ficheiro.

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 transferência

O evento de transferência será acionado quando os destinatários transferirem o ficheiro.

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

As traduções são geradas por inteligência artificial e podem conter imprecisões.