Add Connector

Audience: Low-code Engineers

Skill Prerequisites: Actions, Tokens, JSON, Connectors

Creates a new connector of any type, for example a Database Connection or an OpenAI connector. You pick the connector type, give it a name and fill in its properties. The action can save the ID of the new connector in a token, so later actions can use, test or update it.

The connector is saved in the same place as the connectors you create on the Connectors page, so it shows up there too. All property values are stored encrypted.

note

This action is part of the Advanced Security feature (Enterprise). If your plan doesn't include it, the action editor shows the action as not part of your subscription.

Typical Use Cases

• Let a customer or department save its own API key or database connection string from a form
• Create connectors from a setup workflow instead of by hand on the Connectors page
• Save the new connector's ID, then check it right away with Test Connector

Don't use it to

• Change an existing connector. Use Update Connector instead.
• Check that the details work. The action saves them without contacting the remote service. Use Test Connector after saving.
• Add a connector to a specific group. This action always uses the type's default group. Use a type-specific action, such as Add Salesforce Connector, together with Add Group or Find Group.

Related Actions

Action Name	Description
Update Connector	Changes the properties of an existing connector.
Test Connector	Checks that a connector can connect to its service.
Get Connector	Reads the details of a connector into tokens.
Delete Connector	Removes a connector.

Input Parameter Reference

Parameter	Description	Supports Tokens	Default	Required
Connector Type	The type of connector to create. The list shows the connector types available on your installation. When using an expression, the value must be the Type Name, for example Database or openAi.	Yes	empty string	Yes
Connector Name	The name of the connector, as shown on the Connectors page, for example Reporting DB - [CompanyName].	Yes	empty string	No
Properties	The connector's properties, as Name and Value pairs. The Name list shows the properties of the selected connector type. Values can contain tokens.	Yes	empty	No
Dynamic Properties	A JSON object with property names and values, for example { "ApiKey": "[ApiKey]" }. Properties in this object override the same properties in Properties.	Yes	empty string	No
EntryId Token Name	The name of a token to save the new connector's ID in, for example NewConnectorId. Brackets are optional.	No	empty string	No

Output Parameters Reference

Parameter	Description
[<EntryId Token Name>]	The ID of the new connector, a GUID. It's only set when EntryId Token Name has a value.

How properties are combined

The action builds the connector's values from both Properties and Dynamic Properties. If a property is in both, the value from Dynamic Properties wins.

For example, with Properties set to Endpoint = https://example.com and ApiKey = [OldKey], and Dynamic Properties set to { "ApiKey": "[NewKey]" }, the connector gets Endpoint = https://example.com and ApiKey = [NewKey].

Only properties that belong to the connector type are saved. Other names are ignored without an error. Names must match the property IDs of the type exactly, including upper and lower case.

Considerations

• The type must exist. If Connector Type doesn't match a connector type, the action fails with Could not find the credential type with the provided name.
• Required properties must have a value. If a required property of the type is missing or empty, the action fails with Parameter '<property title>' is required. and nothing is saved.
• The details aren't tested. A wrong API key or connection string is saved without an error. Run Test Connector to check it.
• Names don't have to be unique. Running the action twice with the same name creates two connectors. Use the ID from EntryId Token Name to tell them apart.
• Custom data can't be set. Only the type's regular properties are saved. Types that support custom data, such as Salesforce, need their type-specific action for that.
• Keep secrets out of the action. Pass API keys, passwords and connection strings through tokens, for example from a form, instead of typing them into the action.
• Invalid JSON fails the action. Check that Dynamic Properties is a valid JSON object when you build it with tokens.

Examples

tip

To understand how to use the below examples, please see Running Examples.

1. Save a database connection from a form

This action creates a Database Connection connector named after the company, using the connection string from a form field. The new connector's ID is saved in [DbConnectorId].

{
    "Title": "Add Connector",
    "ActionType": "CredStore.AddConnectorEntry",
    "Description": "Save the customer's database connection",
    "Parameters": {
        "TypeName": "Database",
        "EntryName": "Reporting DB - [CompanyName]",
        "Properties": [
            {
                "PropertyName": "ConnectionString",
                "PropertyValue": "[ConnectionString]"
            }
        ],
        "PropertiesJson": "",
        "EntryIdTokenName": "DbConnectorId"
    }
}

2. Save an OpenAI connector with Dynamic Properties

This action creates an OpenAI connector and sets its API key from JSON. It runs only when the ApiKey token has a value.

{
    "Title": "Add Connector",
    "ActionType": "CredStore.AddConnectorEntry",
    "Description": "Save the customer's OpenAI key",
    "Condition": "[ApiKey] != \"\"",
    "Parameters": {
        "TypeName": "openAi",
        "EntryName": "OpenAI - [CompanyName]",
        "Properties": [],
        "PropertiesJson": "{ \"ApiKey\": \"[ApiKey]\" }",
        "EntryIdTokenName": "OpenAiConnectorId"
    }
}

Revised 09/26/2026