Custom Webhooks

DocumentTRAK notifications integrate with various CRM systems that can update and send notifications to systems configured through the Notification Administration. However, in some cases you may be using a CRM system that does not match any of the options available. In this case, you can set up notifications through the Custom Webhook option.

This section provides an overview of Custom Webhooks and what information needs to be filled out when creating a new Custom Webhook.

When do you use a Custom Webhook?

A Custom Webhook is used when you are using a system that can receive notifications, but does not meet the any of the options available in the Notification Administration. Custom Webhooks are a powerful tool that allows you to customize your webhooks to match the needs of your document signing workflow.

Use the following steps to add a custom webhook to the Notification Administration:

  1. In the Notification Administration, click Add Webhook.

  2. In the new pop-up window, click Custom.

  3. In the General Information fill out the necessary information:

    • Webhook Name - The name of the webhook. For example, if creating a webhook that updates the Document Complete status, this webhook could be called Document Complete Status.

    • Endpoint URL - The endpoint that the webhook touches in order to update whatever field that is required. Fields can be added to this URL by clicking the Merge Field button, and adding the field to the necessary spot in the URL.

    • Method Type - The method by which the webhook request is going to interact with the Endpoint URL. In most cases the Post method type is used.

    • Failure Notification - If the webhook fails to update the field or interact with the Endpoint URL a failure URL can be sent to an email address to notify that user an error has occurred.

  4. In the Authentication screen, select what type of authentication to use. The option selected here is going to be determined by the third-party tool being used, and how authentication happens. If None is selected, that means the Endpoint URL is an open URL and does not require authentication to receive the webhook request.

  5. In the Headers screen, add in the headers that are needed. To add in a header, select the + button.

  6. In the Request Body screen, the actual request the webhook is making needs to be added to this page. What this request looks like is going to depend on the fields and method type selected.

  7. Once finished setting any validation or testing necessary, click the Finish button.