Skip to main content
POST
/
headless
/
startInstallation
Start Installation
curl --request POST \
  --url https://production.runalloy.com/headless/startInstallation \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --data '{
  "userId": "<string>",
  "integrationId": "<string>",
  "credentialIds": [
    "<string>"
  ],
  "workflowIds": [
    "<string>"
  ]
}'
{
  "data": [
    {
      "workflowId": "65b7005ae9761102a64ddd3b",
      "app": "netsuite",
      "blockId": "3a8a8e50-f0e5-488b-9b7b-53656e93d392",
      "fields": [
        {
          "name": "customerEmail",
          "displayName": "Customer's Email",
          "type": "string",
          "required": true
        }
      ]
    }
  ],
  "installationId": "65b701c2f5ba66db3bc53a68"
}

Headers

Authorization
string
default:bearer YOUR_API_KEY
required
x-api-version
string
default:2025-09
required

The version of the API to use. The current API version is 2025-09.

Body

application/json
userId
string
required

ID of the user that will install your integration

integrationId
string
required

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.

Response

200

data
object[]
installationId
string
Example:

"65b701c2f5ba66db3bc53a68"

I