Framework

Integrations frameworkwhere your integration code lives

A simple API framework where you build all your integration code. It is designed to integrate perfectly with the main ZIntegrate UI.

Language

Any language - TypeScript, GoLang and Python out-of-the-box

Want Java or another language? Just ask your AI to duplicate the framework and SKILLS.md file.

/zintegrate-api SKILLS.md file will generate new controllers and endpoints, add timeout values globally and per endpoint
/zintegrate-docs SKILLS.md file generates explanations of your overall system and individual integrations by analyzing the code
Has a discovery function that ZIntegrate can call to discover all controllers and endpoints
Health endpoint that lets ZIntegrate poll for availability

Configure Skill

Use /zintegrate-api to modify your API.

Document Skill

Create documentation for your API and individual endpoints.

Decorators

Four custom decorators provide declarative configuration for integration endpoints.

@Integration() — marks a controller method as an integration endpoint, enabling ExecuteDto validation
@Timeout(seconds) — sets per-endpoint timeout metadata reflected in the manifest
@KeyGuard(expectedValue) — protects an endpoint with an x-endpoint-key header check
@Publicx() — bypasses the global ApiKeyGuard for specific endpoints
@NoWorkerProcess() - runs the endpoint in the main process instead of spawning a worker

Helper Functions

A few helper functions to make integration development easier and talk to ZIntegrate.

sendCompletionStatus() — sends SUCCESS/ERROR/TIMEOUT/OTHER and any final data you want to store back to ZIntegrate
sendProgress() — send progress updates and log message to ZIntegrate
getSecret() and getConnection() — fetch ZIntegrate managed values - protected by JWT tokens