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
ExternalServiceIntegrationsResponse
required
externalServiceIntegrations[ExternalServiceIntegrationResponse]
ExternalServiceIntegrationResponse
required
headersmap<string,string>
namestring
tenantLocatorstring
typestring external_rater
urlstring
Add an external service integration
POST /integrations
ExternalServiceIntegrationAddRequest
required
namestring
urlstring

optional
headersmap<string,string>
typestring external_rater
Update an existing external service integration
PUT /integrations/{integrationName}
ExternalServiceIntegrationUpdateRequest
required
urlstring

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