Setup GitHub connector
curl --request POST \
--url https://api.openworklabs.com/v1/connectors/github/setup \
--header 'Content-Type: application/json' \
--data '
{
"installationId": 123,
"connectorInstanceName": "<string>",
"repositoryId": 123,
"repositoryFullName": "<string>",
"branch": "<string>",
"ref": "<string>",
"connectorAccountId": "<string>",
"mappings": [
{
"selector": "<string>",
"pluginId": "<string>",
"autoAddToPlugin": false,
"config": {}
}
]
}
'import requests
url = "https://api.openworklabs.com/v1/connectors/github/setup"
payload = {
"installationId": 123,
"connectorInstanceName": "<string>",
"repositoryId": 123,
"repositoryFullName": "<string>",
"branch": "<string>",
"ref": "<string>",
"connectorAccountId": "<string>",
"mappings": [
{
"selector": "<string>",
"pluginId": "<string>",
"autoAddToPlugin": False,
"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({
installationId: 123,
connectorInstanceName: '<string>',
repositoryId: 123,
repositoryFullName: '<string>',
branch: '<string>',
ref: '<string>',
connectorAccountId: '<string>',
mappings: [
{selector: '<string>', pluginId: '<string>', autoAddToPlugin: false, config: {}}
]
})
};
fetch('https://api.openworklabs.com/v1/connectors/github/setup', 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/connectors/github/setup",
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([
'installationId' => 123,
'connectorInstanceName' => '<string>',
'repositoryId' => 123,
'repositoryFullName' => '<string>',
'branch' => '<string>',
'ref' => '<string>',
'connectorAccountId' => '<string>',
'mappings' => [
[
'selector' => '<string>',
'pluginId' => '<string>',
'autoAddToPlugin' => false,
'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/connectors/github/setup"
payload := strings.NewReader("{\n \"installationId\": 123,\n \"connectorInstanceName\": \"<string>\",\n \"repositoryId\": 123,\n \"repositoryFullName\": \"<string>\",\n \"branch\": \"<string>\",\n \"ref\": \"<string>\",\n \"connectorAccountId\": \"<string>\",\n \"mappings\": [\n {\n \"selector\": \"<string>\",\n \"pluginId\": \"<string>\",\n \"autoAddToPlugin\": false,\n \"config\": {}\n }\n ]\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/connectors/github/setup")
.header("Content-Type", "application/json")
.body("{\n \"installationId\": 123,\n \"connectorInstanceName\": \"<string>\",\n \"repositoryId\": 123,\n \"repositoryFullName\": \"<string>\",\n \"branch\": \"<string>\",\n \"ref\": \"<string>\",\n \"connectorAccountId\": \"<string>\",\n \"mappings\": [\n {\n \"selector\": \"<string>\",\n \"pluginId\": \"<string>\",\n \"autoAddToPlugin\": false,\n \"config\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/connectors/github/setup")
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 \"installationId\": 123,\n \"connectorInstanceName\": \"<string>\",\n \"repositoryId\": 123,\n \"repositoryFullName\": \"<string>\",\n \"branch\": \"<string>\",\n \"ref\": \"<string>\",\n \"connectorAccountId\": \"<string>\",\n \"mappings\": [\n {\n \"selector\": \"<string>\",\n \"pluginId\": \"<string>\",\n \"autoAddToPlugin\": false,\n \"config\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"item": {
"connectorAccount": {
"id": "<string>",
"organizationId": "<string>",
"connectorType": "github",
"remoteId": "<string>",
"externalAccountRef": "<string>",
"displayName": "<string>",
"createdByOrgMembershipId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByName": "<string>",
"metadata": {}
},
"connectorInstance": {
"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"
},
"connectorTarget": {
"id": "<string>",
"connectorInstanceId": "<string>",
"connectorType": "github",
"remoteId": "<string>",
"targetKind": "repository_branch",
"externalTargetRef": "<string>",
"targetConfigJson": {},
"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>"
}GitHub
Setup GitHub connector
Creates a GitHub connector account, instance, target, and initial mappings in one flow.
POST
/
v1
/
connectors
/
github
/
setup
Setup GitHub connector
curl --request POST \
--url https://api.openworklabs.com/v1/connectors/github/setup \
--header 'Content-Type: application/json' \
--data '
{
"installationId": 123,
"connectorInstanceName": "<string>",
"repositoryId": 123,
"repositoryFullName": "<string>",
"branch": "<string>",
"ref": "<string>",
"connectorAccountId": "<string>",
"mappings": [
{
"selector": "<string>",
"pluginId": "<string>",
"autoAddToPlugin": false,
"config": {}
}
]
}
'import requests
url = "https://api.openworklabs.com/v1/connectors/github/setup"
payload = {
"installationId": 123,
"connectorInstanceName": "<string>",
"repositoryId": 123,
"repositoryFullName": "<string>",
"branch": "<string>",
"ref": "<string>",
"connectorAccountId": "<string>",
"mappings": [
{
"selector": "<string>",
"pluginId": "<string>",
"autoAddToPlugin": False,
"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({
installationId: 123,
connectorInstanceName: '<string>',
repositoryId: 123,
repositoryFullName: '<string>',
branch: '<string>',
ref: '<string>',
connectorAccountId: '<string>',
mappings: [
{selector: '<string>', pluginId: '<string>', autoAddToPlugin: false, config: {}}
]
})
};
fetch('https://api.openworklabs.com/v1/connectors/github/setup', 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/connectors/github/setup",
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([
'installationId' => 123,
'connectorInstanceName' => '<string>',
'repositoryId' => 123,
'repositoryFullName' => '<string>',
'branch' => '<string>',
'ref' => '<string>',
'connectorAccountId' => '<string>',
'mappings' => [
[
'selector' => '<string>',
'pluginId' => '<string>',
'autoAddToPlugin' => false,
'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/connectors/github/setup"
payload := strings.NewReader("{\n \"installationId\": 123,\n \"connectorInstanceName\": \"<string>\",\n \"repositoryId\": 123,\n \"repositoryFullName\": \"<string>\",\n \"branch\": \"<string>\",\n \"ref\": \"<string>\",\n \"connectorAccountId\": \"<string>\",\n \"mappings\": [\n {\n \"selector\": \"<string>\",\n \"pluginId\": \"<string>\",\n \"autoAddToPlugin\": false,\n \"config\": {}\n }\n ]\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/connectors/github/setup")
.header("Content-Type", "application/json")
.body("{\n \"installationId\": 123,\n \"connectorInstanceName\": \"<string>\",\n \"repositoryId\": 123,\n \"repositoryFullName\": \"<string>\",\n \"branch\": \"<string>\",\n \"ref\": \"<string>\",\n \"connectorAccountId\": \"<string>\",\n \"mappings\": [\n {\n \"selector\": \"<string>\",\n \"pluginId\": \"<string>\",\n \"autoAddToPlugin\": false,\n \"config\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/connectors/github/setup")
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 \"installationId\": 123,\n \"connectorInstanceName\": \"<string>\",\n \"repositoryId\": 123,\n \"repositoryFullName\": \"<string>\",\n \"branch\": \"<string>\",\n \"ref\": \"<string>\",\n \"connectorAccountId\": \"<string>\",\n \"mappings\": [\n {\n \"selector\": \"<string>\",\n \"pluginId\": \"<string>\",\n \"autoAddToPlugin\": false,\n \"config\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"item": {
"connectorAccount": {
"id": "<string>",
"organizationId": "<string>",
"connectorType": "github",
"remoteId": "<string>",
"externalAccountRef": "<string>",
"displayName": "<string>",
"createdByOrgMembershipId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdByName": "<string>",
"metadata": {}
},
"connectorInstance": {
"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"
},
"connectorTarget": {
"id": "<string>",
"connectorInstanceId": "<string>",
"connectorType": "github",
"remoteId": "<string>",
"targetKind": "repository_branch",
"externalTargetRef": "<string>",
"targetConfigJson": {},
"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>"
}Body
application/json
Required range:
x <= 9007199254740991Required string length:
1 - 255Required range:
x <= 9007199254740991Required string length:
1 - 255Required string length:
1 - 255Required string length:
1 - 255Den TypeID with 'cac_' prefix and a 26-character base32 suffix.
Required string length:
30Pattern:
^cac_.*Maximum array length:
100Show child attributes
Show child attributes
Was this page helpful?
⌘I