cURL
curl --request POST \
--url http://localhost:8000/api/v1/integration_account \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"integrationDefinitionId": "<string>",
"integrationAccountName": "<string>",
"authType": "<string>",
"workspaceId": "<string>",
"config": {},
"accountIdentifier": "<string>"
}
'import requests
url = "http://localhost:8000/api/v1/integration_account"
payload = {
"integrationDefinitionId": "<string>",
"integrationAccountName": "<string>",
"authType": "<string>",
"workspaceId": "<string>",
"config": {},
"accountIdentifier": "<string>"
}
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({
integrationDefinitionId: '<string>',
integrationAccountName: '<string>',
authType: '<string>',
workspaceId: '<string>',
config: {},
accountIdentifier: '<string>'
})
};
fetch('http://localhost:8000/api/v1/integration_account', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8000",
CURLOPT_URL => "http://localhost:8000/api/v1/integration_account",
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([
'integrationDefinitionId' => '<string>',
'integrationAccountName' => '<string>',
'authType' => '<string>',
'workspaceId' => '<string>',
'config' => [
],
'accountIdentifier' => '<string>'
]),
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 := "http://localhost:8000/api/v1/integration_account"
payload := strings.NewReader("{\n \"integrationDefinitionId\": \"<string>\",\n \"integrationAccountName\": \"<string>\",\n \"authType\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"config\": {},\n \"accountIdentifier\": \"<string>\"\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("http://localhost:8000/api/v1/integration_account")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"integrationDefinitionId\": \"<string>\",\n \"integrationAccountName\": \"<string>\",\n \"authType\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"config\": {},\n \"accountIdentifier\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/api/v1/integration_account")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"integrationDefinitionId\": \"<string>\",\n \"integrationAccountName\": \"<string>\",\n \"authType\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"config\": {},\n \"accountIdentifier\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"integrationAccountId": "<string>",
"integrationDefinitionId": "<string>",
"integrationConfiguration": {},
"authType": "<string>",
"workspaceId": "<string>",
"integrationAccountName": "<string>",
"deleted": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"linkId": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"status": "<string>",
"error": "<string>",
"errors": {},
"timestamp": "<string>",
"path": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"status": "<string>",
"error": "<string>",
"errors": {},
"timestamp": "<string>",
"path": "<string>"
}Integration Account
Create integration account
Create integration account in a workspace
POST
/
v1
/
integration_account
cURL
curl --request POST \
--url http://localhost:8000/api/v1/integration_account \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"integrationDefinitionId": "<string>",
"integrationAccountName": "<string>",
"authType": "<string>",
"workspaceId": "<string>",
"config": {},
"accountIdentifier": "<string>"
}
'import requests
url = "http://localhost:8000/api/v1/integration_account"
payload = {
"integrationDefinitionId": "<string>",
"integrationAccountName": "<string>",
"authType": "<string>",
"workspaceId": "<string>",
"config": {},
"accountIdentifier": "<string>"
}
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({
integrationDefinitionId: '<string>',
integrationAccountName: '<string>',
authType: '<string>',
workspaceId: '<string>',
config: {},
accountIdentifier: '<string>'
})
};
fetch('http://localhost:8000/api/v1/integration_account', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8000",
CURLOPT_URL => "http://localhost:8000/api/v1/integration_account",
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([
'integrationDefinitionId' => '<string>',
'integrationAccountName' => '<string>',
'authType' => '<string>',
'workspaceId' => '<string>',
'config' => [
],
'accountIdentifier' => '<string>'
]),
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 := "http://localhost:8000/api/v1/integration_account"
payload := strings.NewReader("{\n \"integrationDefinitionId\": \"<string>\",\n \"integrationAccountName\": \"<string>\",\n \"authType\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"config\": {},\n \"accountIdentifier\": \"<string>\"\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("http://localhost:8000/api/v1/integration_account")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"integrationDefinitionId\": \"<string>\",\n \"integrationAccountName\": \"<string>\",\n \"authType\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"config\": {},\n \"accountIdentifier\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/api/v1/integration_account")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"integrationDefinitionId\": \"<string>\",\n \"integrationAccountName\": \"<string>\",\n \"authType\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"config\": {},\n \"accountIdentifier\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"integrationAccountId": "<string>",
"integrationDefinitionId": "<string>",
"integrationConfiguration": {},
"authType": "<string>",
"workspaceId": "<string>",
"integrationAccountName": "<string>",
"deleted": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"linkId": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"status": "<string>",
"error": "<string>",
"errors": {},
"timestamp": "<string>",
"path": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"status": "<string>",
"error": "<string>",
"errors": {},
"timestamp": "<string>",
"path": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Response
A unique identifier for Integration Account
A unique identifier for Integration Definition
Configuration used to configure the integration
Type of authentication used to create this account Exmaple: OAuth2, Api Key etc
A unique identifier for Workspace
This is used for User experience. You can pass a name to easily identify the account in UI
When this account is deleted. If deleted
When the integration account was created.
When the integration account was updated last.
This will be linkId of the link used to created this account
⌘I