Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.maia.ai/llms.txt

Use this file to discover all available pages before exploring further.

Custom Connector lets users create their own connectors for integrating with external data sources. This documentation provides an overview of the process for creating and managing custom connectors in . From the Connectors dashboard, you can view and manage your existing connectors, and create new connectors. You can also access and create Flex connectors, which are a type of pre-built custom connector. Selecting a Flex connector from the Flex connector library will begin the creation process and add it to the list of custom connectors. This is detailed in Flex connector library below. The basics of creating your own custom connector include:
  • Registering for a account.
  • Navigating to the Manage custom connectors dashboard. In the left navigation, click the Custom Connectors icon. Then, select Custom Connectors from the menu.
  • Using the Manage custom connectors dashboard to create, clone, edit, and delete custom connectors.
You can use Maia to create a custom connector from an OpenAPI documentation specification. Using Maia saves you time by setting up endpoints for you. Learn more about using Maia to create a custom connector.
The Connectors dashboard lists your custom connectors, in alphabetical order. Icons next to each connector let you perform contextual actions on that connector. The icons in the left-hand sidebar provide the following functions:
  • Connectors: Returns you to the dashboard from any other interface of Custom Connector.
  • OAuths: Lets you create and store OAuth profiles to authenticate data sources. Read Authentication for details.
To add a new connector, click Add connector. To edit an existing custom connector, click the name of the custom connector and make your changes. These will be reflected in any pipelines that use the custom connector. As a result, you may need to edit these pipelines—for example, if you make a change that requires a different authentication method, you will need to update this authentication method in all pipelines using this custom connector.

​
Connector actions

To carry out an action on a specific connector, use the icons to the right of the connector:
  • Edit: To edit a connector, click the edit (pencil) icon. Read Custom connector setup for details.
  • Delete: To delete a connector, click the delete (trashcan) icon, then click Yes, delete to confirm deletion.
  • Use connector: To export the connector in a format suitable for use in Matillion ETL, click Use connector and then click the required option.

​
Importing connectors

In addition to creating connectors from scratch, you are able to import pre-existing ones. The Custom Connector import feature supports two types of connectors:
  • Custom connectors that have been previously exported. Read Connector actions.
  • Matillion ETL connectors.
The import functionality allows for the inclusion of connectors from JSON files of up to 50 MB in size. After importing a connector, you will be directed to the workbench, where you can thoroughly review, conduct testing, and make necessary edits to the connector before saving and putting it to use.

​
Flex connector library

The Flex Connector Library provides a set of pre-built connectors that target commonly used APIs that you can base your own connectors on. To use a Flex connector, select it from the list to begin editing it in the Custom Connector workflow. From here, you’ll be able to review, edit, and test endpoints similarly to how you would edit any other connector. The connector will be saved with the same name it has in the Flex Connector Library, and you can rename the connector as required. Once saved, this connector will appear within your personal set of connectors, where you can export it or use it as you would any of your existing connectors. For further details on using these pre-built connectors, read Flex connector introduction.

​
Allowing IP addresses

You may need to allow the following IP addresses on your data sources before using custom connectors or Flex Connectors. Read the Network access and IP AllowList requirements for more details.

​
Request a connector

Is there a source or destination connector you’d like us to add? Raise an idea, and we’ll be in touch.