Connectors

Connectors are packages of integration interfaces associated with a specific External App. Membrane provides a library of pre-built connectors that you can extend by customizing existing connectors or building new ones.

Connectors contain the following interfaces:

• Authentication
• Data Collections
• External Events
• Global Webhooks
• Universal Data Models

Configuring Connectors

To start using a connector, you need to attach it to one of the Apps in your workspace and provide parameters (if required).

Not all connectors have a configuration, but the ones that do typically have a configuration guide that explains how to set them up:

You can also refer to the application's integration guide to learn how to do things like getting a development account used for configuring a connector.

Building Connectors

You can create a new connector from scratch or create an editable copy of an existing one.

Connector consists of Connector Specification and a set of Membrane Interfaces.

To develop connectors, you need to:

• Switch integration connector into a Development Mode if it's not there yet (you can't edit published versions of the connector).

  

• Sync your Dev Environment with your workspace - it will download the source code of the connector.

• Edit connector files (in the membrane/connectors folder) and use Membrane CLI to sync them back to your workspace for testing.

• When you are done - publish the new version of the connector from the integration page.

  

Alternatively, you can edit connectors right in the Membrane Console UI, which could be useful if you want to make minor changes.

Connector Specification

Connector spec is stored in the spec.yml file in the root of the connector.

Example:

name: Connector Name
logoUri: https://static.integration.app/connectors/connector-key/logo.png>
key: connector-key
parametersSchema:
  type: object
  properties:
	  parameter:
			type: string
appUuid: 877b0ad6-66b1-4d61-82f9-7e4d62acea69
apiDocsUri: https://api.example.com/docs
auth:
  # Authentication configuration

It contains the following properties:

• name: Display name of the connector.
• key: Unique identifier for the connector.
• logoUri: URL to the connector's logo (should be publicly available)
• parametersSchema: Data Schema for connector parameters (see below)
• appUuid: UUID of an application in Pathfinder Universe.
• auth: Connector Authentication configuration

Parameters

If connector logic can be parametrized by developers using the connector, the schema of these parameters should be defined in the connector spec.

The most common use of connector parameters is providing clientId/clientSecret for OAuth authentication.

Connector parameters will be available in some of the functions used in the connector implementation, mostly in its Authentication imlementation.