Connectors
Audience:
Low-code Engineers,System/Security AdministratorsSkill Prerequisites:
Actions,Tokens,Connectors
The Connectors actions manage connectors from an action list instead of by hand on the Connectors page. A connector stores the server details, keys and passwords that other actions and triggers use to reach a remote service, such as a database, a mailbox, Salesforce or Stripe. With these actions you can create, read, update, test and delete connectors and connector groups of any type, for example so each customer can save its own account from a setup form.
These actions need the Advanced Security feature (Enterprise) in your license.
Choosing an action
| Action | What it does | Use it to |
|---|---|---|
| Add Connector | Creates a connector of any type in the type's default group and returns its ID. | Save an API key or connection string from a form or setup workflow. |
| Update Connector | Changes only the properties you set on a connector of any type. The others keep their values. | Replace a rotated API key or point a connection to a new server. |
| Get Connector | Reads a connector's ID, name, group and property values into tokens. Secure values come back as ******. | Show non-secret settings, or check that a connector ID points to a connector. |
| Get User Connector | Returns the ID of the connector linked to a user in a group. | Look up a user's own connector. In 1.28, new connectors aren't linked to users. |
| Delete Connector | Permanently removes a connector by its ID. | Remove a customer's connector when they close their account. |
| Test Connector | Checks that a connector can connect to its service and saves the result in tokens. | Check a connector right after adding or updating it, or on a schedule. |
| Add Group | Creates a connector group for one connector type and returns its ID. | Create a group for a new customer, then add its connectors to it. |
| Find Group | Finds a group by type and title and returns its ID, or an empty token. | Get a group ID before adding a connector, or check whether a group exists. |
Type-specific connector actions
Some add-ons also have Add and Update actions for their own connector type, with one field for each setting. They're listed under the add-on:
They need the add-on's license feature instead of Advanced Security. In 1.28, Add and Update Imap Connector and Add and Update Fedex Connector fail in apps. Use the generic actions for those types.
Generic or type-specific actions?
- Generic (Add Connector, Update Connector). They work with any connector type. You set properties by their property IDs, as Name and Value pairs or as JSON. Add Connector always uses the type's default group, and neither action can set custom data. Update Connector only changes the properties you set, and keeps the connector's name.
- Type-specific. They have one field for each setting and add the connector to a group you choose. The Update actions replace everything: an empty field clears the saved value, and custom data you don't list again is removed. To keep a saved password or key without knowing it, pass
******. They don't check the connector type, so make sure the ID belongs to the right type. - Custom data. For types that support custom data, such as Salesforce, use the type-specific actions. Updating them with Update Connector deletes their custom data.
Groups and IDs
Every connector belongs to a group, and every group holds connectors of one type. The actions are linked by the IDs they return, so save them in tokens or with your records:
- The group ID, a number, comes from Add Group or Find Group. The type-specific Add actions need it. Group titles are unique per type, so run Find Group first and only add the group if its token is empty.
- The connector ID, a GUID, comes from the
EntryId Token Nameof the Add actions, or from Get User Connector. Update, Get, Test and Delete need it. - Names aren't unique. Running an Add action twice creates two connectors, so use the ID to tell them apart.
Testing and secrets
- Nothing is tested when you save. The Add and Update actions save wrong keys and passwords without an error. Run Test Connector afterward, or Test IMAP Connector for IMAP.
- Not every type can be tested. Stripe, PushWoosh, POP3, Fedex and Google Service Account connectors aren't supported by Test Connector. Some tests have side effects: SMTP sends a real email and Slack posts a real message.
- Secrets stay masked. Get Connector returns secure values as
******. Pass keys and passwords into the actions through tokens, for example from a password field, instead of typing them into the action. - Deleting can't be undone. Make sure users can only pass in IDs of their own connectors to Delete Connector and the Update actions.
Connectors are used by actions in the Email group and in add-ons such as Salesforce, Stripe, UiPath, Slack and Twilio, and by the IMAP and POP Mail triggers of Email Sync.
Revised 10/02/2026