PROJECT STRUCTURE2 of 8

Project Structure

The CLI generates a production-ready connector project with a standard structure.

Create

Project structure

Configure

Build

Test

Go live

Generated project structure

treeCopy

my-connector/
├── src/
│   ├── index.ts                 # Application entry point
│   ├── config/                  # Configuration loader
│   ├── connectors/              # External system clients
│   ├── handlers/                # Workflow & event handlers
│   ├── mappings/                # Data mappings & transformations
│   ├── models/                  # Domain models & types
│   └── utils/                   # Utilities & helpers
├── tests/                       # Unit & integration tests
├── config/
│   ├── default.yaml
│   ├── sandbox.yaml
│   └── production.yaml
├── manifest.json                # Connector manifest
├── package.json
├── tsconfig.json
├── .env.example
└── README.md

What goes where?

src/

All your connector source code. Implement connectors, handlers, mappings and business logic here.

handlers/

Implement workflow handlers for sync, events, webhooks and custom actions.

mappings/

Define how data from your system maps to Mediloop resources.

config/

Environment-specific settings such as endpoints, credentials and flags.

manifest.json

Connector metadata, capabilities, supported resources and permissions.

tests/

Write and run tests to validate your integration logic and mappings.

File ownership

You edit

Files where you add or change your code and configuration.

SDK managed

Generated files managed by the SDK. Avoid manual changes.

Tip

Focus on the src/ folder and manifest.json to implement your connector. The SDK handles the rest.