Skip to main content
POST
/
v1
/
connector-instances
Create connector instance
curl --request POST \
  --url https://api.openworklabs.com/v1/connector-instances \
  --header 'Content-Type: application/json' \
  --data '
{
  "connectorAccountId": "<string>",
  "connectorType": "github",
  "name": "<string>",
  "remoteId": "<string>",
  "config": {}
}
'
import requests

url = "https://api.openworklabs.com/v1/connector-instances"

payload = {
"connectorAccountId": "<string>",
"connectorType": "github",
"name": "<string>",
"remoteId": "<string>",
"config": {}
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
connectorAccountId: '<string>',
connectorType: 'github',
name: '<string>',
remoteId: '<string>',
config: {}
})
};

fetch('https://api.openworklabs.com/v1/connector-instances', 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://api.openworklabs.com/v1/connector-instances",
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([
'connectorAccountId' => '<string>',
'connectorType' => 'github',
'name' => '<string>',
'remoteId' => '<string>',
'config' => [

]
]),
CURLOPT_HTTPHEADER => [
"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://api.openworklabs.com/v1/connector-instances"

payload := strings.NewReader("{\n \"connectorAccountId\": \"<string>\",\n \"connectorType\": \"github\",\n \"name\": \"<string>\",\n \"remoteId\": \"<string>\",\n \"config\": {}\n}")

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

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://api.openworklabs.com/v1/connector-instances")
.header("Content-Type", "application/json")
.body("{\n \"connectorAccountId\": \"<string>\",\n \"connectorType\": \"github\",\n \"name\": \"<string>\",\n \"remoteId\": \"<string>\",\n \"config\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.openworklabs.com/v1/connector-instances")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"connectorAccountId\": \"<string>\",\n \"connectorType\": \"github\",\n \"name\": \"<string>\",\n \"remoteId\": \"<string>\",\n \"config\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "ok": true,
  "item": {
    "id": "<string>",
    "organizationId": "<string>",
    "connectorAccountId": "<string>",
    "connectorType": "github",
    "remoteId": "<string>",
    "name": "<string>",
    "instanceConfigJson": {},
    "lastSyncedAt": "2023-11-07T05:31:56Z",
    "lastSyncCursor": "<string>",
    "createdByOrgMembershipId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}
{
"error": "<string>",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}
{
"error": "<string>"
}
{
"error": "<string>",
"message": "<string>"
}
{
"error": "<string>",
"message": "<string>"
}

Body

application/json
connectorAccountId
string<typeid>
required

Den TypeID with 'cac_' prefix and a 26-character base32 suffix.

Required string length: 30
Pattern: ^cac_.*
connectorType
enum<string>
required
Available options:
github
name
string
required
Required string length: 1 - 255
remoteId
string | null
Required string length: 1 - 255
config
object

Response

Connector instance created successfully.

ok
boolean
required
item
object
required