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

• Response:ExternalServiceIntegrationsResponse

ExternalServiceIntegrationsResponse

{
  // Required
  externalServiceIntegrations : [ExternalServiceIntegrationResponse]
}

ExternalServiceIntegrationResponse

{
  // Required
  headers : map<string,string>
  name : string
  tenantLocator : string
  type : string external_rater
  url : string
}

Add an external service integration

POST /integrations

• Request:

  Name	Position	Type	Required
  request	body	ExternalServiceIntegrationAddRequest	required

• Response:ExternalServiceIntegrationsResponse

ExternalServiceIntegrationAddRequest

{
  // Required
  name : string
  url : string

  // Optional
  headers : 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	ExternalServiceIntegrationUpdateRequest	required

• Response:ExternalServiceIntegrationsResponse

ExternalServiceIntegrationUpdateRequest

{
  // Required
  url : string

  // Optional
  headers : map<string,string>
}

Remove an existing external service integration

DELETE /integrations/{integrationName}

• Request:

  Name	Position	Type	Required
  integrationName	path	string	required

• Response:ExternalServiceIntegrationsResponse