Integrations API

External Service Integrations are used for configuring external raters.

Endpoint Index

ActionEndpoint
Fetch external service integrationsGET /integrations
Add an external service integrationPOST /integrations
Update an existing external service integrationPUT /integrations/{integrationName}
Remove an existing external service integrationDELETE /integrations/{integrationName}

Details

Note

The following endpoints require admin authentication. See admin authentication for details.

Fetch external service integrations
GET /integrations
ExternalServiceIntegrationsResponse
required
externalServiceIntegrations [ExternalServiceIntegrationResponse]
ExternalServiceIntegrationResponse
required
name string
headers map<string,string>
tenantLocator string
type string external_rater
url string
Add an external service integration
POST /integrations
ExternalServiceIntegrationAddRequest
required
name string
url string

optional
headers map<string,string>
type string external_rater
Update an existing external service integration
PUT /integrations/{integrationName}
ExternalServiceIntegrationUpdateRequest
required
url string

optional
headers map<string,string>
Remove an existing external service integration
DELETE /integrations/{integrationName}