Integrations API
External Service Integrations are used for configuring external raters.
Endpoint Index
| Action | Endpoint |
|---|---|
| Fetch external service integrations | GET /integrations |
| Add an external service integration | POST /integrations |
| Update an existing external service integration | PUT /integrations/{integrationName} |
| Remove an existing external service integration | DELETE /integrations/{integrationName} |
Details
Note
The following endpoints require admin authentication. See admin authentication for details.
Fetch external service integrations¶
GET /integrationsResponse:
ExternalServiceIntegrationsResponseExternalServiceIntegrationsResponse¶
requiredexternalServiceIntegrations [ExternalServiceIntegrationResponse]
ExternalServiceIntegrationResponse¶
requiredname stringheaders map<string,string>tenantLocator stringtype string external_raterurl string
Add an external service integration¶
POST /integrationsRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| request | body | ExternalServiceIntegrationAddRequest | required |
Response:
ExternalServiceIntegrationsResponseExternalServiceIntegrationAddRequest¶
requiredname stringurl stringoptionalheaders 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:
ExternalServiceIntegrationsResponseExternalServiceIntegrationUpdateRequest¶
requiredurl stringoptionalheaders map<string,string>
Remove an existing external service integration¶
DELETE /integrations/{integrationName}Request:
| Name | Position | Type | Required |
|---|---|---|---|
| integrationName | path | string | required |
Response:
ExternalServiceIntegrationsResponse