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": {}
}
'
{
  "ok": true,
  "item": {
    "id": "<string>",
    "organizationId": "<string>",
    "connectorAccountId": "<string>",
    "connectorType": "github",
    "remoteId": "<string>",
    "name": "<string>",
    "status": "active",
    "instanceConfigJson": {},
    "lastSyncedAt": "2023-11-07T05:31:56Z",
    "lastSyncStatus": "pending",
    "lastSyncCursor": "<string>",
    "createdByOrgMembershipId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

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