Ziggy
Framework

Integrations frameworkwhere your integration code lives

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

Language

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

Want Python or another language? Just get your AI to duplicate the framework and SKILLS.md file. In about 20 minutes you'll have it

ZIntegrate Framework Architecture
  • /zintegrate-api SKILLS.md file will generate new controllers and endpoint, 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

Configure your API with a Claude Skill

Use /zintegrate-api to modify your API

ZIntegrate Claude Code Skills
  • Add new controllers
  • Create new endpoints within existing controllers
  • Manage endpoint key protection
  • Configure per endpoint timeout values
Document Skill

Document your API with a Claude Skill

Create documentation for your API and individual endpoints.

ZIntegrate Claude Code Skills
  • /zintegrate-docs uses your AI to generate all documentation
  • Generated docs can be viewed with a button click from the ZIntegrate UI
Decorators

Custom Decorators

Four custom decorators provide declarative configuration for integration endpoints

ZIntegrate Framework Decorators
  • @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
  • @Public() — bypasses the global ApiKeyGuard for specific endpoints
Helper Functions

Built-In Helpers secrets, connections, progress

A few helper functions to make integration developent easier and talk 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

Start building. The infrastructure is done.

1Clone the repository
2Configure your environment
3Start building your product