Learn how to Build a Custom Connector with Weld
Bring data from any public API into Weld with a fully self-hosted connector!
This course walks you through building, testing, and deploying a custom connector step by step.
# 1. Schema endpoint
GET /schema
{
"schema": {
"orders": {
"primary_key": "id",
"fields": [
{ "name": "id", "type": "string" },
{ "name": "amount", "type": "double" }
]
}
}
}
# 2. Data endpoint
POST /
{ "id": "o_1", "amount": 12.5 }Custom Connector Tutorial
Custom connectors let you sync data from tools that aren't available in Weld's standard connector library, giving you flexibility without sacrificing Weld's scheduling, lineage, and alerting features.
Follow along this comprehensive tutorial to build your own custom connector with Weld.
Module 1 • Introduction
What is a custom connector?
Bring data from any API into Weld — even if it’s not part of our native connector list.
Module 2 • Setup
Setting up your development environment
Get your tools ready to build your first custom connector.
Module 3 • Setup
Creating the /schema endpoint
Tell Weld what data your connector provides.
Module 4 • Setup
Creating the / (root) endpoint
Send your actual data to Weld - one page at a time.
Module 5 • Setup
Adding pagination to your custom connector
Break your data into pages so Weld can sync large datasets efficiently.
Module 6 • Setup
Adding authentication to your connector
Make sure only Weld can access your data.
Module 7 • Deploying
Deploying your connector to Google Cloud
Make your connector accessible to Weld - securely and reliably.
Module 8 • Syncing
Connecting your custom connector in Weld
Plug your self-hosted API into Weld and start syncing data.
Module 9 • Modeling
Modeling data from your custom connector
Turn raw API data into clean, usable tables for analysis.
Module 10 • Connecting to Weld
Connect to Weld
Make it production-ready with advanced features and best practices.