Skip to main content
POST
/
api
/
connectors
Create connector
curl --request POST \
  --url https://sontairo.com/api/connectors \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspaceId": "<string>",
  "projectId": "<string>",
  "type": "<string>",
  "providerId": "<string>",
  "providerName": "<string>",
  "grantedScopes": [
    "<string>"
  ],
  "metadata": {}
}
'
{
  "data": {
    "id": "<string>",
    "workspaceId": "<string>",
    "projectId": "<string>",
    "type": "<string>",
    "providerId": "<string>",
    "providerName": "<string>",
    "status": "ACTIVE",
    "grantedScopes": [
      "<string>"
    ],
    "hasCredential": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Body

application/json
workspaceId
string
required

The workspace ID

projectId
string | null

Project to create the connector in

type
string

Legacy connector type (e.g. SLACK, GOOGLE)

providerId
string

Registry provider ID (e.g. slack, notion, github)

providerName
string

Display name for the connector

Required string length: 1 - 100
grantedScopes
string[]

OAuth scopes to request

metadata
object

Response

Connector created

data
object