Webhooks are notifications that you can subscribe to which allow you to receive API updates when things happen to your sent files such as viewed, printed, or when your files are downloaded.
Digify will POST the event details as JSON to your webhook URL. To begin, you will need to create a Digify Webhook and provide the following:
A suitable description for the webhook
URL for Digify to POST webhook
Username and password for basic authentication
Digify webhooks are sent in the following events:
When the file is viewed.
When the file is printed.
When the file is downloaded.
The webhook events contain the following attributes:
1. AccessType - The attribute's value is determined by the file permission set.
Anyone - Anyone with the file link can access the file. The RecipientUserEmail, RecipientFirstName and RecipientLastName attributes will be empty.
Anyone with email - Anyone with the file link and have provided an email address can access the file. The RecipientUserEmail attribute will return the recipient provided email address.
Verified user - Digify users that have verified their email or created an account can access the file. The RecipientUserEmail, RecipientFirstName and RecipientLastName attributes will return the user's details.
(Note: If the user has verified their email address, but hasn't created a Digify account, the RecipientFirstName will return the recipient's email address and the RecipientLastName attribute will be empty)
2. EventTime - The time when the event was triggered.
3. FileGUID - The ID assigned to the sent file.
4. FileName - The name of the sent file.
5. Link - The link for the sent file.
6. RecipientFirstName - The recipient’s first name
7. RecipientLastName - The recipient’s last name
8. RecipientUserEmail - The recipient’s email address
9. Type - The webhook event type. It can be View, Print or Download.
Sample Webhook
View Event
The view event will be triggered in the following scenarios:
If permission is set to “Restrict”, the webhook is sent when each recipient opens the file for the first time.
If permission is set to “Public” and RequestEmail is set to “false”, the webhook is sent when the first recipient open the file
If permission is set to “Public” and RequestEmail is set to “true”, the webhook is sent every time when the file is opened
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"
}
Print Event
The print event will be triggered when your recipients print your 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"
}
Download Event
The download event will be triggered when your recipients download your 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"
}