curl --request POST \
--url https://qubesync.com/api/v2/connections/{connection_id}/workflow-runs/{run_id}/decisions \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"choice": "use:1"
}
'{
"data": {
"cancel_reason": "<string>",
"connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"current_state": "create_customer / resolve_conflict.find_holder",
"error": {
"code": 3100,
"hint": "<string>",
"message": "<string>",
"quickbooks_message": "<string>",
"type": "name_in_use"
},
"headline": "Created Riverbend Electric in QuickBooks.",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"input": {},
"links": {
"cancel": "<string>",
"decisions": "<string>",
"search": "<string>",
"self": "<string>",
"ui": "<string>"
},
"outcome": "<string>",
"output": {},
"prompt": {
"choices": [
{
"description": "Try the add again under a name you choose.",
"detail": "Customer · similar name",
"fields": [
{
"label": "New name",
"name": "name",
"required": true,
"type": "string",
"columns": [
{
"enum": [
{
"label": "Service",
"value": "item_service"
}
],
"kind": "account",
"label": "Income account",
"name": "income_account",
"required": true,
"type": "string",
"when": {
"action": [
"create"
]
}
}
],
"enum": [
{
"label": "Service",
"value": "item_service"
}
],
"kind": "customer",
"rows": [
{
"columns": [
"action",
"list_id",
"income_account"
],
"detail": "Item",
"key": "invoice_line_add.0.item_ref",
"kinds": {
"income_account": "account",
"list_id": "item"
},
"label": "Vinyl Banner",
"values": {
"item_type": "item_non_inventory"
}
}
]
}
],
"id": "rename",
"label": "Add it under another name"
}
],
"details": [
{
"label": "Customer",
"value": "Lone Star Supply Co"
}
],
"kind": "decision",
"token": "<string>"
},
"reference": "<string>",
"revision": 2,
"state": "running",
"summary": {
"calls": [
{
"item_index": 123,
"outcome": "<string>",
"state": "create_customer",
"status": "completed",
"workflow": "<string>"
}
],
"changes": [
{
"action": "create",
"kind": "customer",
"full_name": "<string>",
"item": 123,
"list_id": "<string>",
"ref_number": "<string>",
"settled": "found",
"txn_id": "<string>"
}
],
"decisions": [
{
"at": "2023-11-07T05:31:56Z",
"item_index": 123,
"option": "<string>",
"state": "create_customer / try_create",
"workflow": "<string>"
}
],
"discarded": [
{
"item_index": 123,
"items_not_started": 123,
"message": "<string>",
"operation": "<string>",
"queued_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"state": "create_customer / try_create",
"workflow": "<string>"
}
],
"ended_at": "2023-11-07T05:31:56Z",
"matches": [
{
"candidates": 123,
"candidates_total": 123,
"candidates_total_complete": true,
"index": "ready",
"item_index": 123,
"match": "exact",
"state": "<string>",
"workflow": "<string>"
}
],
"notifications": {
"failed": 123,
"sent": 123
},
"requests": [
{
"evidence": "of 2 candidates with reference number \"1044\", one carries the GUID sent (txn_id 2-1), so the add was applied",
"found_by": "look_for_invoice",
"identifiers": {
"full_name": "<string>",
"list_id": "<string>",
"ref_number": "<string>",
"txn_id": "<string>"
},
"item_index": 123,
"operation": "<string>",
"pages": 123,
"role": "prepare",
"settled": "found",
"state": "create_customer / try_create",
"status": "success",
"unconfirmed": true,
"workflow": "<string>"
}
],
"side_effects": [
{
"evidence": "<string>",
"identifiers": {
"full_name": "<string>",
"list_id": "<string>",
"ref_number": "<string>",
"txn_id": "<string>"
},
"item_index": 123,
"operation": "<string>",
"settled": "found",
"state": "create_customer / try_create",
"workflow": "<string>"
}
],
"stopped_at": "create_customer / resolve_conflict.ask_about_customer",
"unconfirmed": [
{
"item_index": 123,
"operation": "<string>",
"state": "add_invoice",
"workflow": "<string>"
}
]
},
"trace": [
{
"at": "2023-11-07T05:31:56Z",
"event": "<string>",
"from": "<string>",
"to": "<string>"
}
],
"vars": {},
"workflow": "<string>"
}
}{
"errors": {
"code": "not_awaiting_input",
"detail": "the run isn't waiting for an answer: already answered, still working, or ended"
}
}{
"errors": "unknown parameter: \"emial\""
}{
"errors": {
"code": "prompt_changed",
"detail": "the run has asked again since; answer the question in its prompt"
}
}{
"errors": {
"code": "invalid_choice",
"detail": "choose one of rename, cancel"
}
}Answer a run that is awaiting input
Answer with the choice the person picked: one of the run’s prompt.choices[].id, and data holding exactly that choice’s fields (none, an empty object, or left out, for a choice without fields). {"choice": "use:1"} picks an item of a list the run offered — its value comes from QuBe Sync, so your app never sends a ListID or TxnID of its own — and a record field is answered with the value the run’s search (links.search) returned. A field the choice doesn’t list, or a value of the wrong type, is a 422 invalid_data naming it, and a missing required one 422 missing_fields.
option still answers too: one of the ids the run’s prompt.options listed, with data carrying whatever that option declared fields for (send choice or option, not both). A question asked by a workflow this one calls (prompt.from) is part of this run, and is answered here the same way. A conflict prompt (prompt.kind is conflict: an update met a record someone changed after the run read it) is answered here too, with one of its two fixed options: {"option": "overwrite"} re-sends the update with the current edit sequence and the fields it sent, {"option": "overwrite", "data": {"params": {...}}} sends those fields instead (a merge worked out from prompt.data: an object of fields the update takes, like prompt.data.sent; one it does not take is refused with a 422, invalid_data, naming the field, and the run keeps waiting), and {"option": "keep"} leaves QuickBooks as it is and carries on with its record.
POST to the run’s links.decisions: while the run is asking, it carries the prompt’s token as ?prompt_token=, so an answer you send again because the first got no response can’t be taken for the run’s next question. token is new every time the run asks, the same question asked again included (a wait in a loop, a workflow called once per item), and an answer naming a question the run is no longer asking is refused with 409 prompt_changed, changing nothing. Building the URL yourself, send the token as prompt_token in the query or the body (the body’s wins); without one, an answer is taken for whatever the run is asking when it arrives.
curl --request POST \
--url https://qubesync.com/api/v2/connections/{connection_id}/workflow-runs/{run_id}/decisions \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"choice": "use:1"
}
'{
"data": {
"cancel_reason": "<string>",
"connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"current_state": "create_customer / resolve_conflict.find_holder",
"error": {
"code": 3100,
"hint": "<string>",
"message": "<string>",
"quickbooks_message": "<string>",
"type": "name_in_use"
},
"headline": "Created Riverbend Electric in QuickBooks.",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"input": {},
"links": {
"cancel": "<string>",
"decisions": "<string>",
"search": "<string>",
"self": "<string>",
"ui": "<string>"
},
"outcome": "<string>",
"output": {},
"prompt": {
"choices": [
{
"description": "Try the add again under a name you choose.",
"detail": "Customer · similar name",
"fields": [
{
"label": "New name",
"name": "name",
"required": true,
"type": "string",
"columns": [
{
"enum": [
{
"label": "Service",
"value": "item_service"
}
],
"kind": "account",
"label": "Income account",
"name": "income_account",
"required": true,
"type": "string",
"when": {
"action": [
"create"
]
}
}
],
"enum": [
{
"label": "Service",
"value": "item_service"
}
],
"kind": "customer",
"rows": [
{
"columns": [
"action",
"list_id",
"income_account"
],
"detail": "Item",
"key": "invoice_line_add.0.item_ref",
"kinds": {
"income_account": "account",
"list_id": "item"
},
"label": "Vinyl Banner",
"values": {
"item_type": "item_non_inventory"
}
}
]
}
],
"id": "rename",
"label": "Add it under another name"
}
],
"details": [
{
"label": "Customer",
"value": "Lone Star Supply Co"
}
],
"kind": "decision",
"token": "<string>"
},
"reference": "<string>",
"revision": 2,
"state": "running",
"summary": {
"calls": [
{
"item_index": 123,
"outcome": "<string>",
"state": "create_customer",
"status": "completed",
"workflow": "<string>"
}
],
"changes": [
{
"action": "create",
"kind": "customer",
"full_name": "<string>",
"item": 123,
"list_id": "<string>",
"ref_number": "<string>",
"settled": "found",
"txn_id": "<string>"
}
],
"decisions": [
{
"at": "2023-11-07T05:31:56Z",
"item_index": 123,
"option": "<string>",
"state": "create_customer / try_create",
"workflow": "<string>"
}
],
"discarded": [
{
"item_index": 123,
"items_not_started": 123,
"message": "<string>",
"operation": "<string>",
"queued_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"state": "create_customer / try_create",
"workflow": "<string>"
}
],
"ended_at": "2023-11-07T05:31:56Z",
"matches": [
{
"candidates": 123,
"candidates_total": 123,
"candidates_total_complete": true,
"index": "ready",
"item_index": 123,
"match": "exact",
"state": "<string>",
"workflow": "<string>"
}
],
"notifications": {
"failed": 123,
"sent": 123
},
"requests": [
{
"evidence": "of 2 candidates with reference number \"1044\", one carries the GUID sent (txn_id 2-1), so the add was applied",
"found_by": "look_for_invoice",
"identifiers": {
"full_name": "<string>",
"list_id": "<string>",
"ref_number": "<string>",
"txn_id": "<string>"
},
"item_index": 123,
"operation": "<string>",
"pages": 123,
"role": "prepare",
"settled": "found",
"state": "create_customer / try_create",
"status": "success",
"unconfirmed": true,
"workflow": "<string>"
}
],
"side_effects": [
{
"evidence": "<string>",
"identifiers": {
"full_name": "<string>",
"list_id": "<string>",
"ref_number": "<string>",
"txn_id": "<string>"
},
"item_index": 123,
"operation": "<string>",
"settled": "found",
"state": "create_customer / try_create",
"workflow": "<string>"
}
],
"stopped_at": "create_customer / resolve_conflict.ask_about_customer",
"unconfirmed": [
{
"item_index": 123,
"operation": "<string>",
"state": "add_invoice",
"workflow": "<string>"
}
]
},
"trace": [
{
"at": "2023-11-07T05:31:56Z",
"event": "<string>",
"from": "<string>",
"to": "<string>"
}
],
"vars": {},
"workflow": "<string>"
}
}{
"errors": {
"code": "not_awaiting_input",
"detail": "the run isn't waiting for an answer: already answered, still working, or ended"
}
}{
"errors": "unknown parameter: \"emial\""
}{
"errors": {
"code": "prompt_changed",
"detail": "the run has asked again since; answer the question in its prompt"
}
}{
"errors": {
"code": "invalid_choice",
"detail": "choose one of rename, cancel"
}
}Authorizations
Use your app's API key as the username, and leave the password blank
Path Parameters
ID of the connection
ID of the workflow run
Query Parameters
The token of the prompt this answers, as links.decisions carries it while the run is asking. Refused with 409 prompt_changed once the run has asked again. A prompt_token in the body wins over this one.
Body
The chosen choice and its fields, or the chosen option and the fields it declared. For a conflict prompt, option is overwrite or keep, and data.params (optional, only with overwrite) is the object of fields to send in place of the ones the update sent; its choices are the same two, without params.
- Option 1
- Option 2
One of prompt.choices[].id: what the person picked. Send this or option.
"rename"
The chosen choice's fields, by name ({"name": "Lone Star Supply Co (2)"}), or the option's; a rows field as an object keyed by each row's key, each an object of the columns that row asks and that apply to it. For a conflict's overwrite by option, optionally params: the fields to send instead.
One of prompt.options[].id: for a conflict prompt, overwrite or keep. Send this or choice.
The token of the prompt this answers (prompt.token on the run or the webhook), when the URL you POST to doesn't already carry it (links.decisions does) or to override the one it carries. When the run has asked again since -- the same question from a loop, or the next item's -- the answer is refused with 409 prompt_changed and nothing changes. Leave it out (or null), with no prompt_token in the query either, to answer whatever the run is asking when it arrives.
Response
The run, advanced
Show child attributes
Show child attributes