How do webhooks work in Papersign?

This article is about the eSignature product, Papersign. If you would like to add webhooks to online forms with Paperform, see the Paperform article on webhooks.

This feature is exclusively available with specific pricing plans.

What are webhooks?

Webhooks are used by developers to integrate Papersign with their own services. You can configure a webhook to fire when signature requests are sent out, when a document's signatures are completed, or at any other point during the signing process.

For less technical teams, Zapier is a no-code platform that you can use to configure automations between Papersign and many existing apps. We recommend this over custom webhooks if you're new to setting up integrations.

Optional: set up your folder or space

In Papersign, each webhook is associated with a specific space or folder, as opposed to a single document. This is because webhooks are meant to automate tasks in the long term—you shouldn't need to reconfigure them for each contract that gets signed. Rather, you can organize your documents into folders and spaces first, and then add webhooks to those groups directly. A webhook will fire when a specific action takes place for any document within the designated folder or space.

So, the first step will usually be to make sure your documents are organized in such a way that you can apply a webhook to the appropriate space or folder. You will have the option for the webhook to include all sub-folders, or you can set it to only affect direct children of the current space/folder.

Alternatively, you can add webhooks to the default space for new documents, labeled "My Dashboard."

Configure the webhook

From your Papersign Dashboard, select the space and/or folder that you would like to set up the webhook for. Click the three dots next to the name of the space or folder path at the top, and then select "Webhooks."

This will bring you to the current list of webhooks for that space or folder. Click the "Add Webhook" button in the top-right. Next, you'll be prompted to enter some information to set up the webhook.

• Name: This optional field allows you to name your webhooks. This is just for your own reference within Papersign, but it's recommended if you plan to have more than one for a certain space or folder.

• URL: Your webhook's endpoint URL. We will POST a JSON payload to this web address when the trigger event takes place in Papersign.

• Triggered for: This decides whether the webhook should fire for documents inside sub-folders within the current space or folder. "Direct children" will exclude sub-folders, while "all descendants" will include them.

• Triggered on: Select the type of event that should trigger the webhook. You may select as many trigger events as you like for each webhook. The options are:

  • Document sent
  • Document completed
  • Document cancelled
  • Document rejected
  • Document expired
  • Signer notified
  • Signer viewed
  • Signer consent accepted
  • Signer nominated
  • Signer signed

  Please note that "document completed" is the only trigger event that will cause a URL for the signed document itself to be included in the payload.

Gotchas

• If there are multiple users on your Paperform team, you can use webhooks for shared documents too. In this case, create a specific shared folder first and then attach the webhook to that folder. You can't add a webhook to "My Team Documents" (as this isn't technically a folder or space, but rather a way to view documents in different spaces).