DocsGitHub7

Create your own

Follow these steps to create your own connector or pipeline:

1. Clone the repository

Clone the registry repository to your local machine:

git clone https://github.com/514-labs/registry.git && cd registry

2. Generate a connector scaffold

From the registry directory, run the the scaffold to generate a new connector with the appropriate structure:

npx @514labs/registry scaffold connector typescript --name my-connector --scaffold-version v1 --author 514-labs --implementation default --package-name @workspace/connector-my-connector --resource widgets --yes

This creates a new directory with your connector scaffold in the chosen language.

3. Determine your connector type

Identify which type of connector you're building:

  • API Connector: For general REST/GraphQL APIs
  • SaaS Connector: For third-party SaaS platforms and services
  • Database Connector: For SQL databases (PostgreSQL, MySQL, etc.)
  • Blob Storage Connector: For cloud storage (S3, GCS, Azure Blob)

4. Follow the specifications

Feed your LLM the relevant specifications and documentation:

  1. Target API documentation: Share the official API docs of the service you're connecting to (e.g., Stripe API docs, Shopify API docs)
  2. Type-specific specs: Include the appropriate specification:
  3. Example connectors: Reference existing connectors in the registry for patterns
    • API Connectors: ADS-B.lol, OpenWeather
    • SaaS Connectors: Google Analytics, Shopify
    • [coming soon] Database Connectors: PostgreSQL
    • [coming soon] Blob Storage Connectors: S3

Your LLM can then help generate the connector implementation following the established patterns and specifications.

5. Share your connector

Open a pull request to the registry repository to share your connector with the community. Mention the connector Issue in the PR description.

If you built your connector outside the registry monorepo, you'll need to add it to the monorepo's registry directory with all required metadata (defined in connector-registry/_scaffold).