Skip to main content
Conga Support

Managing API Settings

The Application Programming Interface (API) settings allow the System Administrator to monitor the new companies, contracts, and projects that users enter in the Novatus system, as well as any updates they make to the Company, Contract, and Project Profiles. This monitoring occurs via individual web hooks, which Administrators can set up to automatically "call back" information that users attempt to save to the Novatus system, while informing users via system messages that their new or updated data has not been saved. Web hooks can be set up to monitor data that has been entered before or after a user adds or updates company, contract, or project data.

image676.png

A

Navigation Toolbar

Click on Admin to display a menu, and select System Settings to display the System Settings screen.

Note: If the System Settings link is not present, you do not have permission to change the system settings in Novatus Contracts.

B

API Settings tab

Click on the tab to display the API Settings screen.

C

Default Media Type list

Select application/xml or application/json to identify your company's REST API.

D

Default Secret field

Enter the password for your REST API.

E

Default URL

Enter the URL for your REST API.

F

New button

Click to set up a new web hook record.

G

Hook Type list

Make a selection in the list to set up the first type of web hook you want to create. The options are Before/After Company Save, Before/After Contract Save, and Before/After Project Save.

H

URL field

Click in the field to enable it, and enter the URL for the web hook. This is typically the URL located on your company's intranet.

I

Media Type list

Select Use default if you want to use the media type you selected for the API (Step C). Otherwise, select application/xml or application/json to identify the media type for the web hook.

J

Secret field

Click in the field to enable it, and enter the password for the web hook.

Repeat Steps F-J to add additional web hooks.

K

Delete icon

If you want to delete a web hook record, click on its icon.

L

Save button

Click to save the API settings.

  • Was this article helpful?