curl --request POST \
--url https://qubesync.com/api/v2/connections/{connection_id}/name-index \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"webhook_url": "https://your-app.example/webhooks/qube"
}
'import requests
url = "https://qubesync.com/api/v2/connections/{connection_id}/name-index"
payload = { "webhook_url": "https://your-app.example/webhooks/qube" }
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({webhook_url: 'https://your-app.example/webhooks/qube'})
};
fetch('https://qubesync.com/api/v2/connections/{connection_id}/name-index', 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/connections/{connection_id}/name-index",
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([
'webhook_url' => 'https://your-app.example/webhooks/qube'
]),
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/connections/{connection_id}/name-index"
payload := strings.NewReader("{\n \"webhook_url\": \"https://your-app.example/webhooks/qube\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://qubesync.com/api/v2/connections/{connection_id}/name-index")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"webhook_url\": \"https://your-app.example/webhooks/qube\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://qubesync.com/api/v2/connections/{connection_id}/name-index")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"webhook_url\": \"https://your-app.example/webhooks/qube\"\n}"
response = http.request(request)
puts response.read_body{
"name_index": {
"as_of": "2026-10-11T14:02:10Z",
"records": 1240,
"state": "ready"
}
}Opt in to matching
Has QuBe Sync build the connection’s name index now, so it’s ready before your first match, and tells you when it is. QuBe Sync reads the names in the connection’s lists from QuickBooks itself, a step at a time, as the Web Connector checks in, and your own requests always go first. That takes a few Web Connector sessions, more on a large company file.
While it builds the answer is 202. Pass a webhook_url to be sent name_index.ready once it’s in, or name_index.failed if the build gives up (see the callback). Calling this again while it builds replaces the webhook_url, and starts nothing more. On an index that’s already ready the answer is 200, and nothing is sent. So it’s safe to repeat, and takes no Idempotency-Key.
Only realtime and simulated connections can have an index (422 matching_requires_realtime). An index is kept current while it was used in the last 7 days, and deleted after 30 days unused: a match counts as a use, and so does this.
curl --request POST \
--url https://qubesync.com/api/v2/connections/{connection_id}/name-index \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"webhook_url": "https://your-app.example/webhooks/qube"
}
'import requests
url = "https://qubesync.com/api/v2/connections/{connection_id}/name-index"
payload = { "webhook_url": "https://your-app.example/webhooks/qube" }
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({webhook_url: 'https://your-app.example/webhooks/qube'})
};
fetch('https://qubesync.com/api/v2/connections/{connection_id}/name-index', 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/connections/{connection_id}/name-index",
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([
'webhook_url' => 'https://your-app.example/webhooks/qube'
]),
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/connections/{connection_id}/name-index"
payload := strings.NewReader("{\n \"webhook_url\": \"https://your-app.example/webhooks/qube\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://qubesync.com/api/v2/connections/{connection_id}/name-index")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"webhook_url\": \"https://your-app.example/webhooks/qube\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://qubesync.com/api/v2/connections/{connection_id}/name-index")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"webhook_url\": \"https://your-app.example/webhooks/qube\"\n}"
response = http.request(request)
puts response.read_body{
"name_index": {
"as_of": "2026-10-11T14:02:10Z",
"records": 1240,
"state": "ready"
}
}Authorizations
Use your app's API key as the username, and leave the password blank
Path Parameters
The connection to act on.
Body
Where to send name_index.ready or name_index.failed when the build ends. It must be an absolute http or https URL. It may not contain a username or password, and in production it may not point at localhost or a private, loopback or link-local address. A qube listen URL must be one of this app's.
2048"https://your-app.example/webhooks/qube"
Callbacks
POST{$request.body#/webhook_url}name_index
Body
The body QuBe Sync POSTs to the webhook_url an opt-in gave (POST /connections/{connection_id}/name-index), signed with X-QUBE-Signature like every other QuBe Sync webhook, once the build it was waiting for ends. It says where the index stands, never what's in it.
name_index.ready: every list is in, and matches are answered. name_index.failed: the build gave up, after QuickBooks' answers to one step were lost three times in a row (the session ended, or the Web Connector reported an error). Matching is refused while the index is building; QuBe Sync starts the build again a day later while the connection is matching, or at the next match or opt-in.
name_index.ready, name_index.failed QuBe Sync's index of the names in this connection's company file, for finding records by name (see Match a name): customers, vendors, employees and other names, items, accounts, classes, and the other lists a transaction names (terms, sales tax codes, payment and ship methods, price levels, customer, vendor and job types, sales reps and customer messages). Only realtime and simulated connections can have one, and it is built the first time something on the connection needs matching: a match, or opting in (POST /connections/{connection_id}/name-index). QuBe Sync then reads the lists from QuickBooks itself, a step at a time, and your requests always go first; those reads never appear among your requests and never send a webhook. An index unused for 30 days is deleted, and built again the next time it's needed.
Show child attributes
Show child attributes
Unix seconds; also the t= in the signature header.
Response
Received. Anything else is retried with backoff for about 8 hours; after the last attempt, your organization's owners are emailed.
Response
The index is ready: match away. Nothing is sent to webhook_url.
QuBe Sync's index of the names in this connection's company file, for finding records by name (see Match a name): customers, vendors, employees and other names, items, accounts, classes, and the other lists a transaction names (terms, sales tax codes, payment and ship methods, price levels, customer, vendor and job types, sales reps and customer messages). Only realtime and simulated connections can have one, and it is built the first time something on the connection needs matching: a match, or opting in (POST /connections/{connection_id}/name-index). QuBe Sync then reads the lists from QuickBooks itself, a step at a time, and your requests always go first; those reads never appear among your requests and never send a webhook. An index unused for 30 days is deleted, and built again the next time it's needed.
Show child attributes
Show child attributes