Skip to navigation
Platform 101WebhooksImplement Connect with your app

Create a custom configuration and trigger a test event

View as Markdown

To implement Connect with your app and webhook listener, you will need to create a custom configuration. The configuration tells Connect which events your app needs to know about, where to send its messages, which message format to use, and other settings.

After you’ve created the custom configuration, you can trigger an event message and use an online tool like webhook.site in place of a webhook listener to see its contents.

Create a custom Connect configuration for testing

Use the following steps to create a simple custom Connect configuration that you can use for testing. For details on each custom configuration option and field, see Create a custom connect configuration.

  1. Log in to your Docusign eSignature developer environment and select Admin.

  2. In the left nav under INTEGRATIONS, select Connect.

  3. Select ADD CONFIGURATION, then Custom. The Add Custom Configuration page opens.

  4. Choose a Name for the configuration.

  5. Choose a URL to Publish. This is the URL where your webhook listener will receive the event messages sent by Connect. For test purposes, you can use a URL from an online webhook test tool to receive and examine Connect events. For example, to get a test URL from an online test tool such as webhook.site, open the tool’s page in the browser and copy your unique test listener URL into the Connect URL to Publish field.

    Screenshot of an webhook.site listener URL

  6. Choose a set of triggering events. A Connect event message will be generated whenever a selected triggering condition occurs. For testing purposes, choose Envelope Sent and Envelope Delivered under Envelope and Recipients.

  7. In the Include Data section, select the data to include in the Connect event messages. For testing purposes, select any entry other than Documents (including documents can make the message too large to test using free online listener tools).

  8. For this test configuration, don’t enable any of the security options. Most free online webhook listener test tools won’t be able to view a secured message.

    Note: Configurations that are intended to be used by real apps should implement security. See Validation and security for more information about these options and how to implement them.

  9. Select Add Configuration.

Trigger and examine a test event

Now that you’ve created a basic custom Connect configuration, you can trigger and examine a Connect event by triggering an event that your configuration has set as a trigger event, such as Envelope Signed/Completed.

Send yourself an envelope, open it, sign it, and complete signing. When you finish signing, Connect will send an event message to the URL that you set in the configuration. If you used webhook.site or a similar tool to view the test event, it should display the received event and its contents.

Screenshot of an example message displayed on webhook.site

Video walkthrough

You can see a video walkthrough for the process of setting up a custom configuration and viewing an example Connect message below:

Next steps