Skip to main content

​
Overview

The Credentials page is a centralized vault for managing authentication data. By defining credentials once, you can link them to multiple agents (such as ERP, UI Automation, or No-Code agents) without exposing sensitive keys or passwords within the workflow logic.

​
Supported Authentication Types

The platform supports five distinct credential types to accommodate various security protocols and integration requirements.

​
1. No Auth

Used for public APIs or internal services that do not require authentication but still require a consistent endpoint.
  • Fields:
    • Name: A unique identifier for the credential.
    • Base URL: The root endpoint for the service.

​
2. API Key

The standard for most modern SaaS integrations. This method sends a static key within the request headers.
  • Fields:
    • Base URL: The root endpoint.
    • API Key Header Name: The header key (e.g., X-API-Key or Authorization).
    • API Key Value: The actual secret key.
    • Additional Headers: A JSON object for passing extra metadata (e.g., {"Content-Type": "application/json"}).

​
3. Basic Auth

Uses standard username and password encoding, commonly found in legacy systems or simple protected endpoints.
  • Fields:
    • Base URL: The root endpoint.
    • Username: The account identifier.
    • Password: The account password.
    • Custom Header Key: (Optional) Allows you to override the default Authorization header name if the target system requires a non-standard key.

​
4. Website

Specifically designed for UI Automation Agents. This stores credentials needed to log in to web portals through a browser interface.
  • Fields:
    • Username: The login email or handle.
    • Password: The login password.
  • Primary Use Case: Automatically logging into dashboards, legacy portals, or e-commerce sites.

​
5. OAuth2

A comprehensive implementation for secure, delegated authorization. This type handles complex handshakes and token refreshes.
FieldDescription
Auth URLThe endpoint used to obtain the access token.
Client ID / SecretThe unique identifiers provided by the service provider.
Access Token HeaderThe header key used in API calls (e.g., Authorization).
Token PrefixThe string preceding the token (e.g., Bearer).
Refresh Token(Optional) Token used to obtain a new access token when the current one expires.
Send as Basic AuthBoolean toggle to send Client ID/Secret in the Authorization header instead of the body.
Auth PayloadJSON object for additional parameters required during the token request.
Request HeadersJSON object for extra headers needed during real-time API calls.

​
Credential Mapping in Agents

Once a credential is saved, it becomes available in the Agent configuration dropdown.
Security Note: All credential values are encrypted at rest. Once saved, sensitive values like API keys and Passwords are hidden from the UI and only accessible by the execution engine during workflow runs.

​
Best Practices

  • Environment Separation: Create separate credentials for “Staging” and “Production” environments to prevent accidental data modification.
  • JSON Validation: When adding Additional Headers or Auth Payloads, ensure the JSON is valid to avoid runtime connection errors.
  • Website Auth: Ensure the UI Automation agent is configured to look for the specific input selectors that match the “Website” credential fields.