Get organisations hubs boards integration info

Retrieves all the information needed that a user needs to fill out to use a Hub integration.

GET /organisations/{organisationId}/hubs/{hubId}/boards/{boardId}/integration-info

cURL

cURL

curl --request GET \
  --url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/hubs/{hubId}/boards/{boardId}/integration-info \
  --header 'Authorization: <api-key>'

200

{
  "connections": [
    {
      "id": "<string>",
      "name": "<string>",
      "imageUrl": "<string>",
      "requiresUserAuth": true,
      "authConfig": {
        "connectionId": "<string>",
        "data": {
          "discoveryUrl": "<string>",
          "clientId": "<string>",
          "clientSecret": "<string>",
          "scopes": {}
        }
      }
    }
  ],
  "listeners": [
    {
      "url": "<string>",
      "appName": "<string>",
      "appId": "<string>",
      "nodeId": "<string>"
    }
  ],
  "variables": {}
}

Authorizations

Authorization · string · header · required

Path Parameters

organisationId · string · required

hubId · string · required

boardId · string · required

Query Parameters

showPrivate · boolean

The showPrivate query parameter will make the endpoint show all dynamic connections, event if they are private dynamic connections.

Response

200

application/json

All information a hub user is required to provide to use an integration

connections · object[]

Show child attributes

listeners · object[]

Show child attributes

variables · object