Create or replace a workflow
curl --request PUT \
--url https://qubesync.com/api/v2/workflows/{key} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"definition": {
"initial": "<string>",
"states": {},
"version": 1,
"description": "<string>",
"headline": "<string>",
"input": {},
"key": "<string>",
"name": "<string>",
"on": {},
"outcomes": {},
"output": "<unknown>",
"ui": {}
},
"description": "<string>",
"name": "<string>",
"notes": "<string>",
"publish": true
}
'import requests
url = "https://qubesync.com/api/v2/workflows/{key}"
payload = {
"definition": {
"initial": "<string>",
"states": {},
"version": 1,
"description": "<string>",
"headline": "<string>",
"input": {},
"key": "<string>",
"name": "<string>",
"on": {},
"outcomes": {},
"output": "<unknown>",
"ui": {}
},
"description": "<string>",
"name": "<string>",
"notes": "<string>",
"publish": True
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
definition: {
initial: '<string>',
states: {},
version: 1,
description: '<string>',
headline: '<string>',
input: {},
key: '<string>',
name: '<string>',
on: {},
outcomes: {},
output: '<unknown>',
ui: {}
},
description: '<string>',
name: '<string>',
notes: '<string>',
publish: true
})
};
fetch('https://qubesync.com/api/v2/workflows/{key}', 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://qubesync.com/api/v2/workflows/{key}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'definition' => [
'initial' => '<string>',
'states' => [
],
'version' => 1,
'description' => '<string>',
'headline' => '<string>',
'input' => [
],
'key' => '<string>',
'name' => '<string>',
'on' => [
],
'outcomes' => [
],
'output' => '<unknown>',
'ui' => [
]
],
'description' => '<string>',
'name' => '<string>',
'notes' => '<string>',
'publish' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$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://qubesync.com/api/v2/workflows/{key}"
payload := strings.NewReader("{\n \"definition\": {\n \"initial\": \"<string>\",\n \"states\": {},\n \"version\": 1,\n \"description\": \"<string>\",\n \"headline\": \"<string>\",\n \"input\": {},\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"on\": {},\n \"outcomes\": {},\n \"output\": \"<unknown>\",\n \"ui\": {}\n },\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"publish\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.put("https://qubesync.com/api/v2/workflows/{key}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"definition\": {\n \"initial\": \"<string>\",\n \"states\": {},\n \"version\": 1,\n \"description\": \"<string>\",\n \"headline\": \"<string>\",\n \"input\": {},\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"on\": {},\n \"outcomes\": {},\n \"output\": \"<unknown>\",\n \"ui\": {}\n },\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"publish\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://qubesync.com/api/v2/workflows/{key}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"definition\": {\n \"initial\": \"<string>\",\n \"states\": {},\n \"version\": 1,\n \"description\": \"<string>\",\n \"headline\": \"<string>\",\n \"input\": {},\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"on\": {},\n \"outcomes\": {},\n \"output\": \"<unknown>\",\n \"ui\": {}\n },\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"publish\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"description": "<string>",
"key": "<string>",
"links": {},
"name": "<string>",
"promoted_from": {},
"published_version": 123,
"state": "draft",
"template": {
"key": "<string>",
"status": "up_to_date"
},
"updated_at": "2023-11-07T05:31:56Z",
"working_copy_changed": true,
"definition": {
"initial": "<string>",
"states": {},
"version": 1,
"description": "<string>",
"headline": "<string>",
"input": {},
"key": "<string>",
"name": "<string>",
"on": {},
"outcomes": {},
"output": "<unknown>",
"ui": {}
},
"example_input": {},
"input_schema": {},
"references": [
"<string>"
]
}
}{
"data": {
"description": "<string>",
"key": "<string>",
"links": {},
"name": "<string>",
"promoted_from": {},
"published_version": 123,
"state": "draft",
"template": {
"key": "<string>",
"status": "up_to_date"
},
"updated_at": "2023-11-07T05:31:56Z",
"working_copy_changed": true,
"definition": {
"initial": "<string>",
"states": {},
"version": 1,
"description": "<string>",
"headline": "<string>",
"input": {},
"key": "<string>",
"name": "<string>",
"on": {},
"outcomes": {},
"output": "<unknown>",
"ui": {}
},
"example_input": {},
"input_schema": {},
"references": [
"<string>"
]
}
}{
"errors": [
{
"message": "unknown target \"bar\"",
"path": "states.resolve_conflict.states.ask.on.rename.0.target"
}
]
}Workflows
Create or replace a workflow
Upserts by key, so a chart kept in version control can be pushed from a deploy script. An invalid chart is refused with every problem listed at once. Only the working copy changes unless publish is given.
PUT
/
workflows
/
{key}
Create or replace a workflow
curl --request PUT \
--url https://qubesync.com/api/v2/workflows/{key} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"definition": {
"initial": "<string>",
"states": {},
"version": 1,
"description": "<string>",
"headline": "<string>",
"input": {},
"key": "<string>",
"name": "<string>",
"on": {},
"outcomes": {},
"output": "<unknown>",
"ui": {}
},
"description": "<string>",
"name": "<string>",
"notes": "<string>",
"publish": true
}
'import requests
url = "https://qubesync.com/api/v2/workflows/{key}"
payload = {
"definition": {
"initial": "<string>",
"states": {},
"version": 1,
"description": "<string>",
"headline": "<string>",
"input": {},
"key": "<string>",
"name": "<string>",
"on": {},
"outcomes": {},
"output": "<unknown>",
"ui": {}
},
"description": "<string>",
"name": "<string>",
"notes": "<string>",
"publish": True
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
definition: {
initial: '<string>',
states: {},
version: 1,
description: '<string>',
headline: '<string>',
input: {},
key: '<string>',
name: '<string>',
on: {},
outcomes: {},
output: '<unknown>',
ui: {}
},
description: '<string>',
name: '<string>',
notes: '<string>',
publish: true
})
};
fetch('https://qubesync.com/api/v2/workflows/{key}', 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://qubesync.com/api/v2/workflows/{key}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'definition' => [
'initial' => '<string>',
'states' => [
],
'version' => 1,
'description' => '<string>',
'headline' => '<string>',
'input' => [
],
'key' => '<string>',
'name' => '<string>',
'on' => [
],
'outcomes' => [
],
'output' => '<unknown>',
'ui' => [
]
],
'description' => '<string>',
'name' => '<string>',
'notes' => '<string>',
'publish' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$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://qubesync.com/api/v2/workflows/{key}"
payload := strings.NewReader("{\n \"definition\": {\n \"initial\": \"<string>\",\n \"states\": {},\n \"version\": 1,\n \"description\": \"<string>\",\n \"headline\": \"<string>\",\n \"input\": {},\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"on\": {},\n \"outcomes\": {},\n \"output\": \"<unknown>\",\n \"ui\": {}\n },\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"publish\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.put("https://qubesync.com/api/v2/workflows/{key}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"definition\": {\n \"initial\": \"<string>\",\n \"states\": {},\n \"version\": 1,\n \"description\": \"<string>\",\n \"headline\": \"<string>\",\n \"input\": {},\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"on\": {},\n \"outcomes\": {},\n \"output\": \"<unknown>\",\n \"ui\": {}\n },\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"publish\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://qubesync.com/api/v2/workflows/{key}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"definition\": {\n \"initial\": \"<string>\",\n \"states\": {},\n \"version\": 1,\n \"description\": \"<string>\",\n \"headline\": \"<string>\",\n \"input\": {},\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"on\": {},\n \"outcomes\": {},\n \"output\": \"<unknown>\",\n \"ui\": {}\n },\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"publish\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"description": "<string>",
"key": "<string>",
"links": {},
"name": "<string>",
"promoted_from": {},
"published_version": 123,
"state": "draft",
"template": {
"key": "<string>",
"status": "up_to_date"
},
"updated_at": "2023-11-07T05:31:56Z",
"working_copy_changed": true,
"definition": {
"initial": "<string>",
"states": {},
"version": 1,
"description": "<string>",
"headline": "<string>",
"input": {},
"key": "<string>",
"name": "<string>",
"on": {},
"outcomes": {},
"output": "<unknown>",
"ui": {}
},
"example_input": {},
"input_schema": {},
"references": [
"<string>"
]
}
}{
"data": {
"description": "<string>",
"key": "<string>",
"links": {},
"name": "<string>",
"promoted_from": {},
"published_version": 123,
"state": "draft",
"template": {
"key": "<string>",
"status": "up_to_date"
},
"updated_at": "2023-11-07T05:31:56Z",
"working_copy_changed": true,
"definition": {
"initial": "<string>",
"states": {},
"version": 1,
"description": "<string>",
"headline": "<string>",
"input": {},
"key": "<string>",
"name": "<string>",
"on": {},
"outcomes": {},
"output": "<unknown>",
"ui": {}
},
"example_input": {},
"input_schema": {},
"references": [
"<string>"
]
}
}{
"errors": [
{
"message": "unknown target \"bar\"",
"path": "states.resolve_conflict.states.ask.on.rename.0.target"
}
]
}Authorizations
Use your app's API key as the username, and leave the password blank
Path Parameters
The workflow's stable key
Pattern:
^[a-z][a-z0-9_]{0,63}$Body
application/json
A workflow is one JSON document: a Harel statechart whose states queue QuickBooks requests, pause for a decision from the calling app, or transform data. Qube.Workflows.Chart.validate/1 is the source of truth; this schema is documentation and a first-pass check. A run takes at most 500 transitions, then fails with fault transition_limit: a paginating loop costs about two per page, so about 250 pages a run.
Show child attributes
Show child attributes
A note recorded in the history beside the version publish: true creates. Ignored without it.
true publishes the working copy as the next version in the same call; false unpublishes. Without it, only the working copy changes.
Response
The workflow was replaced
Show child attributes
Show child attributes