Sign in

v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Connections

Create a Connection

Creates a Connection in a Project.

post/v2.0/connections

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Request body

OR

Example request

{
  "name": "some name",
  "type": "http_basic",
  "extension": "@cognigy/basic-nodes",
  "fields": {
    "some-key-from-connection-schema": "x123sdfu12312"
  }
}

Response

Returns Connection metadata object.

keystring

The key of the connection field. The key should match the connection schema of the specific connection type.

valuestring

The value of the connection field

_idstring
createdAtinteger

Unix-timestamp

lastChangedinteger

Unix-timestamp

createdBystring
lastChangedBystring

Example response

{
  "key": "some-key-from-connection-schema",
  "value": "x123w123",
  "createdAt": 1694518620,
  "lastChanged": 1694518620
}