Integration
The Integration API allows external applications to communicate with ChangeGear for creating or updating entities. For more information on integration, see Integrating with Third Party Issue Tracking Software.
To use these endpoints, add the full URL of the endpoint as a WebHook (or Service Hook) to your external application. Note that there are no body parameters for these requests because this is simply a WebHook; the external application handles populating and formatting the contents of the request.
Tip: The Integration API supports basic authentication. For more information, please see Creating a Request > Headers.
|
Action |
Method |
URL |
Description |
|
POST |
api/integration/{toolid}/{entitytype} |
Creates or updates an item in ChangeGear. |
|
|
POST |
api/integration/jiraproxy/{entitytype} |
Required for Jira. Provides authentication for incoming requests. |
Update Entities
The update hook sends an API call to ChangeGear whenever an item is created or modified in the external application.
Important: For Jira, use the Proxy JIRA Requests endpoint.
Request Information
URL
api/integration/{toolid}/{entitytype}
|
Parameter |
Description |
Type |
Example |
Additional Information |
|
toolid |
The name of the external application. This corresponds to the Type field in the Integration Details dialog. |
String |
TFS |
Required. |
|
entitytype |
The type of application entity to update. |
String |
IncidentRequest |
Required. |
Method
POST
Proxy Jira Requests
Jira does not support sending credentials via WebHooks. As a result, the application must proxy Jira calls through the Login endpoint before it can process incoming requests. This requires some additional configuration.
To configure the Jira proxy:
-
Encode the credentials of the account that you wish to use for the integration. To do this, you will need to take your username and password separated by a colon (e.g. cguser:cgpassword) and encode it using Base64. For more information, see the Headers section under Creating a Request.
-
Log into the server hosting the ChangeGear server.
-
Navigate to the ChangeGear server installation directory and run the EncryptionPwd.exe file (defaults to C:\Program Files (x86)\SunView Software\ChangeGear\Server\EncryptionPwd.exe).
-
In the Password field, enter your Base64 encoded credentials. Repeat this previous step for the Confirm Password field, then click Generate.
-
Copy the contents of the Encrypted Password field. You will need this for later.
-
Log into the server hosting the ChangeGear REST API.
-
Open the REST API's web.config file (defaults to C:\Program Files (x86)\SunView Software\ChangeGear\CGRestAPI\Web.config).
-
In the <appSettings> section, scroll to the line beginning with <!--add key="CGJiraCreds". Uncomment the line by removing the "<!--" and "--" characters.
-
Replace the contents of the value property with the Encrypted Password that you copied earlier. Make sure that your pasted contents are surrounded in double quotes.
-
Save the file, then perform an IIS reset or recycle the CGRestAPI application pool.
Request Information
URL
api/integration/jiraproxy/{entitytype}
|
Parameter |
Description |
Type |
Example |
Additional Information |
|
entitytype |
The type of ChangeGear entity to update. |
String |
IncidentRequest |
Required. |
Method
POST