Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

download

Configuring API External Data Fields as an Administrator

To configure API External Data Fields for use, take the following steps:

Important:

The API External Data Fields feature must be enabled by Conga first.

  1. From the Navigation Toolbar, click on the Administrator gear icon and select Additional Forms.
  2. Click on Contract Additional Forms.
  3. Click on the API Endpoint Configuration URL tab.
  4. Enter the Endpoint URL.

    Note: When substituting a variable, you must use a colon (:) followed by your variable. If a colon is needed in your header, use double colons (::).

  5. Click Add Substitution Data.
  6. Enter Field Labels (taken from your Endpoint URL).

    Warning: If you make any changes to the Endpoint URL, any substitutions you entered are cleared.

  7. To add Headers, click Add Headers and fill out the Key and Value field. Click Add Substitution Data to add these values beneath Header Substitutions.
  8. Once you've entered all your values, run a test to ensure that the expected data is returned by clicking Validate URL Endpoint.
  9. Click on the Dynamic Profile tab.
  10. Click Add Field to enter your desired fields. Only text fields are supported, and the API Mapping Key must be filled out.

    Important: When you fill out the API Mapping Key, you must use the following format that is used a path to the proper JSON data: $.[*].examplePath

  11. Go to Administrator gear icon and click Contract Request Types.
  12. Click on the name of the Request Type where you want to add your external data fields.
  13. Click Add Additional Form to add the form with the external data you created to the Request Type.