Installations

Installations are activations of your integration by tenants on their sites. It grants you access to the site's various resources and allows you to share data through Core resources.

An integration installation is scoped to a site, in a multi-sites setup you'll need one installation per-site. The same integration can be used for multiple installations.

Managed by Gestal

Installations are created by Gestal upon the request of its customer.

We will then take care of the necessary setup regarding the Gestal software on site, and it is your responsibility to do what is necessary to have your software linked with the installation.

Endpoints

All installations

GET https://api.gestal.cloud/integrator/installations

Installation of a specific integration

The integration's cloud_id must be inserted into the URL to obtain its installations.

GET https://api.gestal.cloud/integrator/:integration_id/installations

The installation object

Attribute	Type	Description
cloud_id	string	Unique identifier for the object.
name	string	The integration name.
url	string	The integration url.
description	string	The integration description
access_key	object	The most recent last_active_at date. Be careful the object can be null.
tenant	object	The tenant related to the site.
site	object	The site where this installation is activated.

Example Response

{
  "cloud_id": "inst_JbB8eEQnk4qy5vp2LN6BzTjpIAR4BJwD",
  "name": "My integration",
  "url": "https://google.com",
  "type": "third_party",
  "description": "Integrate Gestal Cloud with My integration notification service.",
  "access_key": {
    "last_active_at": "2001-01-01T01:01:01.000Z"
  },
  "created_at": "2020-09-30T21:10:00.000Z",
  "updated_at": "2020-09-30T21:10:00.000Z",
  "tenant": {
    "cloud_id": "te_8a2o8SNgPSwRmJIUClddClR6Ecwj0Kvl",
    "name": "Tenant 1"
  },
  "site": {
    "cloud_id": "sit_VbRdHhAiizrPScy3TjNH28Ijfvqd6xGc",
    "name": "Site 1"
  }
}