External Service Integrations API¶
External Service Integrations are used for configuring external raters.
Note
The following endpoints require admin authentication. See admin authentication for details.
Fetch external service integrations¶
GET /integrations
Request:
Name
Position
Type
Required
Response:
ExternalServiceIntegrationsResponse
ExternalServiceIntegrationsResponse¶
{// RequiredexternalServiceIntegrations : [ExternalServiceIntegrationResponse]}
ExternalServiceIntegrationResponse¶
{// Requiredheaders : map<string,string>name : stringtenantLocator : stringtype : string external_raterurl : string}
Add an external service integration¶
POST /integrations
Request:
Name
Position
Type
Required
request
body
required
Response:
ExternalServiceIntegrationsResponse
ExternalServiceIntegrationAddRequest¶
{// Requiredname : stringurl : string// Optionalheaders : map<string,string>type : string external_rater}
Update an existing external service integration¶
PUT /integrations/{integrationName}
Request:
Name
Position
Type
Required
integrationName
path
string
required
request
body
required
Response:
ExternalServiceIntegrationsResponse
ExternalServiceIntegrationUpdateRequest¶
{// Requiredurl : string// Optionalheaders : map<string,string>}
Remove an existing external service integration¶
DELETE /integrations/{integrationName}
Request:
Name
Position
Type
Required
integrationName
path
string
required
Response:
ExternalServiceIntegrationsResponse