Skip to main content

DocuSign Webhooks

TL;DR

To integrate DocuSign webhooks with ngrok:

  1. Launch your local webhook. npm start
  2. Launch ngrok. ngrok http 3000
  3. Configure DocuSign webhooks with your ngrok URL.
  4. Secure your webhook requests with verification.

This guide covers how to use ngrok to integrate your localhost app with DocuSign by using Webhooks. DocuSign webhooks can be used to notify an external application whenever specific events occur in your DocuSign account.

By integrating ngrok with DocuSign, you can:

  • Develop and test DocuSign webhooks locally, eliminating the time in deploying your development code to a public environment and setting it up in HTTPS.
  • Inspect and troubleshoot requests from DocuSign in real-time via the inspection UI and API.
  • Modify and Replay DocuSign Webhook requests with a single click and without spending time reproducing events manually in your DocuSign account.
  • Secure your app with DocuSign validation provided by ngrok. Invalid requests are blocked by ngrok before reaching your app.

Step 1: Start your app​

For this tutorial, we'll use the sample NodeJS app available on GitHub.

To install this sample, run the following commands in a terminal:

Loading…

This will get the project installed locally.

Now you can launch the app by running the following command:

Loading…

The app runs by default on port 3000.

You can validate that the app is up and running by visiting http://localhost:3000. The application logs request headers and body in the terminal and responds with a message in the browser.

Step 2: Launch ngrok​

Once your app is running successfully on localhost, let's get it on the internet securely using ngrok!

  1. If you're not an ngrok user yet, just sign up for ngrok for free.

  2. Download the ngrok agent.

  3. Go to the ngrok dashboard and copy your Authtoken.
    Tip: The ngrok agent uses the auth token to log into your account when you start a tunnel.

  4. Start ngrok by running the following command:

    Loading…

  5. ngrok will display a URL where your localhost application is exposed to the internet (copy this URL for use with DocuSign). ngrok agent running

Step 3: Integrate DocuSign​

To register a webhook on your DocuSign account follow the instructions below:

  1. Access DocuSign and sign in using your DocuSign account.

  2. In the top menu, click Settings and then click Connect under the INTEGRATIONS section of the left menu.

  3. In the Connect page, click ADD CONFIGURATION and then click Custom.

  4. On the Add Custom Configuration page, enter a name in the Name field, and in the URL to Publish field enter the URL provided by the ngrok agent to expose your application to the internet (i.e. https://1a2b-3c4d-5e6f-7g8h-9i0j.ngrok.app). URL to Publish

  5. In the Trigger Events sections, expand Envelope and Recipients, click Envelope Sent, and then click ADD CONFIGURATION at the bottom of the page.

Run Webhooks with DocuSign and ngrok​

DocuSign sends different request body contents depending on the event that is being triggered. You can trigger new calls from DocuSign to your application by following the instructions below.

  1. In the same browser, access your DocuSign inbox by clicking Manage on the top menu and then clicking START NOW.

  2. In the Upload a Document and Add Envelope Recipients page, click UPLOAD and then click Desktop.

  3. Select a document from your desktop, expand the Add recipients section and then click I'm the only signer. Tip: Optionally, you can select a user from the Name list.

  4. Click SIGN at the bottom right of the page.

    Confirm your localhost app receives the create-envelop event notification and logs both headers and body in the terminal.

Optionally, you can verify the log of the webhook call in DocuSign:

  1. Access your DocuSign account home page, and click Settings on the top menu.

  2. On the left menu, click Connect, click the LOGS tab, and then click the most recent entry in the log list. Logs

Inspecting requests​

When you launch the ngrok agent on your local machine, you can see two links:

  • The URL to your app (it ends with ngrok-free.app for free accounts or ngrok.app for paid accounts when not using custom domains)
  • A local URL for the Web Interface (a.k.a Request Inspector).

The Request Inspector shows all the requests made through your ngrok tunnel to your localhost app. When you click on a request, you can see details of both the request and the response.

Seeing requests is an excellent way of validating the data sent to and retrieved by your app via the ngrok tunnel. That alone can save you some time dissecting and logging HTTP request and response headers, methods, bodies, and response codes within your app just to confirm you are getting what you expect.

To inspect DocuSign's webhooks call, launch the ngrok web interface (i.e. http://127.0.0.1:4040), and then click one of the requests sent by DocuSign.

From the results, review the response body, header, and other details:

ngrok Request Inspector

Replaying requests​

The ngrok Request Inspector provides a replay function that you can use to test your code without the need to trigger new events from DocuSign. To replay a request:

  1. In the ngrok inspection interface (i.e. http://localhost:4040), select a request from DocuSign.

  2. Click Replay to execute the same request to your application or select Replay with modifications to modify the content of the original request before sending the request.

  3. If you choose to Replay with modifications, you can modify any content from the original request. For example, you can modify the summary field inside the body of the request.

  4. Click Replay.

Verify that your local application receives the request and logs the corresponding information to the terminal.

Secure webhook requests​

The ngrok signature webhook verification feature allows ngrok to assert that requests from your DocuSign webhook are the only traffic allowed to make calls to your localhost app.

Note: This ngrok feature is limited to 500 validations per month on free ngrok accounts. For unlimited, upgrade to Pro or Enterprise.

This is a quick step to add extra protection to your application.

  1. Access your DocuSign account home page and click Settings on the top menu.

  2. On the left menu, click Connect, click the CONNECT KEYS tab, click ADD SECRET KEY, and then copy the key value generated by DocuSign.

  3. In the Connect page, click the APPLICATIONS tab, click your webhook, and then in the Integration and Security Settings section click Include HMAC Signature.

  4. Create a file named docusign_policy.yml, replacing {your connect key} with the value you copied before:

    Loading…

  5. Restart your ngrok agent by running the command:

    Loading…

  6. Access DocuSign and create a new envelope.

    Verify that your local application receives the request and logs information to the terminal.