Integrations

Check an integration's connection

Changed on

Checks whether the installation can currently reach its provider. A failed check is a successful response with ok false.

post/integrations/installations/{id}/health-check

Request

  • Base URL: /v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /v1/integrations/installations/{id}/health-check
  • Auth: one of:
    • app-cookie (defined in the document in a form this page cannot read)
    • HTTP bearer

Path parameters

idstring required

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

Example response

{
  "$schema": "/v1/schemas/CheckIntegrationHealthResponseBody.json"
}

Changes

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      endpoint added