Skip to main content

Configure Basic Authentication Credentials

Configure a Credential that generates a Basic Authentication header from a username and password.

Configure Basic Authentication Credentials

Use a Basic Authentication Credential when the external API expects a username and password in the standard HTTP Basic format.

Payloads takes the username and password from the Credential and generates an Authorization header for the outbound request. The Payload only needs to reference the Credential.

Before you start

Confirm that the external API uses Basic Authentication and that the username and password are active for the API environment you are calling.

Basic Authentication is usually environment-specific. A sandbox username and password may not work against a production endpoint.

Configure the Credential

Create a Credential from the relevant Integration.

Set Type to Basic Authentication.

Enter the Username and Password supplied by the external system.

Save the Credential and review the Generated Headers section.

A Basic Authentication Credential record showing username, masked password, and generated Authorization header output.

Payloads generates the Basic Authorization header from the username and password on the Credential.

Attach it to a Payload

Open the outbound Payload that should use the username and password.

Select the Credential in the Payload header fields, then save the Payload.

Keep the generated Authorization header on the Credential. Do not recreate it manually on the Payload's Headers tab.

What to check

Before testing, check that:

  • the endpoint environment matches the username and password

  • the Payload has this Credential selected

  • no duplicate Authorization header exists on the Payload

  • the external API still supports Basic Authentication for the endpoint you are calling

After a test run, open the Job record and check the response status. A 401 or 403 response usually means the username, password, endpoint environment, or account permissions need to be reviewed.

Did this answer your question?