# SmartConnector Settings

{% hint style="success" %}
**Audience**: Administrators, Developers, Integrators, Solution Architects

**Purpose**: Explains how to document every configurable setting on a <code class="expression">space.vars.smartconnector</code> and what each one controls, so the <code class="expression">space.vars.smartconnector</code>'s operational and observability behavior can be configured correctly in production.
{% endhint %}

## Overview

Every <code class="expression">space.vars.smartconnector</code> 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.

<div data-with-frame="true"><figure><img src="/files/8ji4mtpp9Wf4esn4IzJ7" alt="" width="563"><figcaption></figcaption></figure></div>

***

## Settings

The settings control how a <code class="expression">space.vars.smartconnector</code> 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 <code class="expression">space.vars.smartconnector</code> is eligible to execute. A <code class="expression">space.vars.smartconnector</code> 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 <code class="expression">space.vars.smartconnector</code> 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 <code class="expression">space.vars.Kizen\_company\_name</code> UI. It can be changed at any time without affecting the <code class="expression">space.vars.smartconnector</code>'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 <code class="expression">space.vars.smartconnector</code> is in use. While it can technically be changed via a direct API call, doing so is not recommended.

{% hint style="danger" %}
**Warning:** Changing the API Name after a <code class="expression">space.vars.smartconnector</code> is in use will break any downstream system or webhook URL that references it. Integrations, orchestration systems, and any external tooling calling the <code class="expression">space.vars.smartconnector</code> will need to be updated to use the new API Name before they resume working.
{% endhint %}

### Description

The Description is a free-text field for documenting what the <code class="expression">space.vars.smartconnector</code> does and any relevant context about its configuration or usage. It is visible to anyone who opens the <code class="expression">space.vars.smartconnector</code>.

The Description is also used by AI tools to understand the connector's purpose. A clear, specific description improves AI-assisted <code class="expression">space.vars.workflows</code> that interact with or reason about <code class="expression">space.vars.smartconnectors</code>.

### Max Concurrent Executions

Max Concurrent Executions controls how many executions may run simultaneously for a given <code class="expression">space.vars.smartconnector</code>. The value is a simple integer, and each setting has distinct behavior.

* **`0`** queues 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 <code class="expression">space.vars.smartconnector</code>.
* **`1`** is 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 <code class="expression">space.vars.smartconnector</code> 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.

{% hint style="info" %}
**Note:** Parallel execution with values higher than `1` carries data integrity risk if load steps touch overlapping <code class="expression">space.vars.entities</code>. When two executions write to the same <code class="expression">space.vars.entity</code> at the same time, the final state depends on timing rather than intent. The most valuable use case for parallel execution is create-only <code class="expression">space.vars.smartconnectors</code>, where each execution writes new <code class="expression">space.vars.entities</code> rather than updating existing ones, eliminating the risk of conflicting writes. Only use higher values when load steps are known to operate on disjoint data.
{% endhint %}

### Notification Emails

<code class="expression">space.vars.smartconnectors</code> 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 <code class="expression">space.vars.Kizen\_company\_name</code> 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 <code class="expression">space.vars.smartconnector</code> activity.

#### Payload Contents

The webhook payload includes:

* Execution ID
* Execution status
* Start and end time
* Initiating user
* Diff check setting
* <code class="expression">space.vars.entity</code> 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 <code class="expression">space.vars.automation</code> webhooks, or other orchestration systems that need to react to the completion of a <code class="expression">space.vars.smartconnector</code> run.

{% hint style="info" %}
**Note:** The Execution-Ended webhook cannot be used to trigger a <code class="expression">space.vars.Kizen\_company\_name</code> <code class="expression">space.vars.automation</code> or chain into another <code class="expression">space.vars.smartconnector</code>. The outbound webhook does not include authentication headers, which are required by <code class="expression">space.vars.Kizen\_company\_name</code>'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 <code class="expression">space.vars.Kizen\_company\_name</code>.
{% endhint %}

***

## What's Next

With a <code class="expression">space.vars.smartconnector</code> configured, named, and scheduled, the next operational consideration is who can create, edit, activate, and run it. <code class="expression">space.vars.smartconnector</code> Permissions covers the permission model for connectors and explains how runtime execution behavior differs from <code class="expression">space.vars.automations</code> in ways that affect field-level writes. Continue to <code class="expression">space.vars.smartconnector</code> Permissions **(Topic Coming soon)**

<details>

<summary>Related Topics</summary>

* [Running a SmartConnector](/docs/concepts/smartconnectors/running-a-smartconnector.md)
* SmartConnector Permissions **(Topic Coming soon)**
* Export, Import, and Duplication Reference **(Topic Coming soon)**
* SmartConnector Data Model **(Topic Coming soon)**

</details>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developer.kizen.com/docs/concepts/smartconnectors/smartconnector-settings.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
