Connect an Integration

POST

integration-connections

Connect (or replace) a tax/CRM/storage integration

curl --request POST \
  --url https://billing.example.com/v1/integration-connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider": "<string>",
  "config": {}
}
'

import requests

url = "https://billing.example.com/v1/integration-connections"

payload = {
    "provider": "<string>",
    "config": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({provider: '<string>', config: {}})
};

fetch('https://billing.example.com/v1/integration-connections', 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://billing.example.com/v1/integration-connections",
  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([
    'provider' => '<string>',
    'config' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://billing.example.com/v1/integration-connections"

	payload := strings.NewReader("{\n  \"provider\": \"<string>\",\n  \"config\": {}\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://billing.example.com/v1/integration-connections")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"provider\": \"<string>\",\n  \"config\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://billing.example.com/v1/integration-connections")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"provider\": \"<string>\",\n  \"config\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "category": "tax",
    "provider": "<string>",
    "config": {},
    "has_secrets": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "validation_failed",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "validation_failed",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "validation_failed",
    "message": "<string>"
  }
}

Stores the workspace’s own credentials for one tax, CRM, or storage provider. The config is sealed as a single encrypted blob; secrets are write-only and never returned. Each call inserts a new connection row with a fresh id and deactivates every active connection in the same category first — not only the same provider. A workspace therefore has at most one active provider per category: connecting ziptax disconnects an active taxjar or avalara, and reconnecting the same provider to rotate credentials returns a new id with created_at equal to updated_at. Do not persist a connection id and expect it to survive a reconnect; the deactivated rows are kept but never listed. Owner/admin only — API-key callers are not role-gated. Check vault_ready on List Integration Connections first; once a HubSpot connection exists, verify it with Sync CRM Now.

Request Body

Parameter	Type	Required	Description
`category`	string	Yes	`tax`, `crm`, or `storage`
`provider`	string	Yes	Must match the category: `tax` → `taxjar`, `avalara`, `ziptax`; `crm` → `hubspot`; `storage` → `s3`
`config`	object (string → string)	Yes	Provider config. Values are trimmed. Required keys per provider: `taxjar` and `ziptax` need `api_key`; `avalara` needs `account_id`, `license_key`, `company_code`; `hubspot` needs `access_token`; `s3` needs `bucket`, `region`, `access_key_id`, `secret_access_key`, plus an optional `endpoint` for S3-compatible stores such as MinIO

Any endpoint, api_url, or base_url value is validated before storage. It must always parse as an http or https URL. On the hosted (multi-tenant) deployment it must additionally use https and its host must resolve to a public address — loopback, link-local, private, and other reserved ranges are rejected. Self-hosted deployments skip the https and address checks.

Example Request

curl -X POST "https://api.recurso.dev/v1/integration-connections" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "category": "storage",
    "provider": "s3",
    "config": {
      "bucket": "acme-invoices",
      "region": "ap-south-1",
      "access_key_id": "AKIAIOSFODNN7EXAMPLE",
      "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
    }
  }'

Response

Returns 201 Created with the secret-free projection of the new connection. Because a connect always inserts a new row, created_at and updated_at are the same instant and the id differs from any previous connection for the same provider.

{
  "data": {
    "id": "c7d8e9f0-1a2b-4c3d-9e4f-5a6b7c8d9e0f",
    "category": "storage",
    "provider": "s3",
    "config": {
      "bucket": "acme-invoices",
      "region": "ap-south-1"
    },
    "has_secrets": true,
    "created_at": "2026-08-30T08:11:44Z",
    "updated_at": "2026-08-30T08:11:44Z"
  }
}

Fields

Field	Type	Description
`id`	string (uuid)	The connection’s id — new on every connect, including a credential rotation for the same provider
`category`	string	`tax`, `crm`, or `storage`
`provider`	string	The provider that was connected
`config`	object	Non-secret config only (`api_url`, `base_url`, `endpoint`, `region`, `bucket`, `prefix`, `company_code`)
`has_secrets`	boolean	`true` when at least one secret value was stored
`created_at`	string (date-time)	When this connection row was created
`updated_at`	string (date-time)	Same as `created_at` on the response — the row is new; it only moves later when the row is deactivated

Errors

Status	Code	When	Fix
`400`	`validation_failed`	`category`, `provider`, or `config` missing from the body, or the body is not valid JSON	Send all three fields
`400`	`validation_failed`	`(category, provider)` is not a supported pair	Use one of the pairs listed under Request Body
`400`	`validation_failed`	A required config key for the provider is empty (message names it, e.g. `hubspot: access_token is required`)	Add the missing key
`400`	`validation_failed`	An `endpoint`/`api_url`/`base_url` is not an `http(s)` URL; on the hosted deployment also when it is not `https`, does not resolve, or resolves to a private or reserved address	Use the provider’s public HTTPS endpoint
`401`	`unauthorized`	Missing or invalid API key / session	Send `Authorization: Bearer $API_KEY`
`403`	`forbidden`	The session user is not an owner or admin	Integration credentials are workspace config — ask an owner/admin
`500`	`internal_error`	Persisting or sealing the connection failed	Retry; contact support if it persists
`503`	`internal_error`	Credential vault unavailable (`GATEWAY_ENCRYPTION_KEY` not configured on the API)	Self-hosted: set `GATEWAY_ENCRYPTION_KEY` and restart

Errors use the standard envelope — see Errors.

Authorizations

Authorization

string

header

required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Body

application/json

Response

Connected.

data

object

Secret-free projection of a BYO tax/CRM/storage connection.

Show child attributes

Connect (or replace) a tax/CRM/storage integration

curl --request POST \
  --url https://billing.example.com/v1/integration-connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider": "<string>",
  "config": {}
}
'

import requests

url = "https://billing.example.com/v1/integration-connections"

payload = {
    "provider": "<string>",
    "config": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({provider: '<string>', config: {}})
};

fetch('https://billing.example.com/v1/integration-connections', 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://billing.example.com/v1/integration-connections",
  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([
    'provider' => '<string>',
    'config' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://billing.example.com/v1/integration-connections"

	payload := strings.NewReader("{\n  \"provider\": \"<string>\",\n  \"config\": {}\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://billing.example.com/v1/integration-connections")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"provider\": \"<string>\",\n  \"config\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://billing.example.com/v1/integration-connections")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"provider\": \"<string>\",\n  \"config\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "category": "tax",
    "provider": "<string>",
    "config": {},
    "has_secrets": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "validation_failed",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "validation_failed",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "validation_failed",
    "message": "<string>"
  }
}

Getting Started

Core

Billing & Invoicing

Revenue & Finance

Growth & Recovery

Compliance (India)

Platform

Customer Portal API

Request Body

Example Request

Response

Fields

Errors

Authorizations

Body

Response

​Request Body

​Example Request

​Response

​Fields

​Errors

Authorizations

Body

Response

Request Body

Example Request

Response

Fields

Errors