Connections are generic tools to setup custom integrations between Planhat and other sources. The Connection stores the authentication credentials, a user-defined list of endpoints, along with custom requests which can be called upon by an Automation using the Connection for a custom integration.

Authentication Methods

The supported authentication methods are API Token, Basic, and oauth2.0. For each method, the Connection will require additional data to complete authentication.

Endpoints and Requests

In the setup of the Connection, you provide a Base URL. In addition to this, you add endpoints, along with specific request methods and bodies you would like to use.

For example, if integrating with Docusign, you might have the following base URL: https://demo.docusign.net. Then, if one of the steps in your integration is to create an envelope in Docusign, you would add an endpoint with:

• URL path: /restapi/v2.1/accounts/\[\[account\]\]/envelopes

• HTTP method: POST

• Content type: application/json

Then, under body, you could add something like:

{
  "status": "sent",
  "emailSubject": "Please sign the SaaS agreement",
  "templateId": "40dd0b9c-48c9-4626-a978-dd2c7f65c9c8",
  "templateRoles": [
    {
      "email": "[[email]]",
      "name": "[[name]]",
      "roleName": "Signer",
      "tabs": {
        "textTabs": [
          {
            "tabLabel": "providerName",
            "value": "[[Provider Name]]."
          },
          {
            "tabLabel": "customerName",
            "value": "[[Customer Name]]"
          },
          {
            "tabLabel": "signerName",
            "value": "[[name]]"
          }
        ]
      }
    }
  ]
}

The double [[square brackets]] above represent dynamic fields which you define in the Automation you use to set up this custom integration - for example, you would need to define in the automation where we are getting [[Customer Name]] (e.g. from a previous request to Docusign, or from Planhat’s existing data).

Once you setup the Automation and plug in the above Connection, you would have a working integration that creates envelopes in Docusign based on an existing template, and all that remains is configuring details such as how to trigger the integration.