Legacy Data Integration API Reference (1.0.0) - ConnectionTypesandProperties

Toggle Pane

• Connection Types and Properties
  • getConnection Types List
  • getConnection Type Properties

API docs by Redocly

Download OpenAPI Specification: Download

Find out more about Data Integration.

Connection Types and Properties

Connection Types List

Get the available connection types that can be provided in Data Integration.

• scope: connection:list

Authorizations:

BearerToken

Responses

Response Schema: application/json

Array

connection_type	string The connection type id
connection_type_name	string Connection type display name
is_test_connection	boolean Can the connection type be tested or not.

Data Integration Console (US)

https://console.rivery.io/api/connection_types

Data Integration Console (EU)

https://eu-west-1.console.rivery.io/api/connection_types

Response samples

• 200
• 403

Content type

application/json

[

• {

  • "connection_type": "fb",
  • "connection_type_name": "Facebook Ads",
  • "is_test_connection": true

  }

]

Connection Type Properties

• scope: connection:list

Authorizations:

BearerToken

path Parameters

connectionTypeId required

string Example: fb_ads,aws,klaviyo Connection type id.

Responses

Response Schema: application/json

connection_type	string The connection type id
connection_type_name	string Connection type display name
oauth2	boolean Is this a OAuth2 connection type
is_test_connection	boolean Can the connection type be tested or not.
	Array of objects

Data Integration Console (US)

https://console.rivery.io/api/connections/properties/{{connectionTypeId}}

Data Integration Console (EU)

https://eu-west-1.console.rivery.io/api/connections/properties/{{connectionTypeId}}

Response samples

• 200
• 403

Content type

application/json

[

• {

  • "connection_type": "klaviyo",
  • "connection_type_name": "Klaviyo",
  • "properties": [

    • {

      • "id": "connection_name",
      • "type": "string"

      },
    • {

      • "id": "connection_description",
      • "type": "string"

      },
    • {

      • "id": "api_key",
      • "type": "password"

      }

    ]

  },
• {

  • "connection_type": "fb",
  • "connection_type_name": "Facebook",
  • "oauth2": true,
  • "properties": [

    • {

      • "id": "connection_name",
      • "type": "string"

      },
    • {

      • "id": "client_secrets",
      • "type": "password"

      },
    • {

      • "id": "access_token",
      • "type": "password"

      },
    • {

      • "id": "client_id",
      • "type": "string"

      },
    • {

      • "id": "connection_description",
      • "type": "string"

      },
    • {

      • "id": "credentials",
      • "is_credentials": true,
      • "type": "password"

      }

    ]

  }

]