Create connection

POST/unified/connection

Used only to import existing customer credentials; use "Authorize new connection" instead

Payload

A connection represents a specific authentication of an integration.

idstring read-only

Unique identifier for this integration object

created_atdate read-only

The date that this integration object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atdate read-only

The last date that this integration object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

workspace_idstring read-only

(reference to KmsSpace)

integration_typestring required

The integration type

integration_namestring

external_xrefstring

customer's user ID

permissions enum array required

Valid values:

"accounting_account_read"

"accounting_account_write"

"accounting_transaction_read"

"accounting_transaction_write"

"accounting_journal_read"

categories enum array required

Valid values:

"passthrough"

"hris"

"ats"

"auth"

"crm"

The Integration categories that this connection supports

authobject

An authentication object that represents a specific authorized user's connection to an integration.

is_pausedboolean read-only

Whether this integration has exceed the monthly limit of the plan

auth_aws_arnstring

the AWS ARN / secretID for the stored auth field

environmentstring

auth_azure_keyvault_idstring

the Azure Key Vault ID for the stored auth field

auth_gcp_secret_namestring

the Google Cloud Secret Manager name for the stored auth field

auth_hashi_vault_pathstring

the HashiCorp Vault path for the stored auth field

last_healthy_atdate read-only

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

last_unhealthy_atdate read-only

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

secretsmanager_idstring

the ID of the SecretsManager object

secretsmanager_keystring

the key/path/name of the secret within the vault

Returns

Connection

A connection represents a specific authentication of an integration.

idstring read-only

Unique identifier for this integration object

created_atdate read-only

The date that this integration object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atdate read-only

The last date that this integration object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

workspace_idstring read-only

(reference to KmsSpace)

integration_typestring required

The integration type

integration_namestring

external_xrefstring

customer's user ID

permissions enum array required

Valid values:

"accounting_account_read"

"accounting_account_write"

"accounting_transaction_read"

"accounting_transaction_write"

"accounting_journal_read"

categories enum array required

Valid values:

"passthrough"

"hris"

"ats"

"auth"

"crm"

The Integration categories that this connection supports

authobject

An authentication object that represents a specific authorized user's connection to an integration.

is_pausedboolean read-only

Whether this integration has exceed the monthly limit of the plan

auth_aws_arnstring

the AWS ARN / secretID for the stored auth field

environmentstring

auth_azure_keyvault_idstring

the Azure Key Vault ID for the stored auth field

auth_gcp_secret_namestring

the Google Cloud Secret Manager name for the stored auth field

auth_hashi_vault_pathstring

the HashiCorp Vault path for the stored auth field

last_healthy_atdate read-only

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

last_unhealthy_atdate read-only

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

secretsmanager_idstring

the ID of the SecretsManager object

secretsmanager_keystring

the key/path/name of the secret within the vault

const options = {
  method: 'POST',
  url: 'https://api.unified.to/unified/connection',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,

};

const results = await axios.request(options);

Code Samples

Node.js SDK

import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const results = await sdk.unified.createUnifiedConnection({ 

 });

Node.js (axios)

const options = {
  method: 'POST',
  url: 'https://api.unified.to/unified/connection',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,

};

const results = await axios.request(options);

Java

AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("POST", "https://api.unified.to/unified/connection")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();

Go

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

url := `https://api.unified.to/unified/connection

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

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

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

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

Python

import requests

url = "https://api.unified.to/unified/connection"

headers = {
    "accept": "application/json",
    "authorization": "....."
}

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

PHP

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/unified/connection",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/unified/connection")

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

request = Net::HTTP::Post.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

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

cURL

curl --request POST \
  --url 'https://api.unified.to/unified/connection' \
  --header 'accept: application/json' \
  --header 'authorization: .....'

Are we missing anything? Let us know

Was this page helpful?