SmartConnector Settings
Audience: Administrators, Developers, Integrators, Solution Architects
Purpose: Explains how to document every configurable setting on a SmartConnector and what each one controls, so the SmartConnector's operational and observability behavior can be configured correctly in production.
Overview
Every SmartConnector has a set of configurable settings that control its identity, execution behavior, and notification handling. This page covers each setting in turn, along with the operational implications that matter most. A few of these settings carry meaningful risk if misconfigured; those are called out directly in the sections below.
Settings
The settings control how a SmartConnector is identified, scheduled, executed, and monitored. These settings apply to the ETL tool as a whole rather than to any individual step in the workflow.
Status
Status controls whether the SmartConnector is eligible to execute. A SmartConnector will only run when its status is set to one of the following values:
Operational
Operational - Needs Attention
Any other status value prevents execution. Scheduled runs and manual triggers will not proceed until the status is returned to an executable value
Name and API Name
Every SmartConnector has both a Name and an API Name. They serve different purposes and behave differently.
Name
The Name is the human-readable label displayed in the Kizen UI. It can be changed at any time without affecting the SmartConnector's execution behavior or any downstream systems that reference it.
API Name
The API Name is the stable, unique identifier used in API calls and webhook URLs. It is what external systems use to target the connector programmatically.
The API Name should not be changed after a SmartConnector is in use. While it can technically be changed via a direct API call, doing so is not recommended.
Warning: Changing the API Name after a SmartConnector is in use will break any downstream system or webhook URL that references it. Integrations, orchestration systems, and any external tooling calling the SmartConnector will need to be updated to use the new API Name before they resume working.
Description
The Description is a free-text field for documenting what the SmartConnector does and any relevant context about its configuration or usage. It is visible to anyone who opens the SmartConnector.
The Description is also used by AI tools to understand the connector's purpose. A clear, specific description improves AI-assisted Workflows that interact with or reason about SmartConnectors.
Max Concurrent Executions
Max Concurrent Executions controls how many executions may run simultaneously for a given SmartConnector. The value is a simple integer, and each setting has distinct behavior.
0queues all incoming executions. Nothing runs until the setting is changed to a higher value. This is the recommended way to temporarily pause processing without deactivating the SmartConnector.1is the default. Executions run sequentially; each queued execution waits for the previous one to finish before starting.Higher values allow parallel execution. Multiple executions of the same SmartConnector can run at the same time, up to the configured limit.
Reducing Max Concurrent Executions, including setting it to 0 , does not cancel in-flight executions. The new limit applies only to executions that have not yet started; anything already running continues to completion.
Note: Parallel execution with values higher than 1 carries data integrity risk if load steps touch overlapping Records. When two executions write to the same Record at the same time, the final state depends on timing rather than intent. The most valuable use case for parallel execution is create-only SmartConnectors, where each execution writes new Records rather than updating existing ones, eliminating the risk of conflicting writes. Only use higher values when load steps are known to operate on disjointed data.
Notification Emails
SmartConnectors support two optional notification email settings. Both are independent of the standard execution notification sent to the user who initiated the run.
Additional Notification Email: Sends an email to this address whenever any execution completes, regardless of outcome. This is sent in addition to the notification already sent to the initiating user.
Additional Error Notification Email: Sends an email only when an execution errors. Use this to route error alerts to a dedicated address without generating noise for successful runs.
Both fields accept a single email address. To notify multiple recipients, use an external distribution list address and manage membership there.
Webhook URL: Execution Ended
The Webhook URL: Execution Ended field holds a URL that Kizen calls with a full metadata payload each time an execution completes on both success and failure. It is the primary mechanism for triggering downstream systems in response to SmartConnector activity.
Payload Contents
The webhook payload includes:
Execution ID
Execution status
Start and end time
Initiating user
Diff check setting
Record counts
Output report download URL
Additional execution metadata
You can see the payload by viewing the "metadata" for the execution (via the 3-dot menu).
Common Uses
This webhook is commonly used to trigger Workato recipes, external Agentic Workflow webhooks, or other orchestration systems that need to react to the completion of a SmartConnector run.
Note: The Execution-Ended webhook cannot be used to trigger a Kizen Agentic Workflow or chain into another SmartConnector. The outbound webhook does not include authentication headers, which are required by Kizen's Webhook triggers. To chain execution downstream, route the webhook through a third-party tool that can attach the required auth headers before forwarding the request to Kizen.
What's Next
With a SmartConnector configured, named, and scheduled, the next operational consideration is who can create, edit, activate, and run it. SmartConnector Permissions covers the permission model for connectors and explains how runtime execution behavior differs from Agentic Workflows in ways that affect field-level writes. Continue to SmartConnector Permissions (Topic Coming Soon).
Last updated
Was this helpful?