Webhooks can be used to enhance team efficiency by bridging the information gap between systems. Webhooks are automatic – an event triggers the webhook and passes a data payload. In the case of PageProof webhooks, the data payload will contain information about the proof which can be used to update another system.
Webhooks are available for Team Plus (as an optional paid extra), and Enterprise plans.
Team administrators can set up webhooks, as many as they’d like, that are triggered by the following events:
When a proof is created
When a proof reaches a certain status
Options: new, in proofing, with gatekeeper or approver, to-dos requested, awaiting new version, has new version, approved.
Workflow step reached
Option: Step name
When a proof is overdue
When a proof is deleted
When a proof is archived
When a proof is unarchived (reopened)
When a user is @ mentioned on a proof
To create a webhook
Step 1
Click your avatar and select team, then webhooks.
Step 2
Click create webhook.
The create webhook pop-up will be displayed:
Step 3
Enter a name for the webhook, select the event that the webhook will be triggered, and a url for the webhook.
We recommend adding a signing secret* to ensure an added layer of security on webhook URLs. Add the signing secret after your webhook testing.
Example:
Step 4
After the webhook is created, click the 3 dots icon to edit the webhook, send an example data payload to the webhook URL, view an example data payload, archive, or delete the webhook.
*Note: A signing secret is a way of validating that the webhook has originated from PageProof and is trusted to contain genuine proof information. You can read further about how to set up a signing secret and how to use webhooks here.
Tips
The proofID is unique to the proof.
For constructing the proof URL, the following will work for all proof types:
https://app.pageproof.com/proof-screen/{proofID}The previousVersionProofID can be used to daisy-chain link the proofs together.
For example:P123 (proof ID) version 1
P678 (proof ID) version 2 P123 (previousVersionProofID)
P925 (proof ID) version 3 P678 (previousVersionProofID)
(the IDs are much longer and a combination of numbers/letters of course).