Start Installation

POST 
/headless/startInstallation

This endpoint will create an installation record and return the information required to create a form for your user to fill out.

Request

application/json

Body

userId stringrequired

ID of the user that will install your integration

integrationId stringrequired

ID of the integration which is being installed

credentialIds string[]

List of credentials to be used in this installation. If the user has authorized any of the apps in the integration more than once, then this field is required. Otherwise, the user's credentials will be automatically detected.

workflowIds string[]

A list of workflows to include in this installation, if only a subset is desired. If every workflow in the integration will be installed, this field is optional.

Responses

200

200

application/json

Schema

Schema

data

object[]

Array [

workflowId string

app string

blockId string

fields

object[]

Array [

name string

displayName string

type string

required boolean

Default value: true

]

]

installationId string

Example (from schema)

{
  "data": [
    {
      "workflowId": "65b7005ae9761102a64ddd3b",
      "app": "netsuite",
      "blockId": "3a8a8e50-f0e5-488b-9b7b-53656e93d392",
      "fields": [
        {
          "name": "customerEmail",
          "displayName": "Customer's Email",
          "type": "string",
          "required": true
        }
      ]
    }
  ],
  "installationId": "65b701c2f5ba66db3bc53a68"
}

Result

{
    "data": [
        {
            "workflowId": "65b7005ae9761102a64ddd3b",
            "app": "netsuite",
            "blockId": "3a8a8e50-f0e5-488b-9b7b-53656e93d392",
            "fields": [
                {
                    "name": "customerEmail",
                    "displayName": "Customer's Email",
                    "type": "string",
                    "required": true
                }
            ]
        }
    ],
    "installationId": "65b701c2f5ba66db3bc53a68"
}

400

400

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "User is not authorized to install integrations for this account"
}

Result

{"message":"User is not authorized to install integrations for this account"}

Loading...