External API Credentials

External API Credentials provides a secure, centralised way to store and reuse API credentials across multiple integrations.

Combined with the Liquid API Request component, it enables fully managed, authenticated communication with external services.

Found under 'Settings' > 'External API Credentials', you can store and manage all your API access details so they can be referenced securely via Liquid.

Create/Edit External API Credentials

To create External API Credentials, click the 'CREATE NEW' button at the top of the page and configure the settings as per below.

Settings

Name

A descriptive name to help you identify with the credentials.

Alias

The system name used for referencing the credentials.

Changing the alias will result in any existing references to the previous credential's alias breaking.

Authentication Type

Defines the application’s secure connection protocol.

Supported auth types include:

None
External API requires no authentication.

Basic
External API requires a standard Username and Password.

API Key
External API requires a key name/value pair (via HTTP Header or URL Query).

OAuth2
External API requires Client ID and Secret to return an auth token from a provided URL endpoint (with optional scope/s).

Check your external application's API documentation for credential requirements when setting up these details.

Once your credential item has been created, you'll be able to reference it by Alias via the api_request component.

Admin User Roles

Access to these External API Credentials via the admin can also be controlled via Admin User Roles, allowing you to manage which Admin Users can view or edit these settings.