Custom Request Headers allow you to add specific HTTP headers to your account for use in audits and journeys. This feature is particularly useful for accessing testing environments, providing authentication, or adding metadata to your HTTP requests.
What Are Custom Request Headers?
Custom request headers are user-defined headers that are automatically included in HTTP requests made by ObservePoint during audits and journeys. They can help you:
Test secured environments by including authentication tokens.
Add headers for A/B testing.
Debug or configure specific web application behaviors.
These headers are configured in a new library within your ObservePoint account and are automatically applied to all audits and journeys. However, you have the flexibility to configure individual audits or journeys to ignore custom headers when needed.
How to Add Custom Request Headers
Follow these steps to add and configure custom request headers in ObservePoint:
Access the Custom Headers Library:
Log in to your ObservePoint account.
Navigate to the Custom Headers section under the Configuration menu.
Create a New Custom Header:
Click the Add Custom Header button.
Provide a name for the header (e.g., “Authorization Header”).
Define the key-value pair for the header (e.g., Authorization: Bearer <your-token>).
Add one or more URL patterns to specify where the custom header should apply:
Example: example.com/category/*/product.
Check the “Allow all subdomains on this URL” box if applicable.
Save Your Custom Header: Once configured, click Save. The header will now be available in the custom headers library.
Automatic Application: All audits and journeys will automatically include the configured custom headers for matching URL patterns.
Configuring an Audit or Journey to Ignore Custom Headers
If you need to exclude custom headers from a specific audit or journey:
Open the Audit or Journey
Access Additional Setup Options: Locate the option labeled “Ignore Custom Headers” in the audit or journey’s settings.
Save the Configuration
Tips for Using Custom Headers
Testing Authentication: Use headers like Authorization to test APIs or secured environments.
Environment-Specific Headers: Configure headers specific to staging or production environments by using targeted URL patterns.
Debugging: Add headers that trigger logging or debugging on your server to troubleshoot issues.
Frequently Asked Questions
Can I configure multiple headers for the same request URL?
Yes, you can configure multiple headers for the same URL pattern. Each custom header operates independently.What happens if a header conflicts with server-side settings?
If a conflict arises, the behavior will depend on how your server processes headers. Ensure your headers are consistent with your server’s configuration.Are custom headers applied to redirects?
Custom headers are applied only to the initial request and any subsequent requests that match the configured URL patterns.
Need Help?
If you have questions or encounter issues while configuring custom headers, feel free to contact our support team.
By leveraging custom headers, you can ensure precise and tailored testing for your audits and journeys, making your ObservePoint experience even more powerful and efficient.