SmartConnector APIs

Audience: Developers, Integrators, Solution architects.

Purpose: Introduces the API endpoints and dev package that let you work with SmartConnectors outside the Kizen UI.

Overview

SmartConnectors can be managed programmatically through a set of Kizen APIs and a downloadable dev package for local execution. Together, these options allow external systems and developer workflows to trigger runs, monitor execution status, cancel executions, and manage SmartConnector SQL outside of the Kizen UI.

How SmartConnectors Are Exposed Programmatically

SmartConnectors are available through APIs and supporting developer tools in ways that align with their execution lifecycle:

• File and webhook ingestion endpoints support triggering runs from external systems and pipelines

• Execution status endpoints provide visibility into in-progress and completed runs

• Cancellation endpoints allow orchestration logic to stop a run that should not complete

• The dev package allows a SmartConnector to be executed locally for debugging and iteration

All API behavior respects SmartConnector configuration, permissions, and execution state, ensuring consistent behavior across the UI, external integrations, and automated pipelines.

When to Use the APIs

In general:

• Use the APIs when you need to trigger, monitor, or cancel SmartConnector runs from external systems or automated workflows

• Use the dev package when you need to reproduce and debug a SmartConnector execution locally

---

API Topics in this Section

• File Upload (Trigger Run) API (Topic Coming Soon)

• Webhook Trigger API (Topic Coming Soon)

• Execution Status API (Topic Coming Soon)

• Cancel Execution API (Topic Coming Soon)

Note: Canceling an execution does not roll back data that has already been processed. Records committed before cancellation remain in their post-execution state. Plan cancellation logic accordingly.

Developer Tools

In addition to the API endpoints above, a developer tool supports SmartConnector workflows outside the UI:

• Dev Package: A downloadable bundle containing a SmartConnector's SQL script, configuration, and input data for local execution. The package can be downloaded from the UI or via API. If source_file_id is specified, the package is pre-loaded with the input file from that execution; if not, the package is pre-loaded with the sample file.

For full setup, usage, and deployment guidance for both tools, see Build with SmartConnectors (Topic Coming Soon).

---

What's Next

Review the individual topics in this section to learn how to work with specific SmartConnector endpoints and developer tools. Each page includes endpoint details, examples, and usage considerations. The File Upload (Trigger Run) API (Topic Coming Soon) is the most commonly used programmatic entry point and is a good starting point for developers new to the SmartConnector API surface.