Skip to main content

ConnectionDefinitionInput Input Object

Represents a collection of data that defines a Component Connection.

Input fields

ArgumentTypeDescription
keyString!A string which uniquely identifies the Connection in the context of the Component.
labelString!The name of the Connection.
commentsStringAdditional notes about the Connection.
iconPathStringOptional path to the connect icon for this Connection.
avatarIconPathStringOptional path to the avatar icon for this Connection.
oauth2ConfigConnectionOAuth2ConfigurationMetadata to support bespoke OAuth2 flow behaviors for this Connection.
oauth2TypeStringType of OAuth2 connection, if any.
oauth2PkceMethodStringType of OAuth2 PKCE method, if any.
inputs[ConnectionInputFieldDefinition]Inputs for this Connection.