Check
[POST] .../v1/connectedintegration/check
Checks connected integration. Use this method to ask the external integration service whether a connected integration is currently reachable and valid. The response returns a boolean result from the integration check endpoint; true means the external check completed successfully and false means the external integration reported an unsuccessful check without producing a transport error. The request body is required and connected_integration_id must identify an existing connected integration that supports check operations. The current request user must have integration select access; missing body, missing connected_integration_id, unresolved integration, disabled or unsupported external check, denied access, remote integration errors and database failures are returned as HTTP 200 ErrorResult business errors.
Request Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| connected_integration_id | String | Optional | Connected integration external ID. |
Request Example
{
"connected_integration_id": "c98210addc4f4e1bb50b17a8c1299a37"
}
Response Parameters
| Name | Type | Description |
|---|---|---|
| ok | Boolean | Indicates whether the request completed successfully. |
| result | Boolean | Result object. |
Response Example
{
"ok": true,
"result": true
}