Build custom authentication

This is an Early Access feature for existing Workflows users. To enable it, use the Early Access Feature Manager as described in Manage Early Access and Beta features.

Custom authentication allows you to collect any information from the user that needs to be included in an API request. A common example is the use of API Keys (api_key) that get managed in a third party system and are passed into an HTTP request along with other header object keys and values. These can be built out using the Auth Fields section detailed below.

To add custom authentication:

  1. Click the Overview tab.

  2. Click Set up authentication.

  3. From the Authentication dialog, in the Auth Type dropdown, select Custom.

  4. In the Parameters section, click Add Parameter.

  5. Add values to the following fields:

    • Label: Display name that shows on the New Connection dialog during connector set up.

    • Key: Text value in the key-value pairing that is used by the service. For example, api_key, application_key, or authentication.

    • Type: Three different field types are available.

      • Text: A plain text field will be presented to the user. This is an open text field with no redaction.

      • Password: A redacted text field. The user will not be able to see what is entered into this field.

      • Dropdown List: A manually created dropdown of values to be selected by the user.

Field Definition
Parameters (Optional) Parameters allow you to collect any additional information from the connector user that may be necessary for authentication, such as instance or subdomain. These fields will be presented to the user when they first create a connection and will be required.

Label: The display name that shows on the New Connection dialog during connector set up.

Key: Text value in the key-value pairing that is used by the service. For example, api_key, application_key, or authentication.

Type: Three different field types are available.

  • Text: A plain text field will be presented to the user. This is an open text field with no redaction.

  • Password: A redacted text field. The user will not be able to see what is entered into this field.

  • Dropdown List: A manually created dropdown of values to be selected by the user.

Config Values (Optional)

Additional configuration values may be needed to define how a user authenticates to your connector. You can added such values in this section.

Label: Display name for the configuration value that shows on the New Connection dialog during connector set up.

Definition: Indicate whether this field will be populated with a static value or a value from a helper flow.

  • For Static Value, enter the value in the Value field.

  • For Value from Helper Flow, select a flow from the Choose Flow dialog.

Type: Two different field types are available.

  • Text: A plain text field will be presented to the user. This is an open text field with no redaction.

  • Password: A redacted text field. The user will not be able to see what is entered into this field.

The Visible toggle determines whether the configuration value will appear in the authentication dialog for the connector.

Next step

Add option fields to connector cards