The app-wide connector for a 3rd party service

Attribute

Description

name
string

Name of the connector as specified in the Xkit Developer Portal.

slug
string

Unique string slug of the connector as specified in the Xkit Developer Portal.

short_description
string

A short, one line description of the connector.

mark_url
string

A URL for an image to be used as the connector's logomark.

about
string (optional)

A description of the service being connected to.

description
string (optional)

A longer description of what the connector does and how it can be used.

connection
object (optional)

An object representing a shell of a Connection. Only returned when retrieving multiple Connectors.

connection.enabled
boolean (optional)

An indicator of whether the connection associated with the given connector is installed.