Skip to main content
POST
/
workflows
/
install
Install workflows
curl --request POST \
  --url https://production.runalloy.com/workflows/install \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --data '
{
  "workflowIds": [
    "<string>"
  ],
  "credentialIds": [
    "<string>"
  ],
  "userId": "<string>"
}
'
import requests

url = "https://production.runalloy.com/workflows/install"

payload = {
"workflowIds": ["<string>"],
"credentialIds": ["<string>"],
"userId": "<string>"
}
headers = {
"Authorization": "<authorization>",
"x-api-version": "<x-api-version>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {
Authorization: '<authorization>',
'x-api-version': '<x-api-version>',
'Content-Type': 'application/json'
},
body: JSON.stringify({workflowIds: ['<string>'], credentialIds: ['<string>'], userId: '<string>'})
};

fetch('https://production.runalloy.com/workflows/install', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://production.runalloy.com/workflows/install",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'workflowIds' => [
'<string>'
],
'credentialIds' => [
'<string>'
],
'userId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json",
"x-api-version: <x-api-version>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://production.runalloy.com/workflows/install"

payload := strings.NewReader("{\n \"workflowIds\": [\n \"<string>\"\n ],\n \"credentialIds\": [\n \"<string>\"\n ],\n \"userId\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "<authorization>")
req.Header.Add("x-api-version", "<x-api-version>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://production.runalloy.com/workflows/install")
.header("Authorization", "<authorization>")
.header("x-api-version", "<x-api-version>")
.header("Content-Type", "application/json")
.body("{\n \"workflowIds\": [\n \"<string>\"\n ],\n \"credentialIds\": [\n \"<string>\"\n ],\n \"userId\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://production.runalloy.com/workflows/install")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["x-api-version"] = '<x-api-version>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workflowIds\": [\n \"<string>\"\n ],\n \"credentialIds\": [\n \"<string>\"\n ],\n \"userId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "installed": true
}
{
"message": "Could not install workflow(s)"
}

Headers

Authorization
string
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
workflowIds
string[]
required
credentialIds
string[]
required
userId
string
required

Response

200

installed
boolean
default:true
Example:

true