Credentials Overview
Credentials keep authentication separate from the Payloads that use it.
Create one Credential for each external authentication method you need, then attach that Credential to any Payload that should use it. This keeps the API key, token, certificate name, username, password, or custom authentication value in one place instead of repeating it across several Payload records.
Use Credentials for outbound calls. A Credential can add the required authentication header, URL parameter, or certificate configuration when Payloads sends the request.
Choose the Credential type
Start by choosing the type that matches the external API.
API Key: use this when the API expects a fixed value in a request header, such as
Authorizationorx-api-key.Basic Authentication: use this when the API expects a username and password encoded into an
Authorizationheader.Bearer Token: use this when the API expects an
Authorization: Bearer ...header and the token may need to be refreshed.Custom: use this when the API expects a non-standard authentication header or URL parameter.
Certificate: use this when the API expects a Salesforce certificate to be used for the outbound call.
For a compact field-by-field comparison, see Credential type reference.
Create the Credential
Open the Integration that owns the API configuration, then create the Credential from that Integration.
Give the Credential a clear name that describes the external system and purpose. Names such as Stripe Test API Key, Warehouse Basic Login, or ERP Client Certificate are easier to review later than generic names such as Production Key.
Set the Type first. Payloads shows the fields that apply to that type.
Enter the authentication values required by the external API. Credential values are masked after they are saved, so check the generated output on the record to confirm the header or parameter Payloads will create.
A Credential record keeps the authentication setup with the Integration and shows the generated output Payloads will apply at runtime.
Attach the Credential to a Payload
Open the Outbound Payload and select HTTP Request in Actions.
Edit Request Settings.
Choose the Credential and save the settings section.
Use the HTTP Request Body, Headers and Parameters sections for request-specific values. Avoid adding a second authentication header or parameter that duplicates the Credential.
Run a controlled request and open the Job’s HTTP Request and HTTP Response Actions to inspect the outcome.
What to check
Before testing, check that:
the Credential belongs to the same Integration as the Payload
the Credential Type matches the external API's authentication method
the generated header or parameter has the expected name
the Payload has the Credential selected
the external API documentation agrees with the Credential placement
After a test run, open the Job record and review the outbound request details, response status, and response body.
Credential type guides
Use the type-specific guide that matches the API you are configuring: