For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HUMAN DashboardHUMAN WebsiteRequest a Demo
Product GuidesEnforcer GuidesMobile SDKAPI ReferenceCustomer support
Product GuidesEnforcer GuidesMobile SDKAPI ReferenceCustomer support
  • General
    • About Enforcers
    • Support first-party HUMAN calls
    • Troubleshoot Enforcer configurations
  • Enforcer frameworks
    • Akamai ESI
    • Apache - C Module
    • ASP.NET
    • Callout Enforcer
    • Envoy Proxy
    • F5 BIGIP
    • Fastly JavaScript Compute@Edge
      • Fastly VCL changelog
        • Installing the Enforcer
        • GraphQL Support
        • Sensitive GraphQL Operations
        • Basic Configuration
        • Customized Subroutines
        • Additional Activity Handler
        • Advanced Blocking Response
        • Creating and Configuring the Edge-Dictionary
        • Custom CSS
        • Custom First Party Sensor Endpoint
        • Custom Logo
        • Custom JS Script
        • Custom Parameters
        • Filter Requests
        • Filter by HTTP Method
        • Filter by Route
        • Filter by Extension
        • Filter by IP
        • Filter by User Agent
        • Data Enrichment
        • First Party
        • First Party Snippet
        • Enforced Routes
        • Login Credentials Extraction
        • Modify First Party Response
        • Module Context Object
        • Module Enabled
        • Module Mode
        • Monitored Routes
        • Returning A Custom Block Page
        • Sensitive Routes
        • Test Block Flow on Monitoring Mode - Bypass Monitor Header
        • Upgrading the Enforcer
    • Google Cloud Platform (GCP) Callout Enforcer
    • Kong Plugin
    • NGINX - C Module
    • NGINX - LUA Module
    • PHP
    • Python
    • Ruby
    • Salesforce Commerce Cloud Cartridge
LogoLogo
Login
Login
HUMAN DashboardHUMAN WebsiteRequest a Demo
On this page
  • Custom Parameters
Enforcer frameworksFastly VCLV9 and Below

Custom Parameters

Was this page helpful?
Previous

Filter Requests

Next
Built with

Custom Parameters

The Custom Parameters function allows you to enrich activities sent from your Enforcer with additional data.

This may include user ID, session ID, or other parameters that you think HUMAN should have access to. The number of custom parameters is limited to 10.

Custom parameters are added as HTTP headers to the requests in the following format:

X-PX-custom-param#, where # is replaced with numbers 1 - 10

(e.g., X-PX-custom-param1, X-PX-custom-param2, … up to X-PX-custom-param10).

You must set custom parameters both on the HUMAN Portal and in the Enforcer’s px_custom.vcl file. The number and type of custom parameters in both settings must be the same.

TO set custom parameters:

  1. Open the PX_CUSTOM.vcl file.
  2. Add the required parameters using the following format:

Example

1sub px_custom_add_custom_parameters {
2 set req.http.X-PX-custom-param1 = "hardcoded_value";
3 set req.http.X-PX-custom-param2 = req.method;
4 set req.http.X-PX-custom-param3 = req.http.X-Custom-Header;
5}