Webhooks

Team administrators can set up webhooks to trigger proof notifications to other applications.

Gemma avatar
Written by Gemma
Updated over a week ago

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

To create a webhook

Step 1

Click your avatar and select team, then webhooks.

Step 2

Click create webhook.

Create webhook button

The create webhook pop-up will be displayed:

Create a webhook pop up screen

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.

Example:

Webhook 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, archive, or delete the webhook.

Editing a webhook to edit, send an example, archive, or delete.

*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.

Did this answer your question?