Connector Spec

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.