Configure Custom Credentials
Use a Custom Credential when the external API expects an authentication value that does not fit the API Key, Basic Authentication, Bearer Token, or Certificate types.
Custom Credentials can place the value in either a request header or a URL parameter. Use the placement required by the external API.
Choose the placement
Choose Header when the API expects the value in an HTTP header.
Choose Parameter when the API expects the value in the query string.
Prefer Header when the API supports it. Query string authentication is visible in URLs, logs, and some monitoring tools, so only use Parameter when the external API requires it.
Configure a custom header
Create a Credential from the relevant Integration.
Set Type to Custom.
Set Placement to Header.
Enter the Header Name and Header Value.
Save the Credential and review the Generated Headers section.
A Custom header Credential sends the configured name and value as an outbound request header.
Configure a custom parameter
Create a Credential from the relevant Integration.
Set Type to Custom.
Set Placement to Parameter.
Enter the Parameter Name and Parameter Value.
Save the Credential and review the Generated Parameters section.
A Custom parameter Credential appends the configured name and value to the outbound request URL.
Attach it to a Payload
Open the outbound Payload that should use the custom value.
Select the Credential in the Payload header fields, then save the Payload.
Do not duplicate the same value on the Payload's Headers or Parameters tabs.
What to check
Before testing, check that:
the Placement matches the external API documentation
the header or parameter name is exact
the value includes any required prefix or formatting
the Payload has this Credential selected
the same header or parameter is not configured twice
After the first test run, open the Job record and check the response status and response body. If authentication fails, compare the generated header or parameter with the external API documentation.