cannectors

Examples

34 maintained example pipelines, grouped by topic.

The cannectors/examples/ directory holds 34 maintained YAML pipelines that the test suite validates on every commit. They cover every module and most combinations — copying one of them is the fastest way to bootstrap a new pipeline.

Every example is rendered live elsewhere in this site via <PipelineExample /> — open any module page and scroll to "Examples" to see the YAML inline. This page is the index.

Running them

# Validate all
make validate-examples

# Validate one
cannectors validate ./examples/01-http-polling-basic-to-http-batch.yaml

# Dry-run one
cannectors run --dry-run ./examples/01-http-polling-basic-to-http-batch.yaml

They target https://source.example.com / https://destination.example.com placeholder hosts. Edit the endpoints or copy the file before pointing at real systems.

HTTP polling

FileCovers
01-http-polling-basic-to-http-batch.yamlBasic polling, no auth, batched HTTP output
02-http-polling-page-pagination.yamlPage-based pagination
03-http-polling-offset-pagination-state.yamlOffset pagination + state persistence
04-http-polling-cursor-oauth2.yamlCursor pagination + OAuth2

Webhook

FileCovers
05-webhook-hmac-to-http-single.yamlHMAC verification, per-record HTTP output
06-webhook-queue-rate-limit-to-database.yamlAsync queue + rate limit, database output

Database I/O

FileCovers
07-database-input-basic-to-http.yamlDatabase input → HTTP output
08-database-input-limit-offset-to-database.yamlLimit/offset pagination, DB → DB
09-database-input-cursor-incremental.yamlCursor + incremental queries

Transformations

FileCovers
10-mapping-transforms-all.yamlEvery mapping transform
11-condition-nested-routing.yamlNested condition routing
12-script-inline-transform.yamlInline JavaScript transform
13-script-file-transform.yamlExternal JavaScript file
25-loop-cells-extraction.yamlIterate cells[] and extract values by columnId

Enrichment

FileCovers
14-http-call-get-merge-cache.yamlGET enrichment, merge, cache
15-http-call-query-header-append.yamlQuery + header keys, append strategy
16-http-call-post-template-replace.yamlPOST + body template, replace strategy
17-sql-call-merge-cache.yamlSQL enrichment, merge + cache
18-sql-call-append-query-file.yamlSQL enrichment, append + external query file
42-soap-call-enrichment.yamlSOAP enrichment, append + cache

HTTP output specifics

FileCovers
19-http-output-single-template.yamlSingle-record mode + URL template
20-http-output-retry-auth-api-key.yamlRetry block + API key auth

Database output

FileCovers
21-database-output-transaction-query-file.yamlTransactional output + external query file

SOAP

FileCovers
40-soap-polling-basic-v11.yamlSOAP 1.1 polling
40b-soap-polling-basic-v12.yamlSOAP 1.2 polling
41-soap-polling-cursor.yamlSOAP cursor pagination
43-soap-output-batch.yamlSOAP batch output
44-soap-output-mtom-emission.yamlMTOM attachment emission
44b-soap-input-mtom-reception.yamlMTOM attachment reception
45-soap-output-wssecurity-passwordtext.yamlWS-Security PasswordText
45b-soap-output-wssecurity-passworddigest.yamlWS-Security PasswordDigest

Pipeline-wide concerns

FileCovers
22-defaults-inheritance.yamlTop-level defaults + per-module overrides
23-auth-basic-bearer-query-key.yamlBearer + basic + API key in one pipeline
24-empty-filter-pass-through.yamlEmpty filter chain (filters: [])