App Installations

The installations endpoint allows you to integrate your applications state object to the vivenu application and update the integration user on the current status of the application.

Base URL: https://apps.vivenu.com/api

You can retrieve the id of an installation via the metadata API

Caution: In order to access this API you have to include the application's clientSecret inside the authorization header of your request.

Endpoints

Patch App installation

Updating the status

The user needs information about whether the integration set up is working as expected. With this endpoint you can set your application to LIVE, INTERRUPTED or FAILED, which helps the user to determine if they have set everything up correctly.

Example payload to update operation status

{
    "status": {
        "operation": "LIVE"
    }
}

Utilizing the state

The state can be used to integrate your application with the vivenu backend. For each API key that gets created for you, a state object is available to store additional information about that installation. For example, you could store an application_id needed for execution in the state object and check it when you need to run the application.

Example payload to utilize state

{
    "state": {
        "application_id": "ff926843-9e33-4b7a-9548-517695c34cec"
    }
}

Payload

Optional Attributes

Collapse all

status

Optional

object

Optional Attributes

Collapse all

status.installation

Optional

string

The target status of the app installation

INITIALIZEDCONFIGURED

status.operation

Optional

string

The target operational status of the app

LIVEINTERRUPTEDFAILEDPENDING

state

Optional

object

An object containing any state information about this installation

200

Success

Was this section helpful?

Yes No

{
  "status": {
    "installation": "INITIALIZED",
    "operation": "LIVE"
  },
  "state": {}
}

{
  "_id": "string",
  "status": {
    "installation": "INITIALIZED",
    "operation": "LIVE"
  },
  "appId": "string",
  "sellerId": "string",
  "apiKey": "string",
  "state": {},
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Get App installation

Returns an app installation for a given installationId if existent. This endpoint is typically invoked when you want to get the state or status of an app installation.

Query

No supported query parameters

200

Success

Was this section helpful?

Yes No

{
  "_id": "string",
  "status": {
    "installation": "INITIALIZED",
    "operation": "LIVE"
  },
  "appId": "string",
  "sellerId": "string",
  "apiKey": "string",
  "state": {},
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Get all app installations

Query

top

Optional

number float

skip

Optional

number float

installationStatus

Optional

string

INITIALIZEDCONFIGURED

operationStatus

Optional

string

LIVEINTERRUPTEDFAILEDPENDING

client_id

Required

string

The client id of the app

200

Success

Was this section helpful?

Yes No

{
  "_id": "string",
  "status": {
    "installation": "INITIALIZED",
    "operation": "LIVE"
  },
  "appId": "string",
  "sellerId": "string",
  "apiKey": "string",
  "state": {},
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}