Custom Catalogs Only
Connectorobject for which a new
Connectionshould be created, or a string slug of the Connector.
Promise that resolves to the newly created
connect kicks off an authorization sequence for the provided
Connector which includes opening a pop-up window, collecting input from the user (e.g. consent to grant access to the 3rd party service), and finalizes the connection (e.g. by retrieving OAuth2 access tokens).
connect monitors both the opened popup window as well as a WebSocket connection with Xkit to provide instant feedback to the user in cases of errors and success.
In cases where the connection is successfully created,
connect returns the newly created
Connection object with the
enabled attribute set to
In cases where the connection fails,
connect will throw errors with descriptive messages as to the source of the error (e.g.
Installation cancelled. if the user closes the pop-up without continuing).
const slackConnection = await xkit.connect("slack")