Skip to main content
POST
/
hubs
/
{hub_id}
/
users
/
{user_id}
/
connections
Create End User Connection
curl --request POST \
  --url https://platform.versori.com/api/embedded/v1/hubs/{hub_id}/users/{user_id}/connections \
  --header 'Content-Type: application/json' \
  --data '{
  "connectorId": "<string>",
  "connection": {
    "name": "<string>",
    "credentials": {
      "action": [
        {
          "authSchemeConfig": {
            "id": "<string>",
            "description": "<string>",
            "validationMessages": [
              {}
            ],
            "schemeType": "<string>"
          },
          "credential": {
            "name": "<string>",
            "type": "none",
            "data": {}
          }
        }
      ],
      "trigger": [
        {
          "authSchemeConfig": {
            "id": "<string>",
            "description": "<string>",
            "validationMessages": [
              {}
            ],
            "schemeType": "<string>"
          },
          "credential": {
            "name": "<string>",
            "type": "none",
            "data": {}
          }
        }
      ]
    },
    "variables": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ]
  }
}'
{
  "id": "<string>",
  "name": "<string>",
  "credentials": {
    "action": [
      {
        "id": "<string>",
        "authSchemeConfig": {
          "id": "<string>",
          "description": "<string>",
          "validationMessages": [
            {
              "text": "<any>",
              "severity": "<any>",
              "detail": "<any>"
            }
          ],
          "schemeType": "<string>"
        },
        "credential": {
          "id": "<string>",
          "organisationId": "<string>",
          "type": "none",
          "name": "<string>",
          "usages": [
            {
              "connection": {}
            }
          ],
          "errors": [
            "<string>"
          ],
          "data": {},
          "expiresAt": "2023-11-07T05:31:56Z"
        }
      }
    ],
    "trigger": [
      {
        "id": "<string>",
        "authSchemeConfig": {
          "id": "<string>",
          "description": "<string>",
          "validationMessages": [
            {
              "text": "<any>",
              "severity": "<any>",
              "detail": "<any>"
            }
          ],
          "schemeType": "<string>"
        },
        "credential": {
          "id": "<string>",
          "organisationId": "<string>",
          "type": "none",
          "name": "<string>",
          "usages": [
            {
              "connection": {}
            }
          ],
          "errors": [
            "<string>"
          ],
          "data": {},
          "expiresAt": "2023-11-07T05:31:56Z"
        }
      }
    ]
  },
  "variables": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Path Parameters

hub_id
string<ulid>
required
user_id
string
required

Query Parameters

identifier_type
enum<string>
default:external
Available options:
internal,
external

Body

application/json
connectorId
string<ulid>
required
connection
object
required

Response

id
string<ulid>
required
name
string
required
credentials
object
required
variables
object[]
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required