Installation and initial configuration

Last updated on
27 January 2026

Running into any trouble following this documentation to get your site connected to HotDocs? Feel free to create an issue in the module’s issue queue if the documentation can be improved.

After enabling the Webform HotDocs module, you will need to connect your site with your HotDocs account. You can do so from the Webform module’s third-party settings (found at /admin/structure/webform/config). There, you will be asked to fill in several fields of information from your HotDocs account.

The initial fields are as follows:

  • API base domain: The domain from which API requests should be made. This is likely hotdocsadvance.com if making requests against a production instance of HotDocs, or beta.hotdocsadvance.com if making requests against a beta/staging instance.
  • API version: The version of HotDocs’s REST API that should be targeted. Defaulted to 2; requests may not work in older versions of the HotDocs API.
  • Tenancy moniker: Your organization’s HotDocs tenancy, which should have been provided by HotDocs when setting up your account.

In HotDocs, you will need to create a service principal. Follow HotDocs’s instructions to create a new client, then add a service principal. Then, in Drupal, add the following values to the third-party settings form:

  • Client name: The UniqueName value of the client.
  • Principal name: The Name value of the service principal.
  • Principal password: The password entered when creating the service principal. (If you have the Encrypt module installed on your site, you will have the option to encrypt this value using an encryption profile. If not, you’ll see a warning that the password will be stored in plain text if you export your site’s configuration.)

Below that, you’ll need to enter a workgroup ID. You can find this within your HotDocs account: click on your workgroup, then copy the alphanumeric ID found in the URL.

Lastly, you may adjust the number of days to retain document information. Some of the metadata of a completed HotDocs document is stored in Drupal’s temporary key-value storage for later retrieval, but is only retained in the short term (30 days by default).

Help improve this page

Page status: No known problems

You can: