Webhooks enhance team efficiency by bridging the information gap between systems. They fire automatically: when an event happens, PageProof sends a data payload containing proof information that another system can use to update itself.
Webhooks are available on Team Plus (optional paid add-on) and Enterprise plans.
Events that can trigger a webhook
Team administrators can create as many webhooks as they need. Each webhook can be triggered by one of 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 reviewer in the workflow is invited to review the proof
When a reviewer leaves their decision
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
When a user is nudged 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, choose the event that will trigger it, and enter the destination URL.
We recommend adding a signing secret* for extra security once your webhook testing is complete. 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
View an example data payload
Archive, or delete the webhook.
*Note: A signing secret allows your system to verify that a webhook truly originated from PageProof and that the payload is authentic. Learn more about how to set up signing secrets and use webhooks here.
Tips
The proofID is unique to the proof.
Use this format to construct a proof URL (works for all proof types):
https://app.pageproof.com/proof-screen/{proofID}The previousVersionProofID lets you daisy-chain proofs together, e.g.:
P123 (proof ID) version 1
P678 (proof ID) version 2 P123 (previousVersionProofID)
P925 (proof ID) version 3 P678 (previousVersionProofID)
(Actual IDs are longer and alphanumeric.)