Test Connector

Audience: Low-code Engineers

Skill Prerequisites: Actions, Tokens, Connectors

Checks that a connector can connect to its remote service with the details it has stored. The result goes into tokens: whether the test passed, an error message and exception details. What the test does depends on the connector type, see What each type tests.

note

This action requires the Advanced Security feature (Enterprise) to be licensed. If it isn't, the action fails with a message that the feature is unlicensed.

Typical Use Cases

• Check a connector right after creating it with Add Connector or changing it with Update Connector
• Show users whether the details they entered in a form work
• Check connectors on a schedule and notify an administrator when one stops working

Don't use it to

• Read a connector's details. Use Get Connector instead.
• Test connector types that don't support testing, such as Stripe or PushWoosh. The result is always false.

Related Actions

Action Name	Description
Add Connector	Creates a new connector and returns its ID.
Update Connector	Changes the properties of a connector.
Get Connector	Reads the details of a connector into tokens.
Send Email	Sends an email, for example to report a failed test.

Input Parameter Reference

Parameter	Description	Supports Tokens	Default	Required
Connector	The connector to test. The list shows all connectors. When using an expression, the value must be the connector ID (a GUID), for example [ConnectorId].	Yes	empty string	Yes
Output Token Name	The name of the token to save the result in, for example TestResult. Brackets are optional.	No	empty string	No

Output Parameters Reference

Token	Description
[<Output Token Name>]	true if the test passed, otherwise false. Same as IsSuccess.
[<Output Token Name>:IsSuccess]	true if the test passed, otherwise false.
[<Output Token Name>:ErrorMessage]	The error message when the test failed. Some types leave it empty and only fill in Exception.
[<Output Token Name>:Exception]	The details of the exception that made the test fail, if there was one.

What each type tests

Connector type	Test
Database Connection	Opens a connection with the connection string.
SMTP	Sends a test email from the connector's host email to the current user's email, or to the host email if there's no current user.
Slack (WebHook)	Posts the message Integration successful. to the webhook.
OpenAI, Microsoft Azure OpenAI	Asks the service for its list of models.
Google VertexAI	Sends a short chat prompt.
Amazon Bedrock AI	Asks AWS for the list of foundation models.
Azure Bot	Requests a token from Microsoft. Fails only if the response is Unauthorized or Forbidden.
OpenLDAP Connection	Opens a connection to the LDAP server.
Dynamics Service Connector	Checks the Dynamics credentials.
Salesforce	Signs in with the username, password and security token.
UiPath	Signs in to the UiPath platform.
Stripe, PushWoosh, POP3, Google Service Account	Not supported. IsSuccess is false and ErrorMessage is Connector <name> does not support testing.
Other types	Not supported. The action fails with The handler type '<type>' for connector '<name>' is not valid.

Considerations

• Some tests have side effects. Testing an SMTP connector sends a real email, and testing a Slack connector posts a real message to the channel.
• The connector must exist. If no connector has that ID, the action fails with Connector not found.
• A failed test isn't always an error. Most types return IsSuccess = false and let the next actions continue. For some types, such as Salesforce and UiPath, a failed sign-in can raise an error instead. Wrap the action in Execute Actions and use its On Error actions if you need to handle both.
• Fill in Output Token Name. Without it, the result isn't saved under a name you can use.

Examples

tip

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

1. Test a connector and save the result

This action tests the connector whose ID is in [ConnectorId]. Afterward, [TestResult] is true or false, and [TestResult:ErrorMessage] explains a failure.

{
    "Title": "Test Connector",
    "ActionType": "Connectors.Test",
    "Description": "Check the new connector",
    "Parameters": {
        "EntryId": "[ConnectorId]",
        "OutputTokenName": "TestResult"
    }
}

2. Report a failed test

These actions test a connector, then stop with an error when the test fails.

{
    "Title": "Execute Actions",
    "ActionType": "ExecuteActions",
    "Description": "Test the connector and report failures",
    "Parameters": {
        "ActionList": [
            {
                "Title": "Test Connector",
                "ActionType": "Connectors.Test",
                "Parameters": {
                    "EntryId": "[ConnectorId]",
                    "OutputTokenName": "TestResult"
                }
            },
            {
                "Title": "Throw Exception",
                "ActionType": "ThrowException",
                "Condition": "[TestResult:IsSuccess] == \"False\"",
                "Parameters": {
                    "AdminMessage": "Connector [ConnectorId] failed its test: [TestResult:ErrorMessage]",
                    "FriendlyMessage": "We couldn't connect with the details you entered. Please check them and try again."
                }
            }
        ]
    }
}

Revised 09/26/2026