Credentials

Credentials play a crucial role in configuring authentication and connection details for your integrations and listeners.

Their use is highly recommended to do not include any sensitive information in the plain source code.

tip

If for some reason you can't use credentials to init one integration, you could also take advantange of team variables, but you should NEVER include sensitive information in your source code.

You can create as many credentials as needed, and each must have a unique name.

Creating a Credential

To create a new credential, you can initiate the process from the Credentials page by clicking the New button at the top-right of the screen. Additionally, while editing a process code, you can start creating a new credential by clicking the Add button in the Credentials section on the right sidebar.

The credential creation form will then appear. Define the credential by selecting the integration or listener type and providing the required information. Each integration page contains a Credential Configuration section explaining how to fill and obtain the necessary form data.

Using a Credential

Once a credential is defined, you can utilize it in your source code. Snippet suggestions are available for each integration or listener, and a sample usage might look like:

JavaScript

New Snowflake integration using a credential

const snowflakeClient = yepcode.integration.snowflake("my-company-snowflake");

New IMAP listener using a credential

const mailListener = yepcode.listener.imap("my-mail-server");

note

Currently this integration helper only supports plain strings. Expressions or passing a value through a variable is not supported. Therefore, the code examples below will NOT work.

❌ This doesn't work

let credentialName = "my-company-snowflake";
const snowflakeClient = yepcode.integration.snowflake(credentialName);

❌ This doesn't work

const snowflakeClient = yepcode.integration.snowflake(
  environment === "production"
    ? "my-company-snowflake"
    : "my-company-snowflake-staging"
);

Python

New snowflake integration from credential

snowflake_client = yepcode.integration.snowflake("my-company-snowflake");

New SQS listener using a credential

const sqsListener = yepcode.listener.awsSqs("my-sqs-queue");

note

Currently this integration helper only supports plain strings. Expressions or passing a value through a variable is not supported. Therefore, the code examples below will NOT work.

❌ This doesn't work

credential_name = "my-company-snowflake";
snowflake_client = yepcode.integration.snowflake(credential_name);

❌ This doesn't work

snowflake_client = yepcode.integration.snowflake(
  "my-company-snowflake" if environment === "production" else "my-company-snowflake-staging"
);