Create a new installation

Authorizations

X-Api-Key

string

header

required

Path Parameters

projectIdOrName

string

required

integrationId

string

required

Body

application/json

config

object

required

The config of the installation.

groupRef

string

required

The ID of the user group that has access to this installation.

connectionId

string

The ID of the SaaS connection tied to this installation. If omitted the default connection for this group will be used.

Response

201 - application/json

config

object

required

connection

object

required

connection.authScheme

enum<string>

required

The authentication scheme used for this connection.

Available options:

none,

apiKey,

basic,

oauth2/authorizationCode,

oauth2/authorizationCodePKCE,

oauth2/clientCredentials,

oauth2/password

connection.consumer

object

required

connection.createTime

string

required

The time the connection was created.

connection.group

object

required

connection.id

string

required

The connection ID.

connection.projectId

string

required

The Ampersand project ID.

connection.provider

string

required

The SaaS provider that this Connection is for.

connection.status

enum<string>

required

The status of the connection.

Available options:

created,

working,

bad_credentials

connection.oauth2AuthorizationCode

object

connection.providerApp

object

connection.providerConsumerRef

string

If available, the ID that Salesforce/Hubspot uses to identify this user (e.g. Salesforce has IDs in the form of https://login.salesforce.com/id/00D4x0000019CQTEA2/0054x000000orJ4AA)

connection.providerWorkspaceRef

string

If available, the identifier for the provider workspace (e.g. "salesforce-instance-domain")

connection.updateTime

string

The time the connection was last updated.

createdBy

string

required

The person who did the installation, in the format of "consumer:{consumer-id}".

createTime

string

required

The time the integration was first installed.

healthStatus

string

required

The health status of the installation ("healthy", "unhealthy").

string

required

The installation ID.

integrationId

string

required

The integration ID.

projectId

string

required

The Ampersand project ID.

group

object

updateTime

string

The time the installation was last updated with a new config.