📅 Date and Time Parameters

Use {{%format}} format to define date and time parameters:

• {{%Y-%m-%d}} - Current date, format: 2006-01-02 (e.g., 2025-09-22)
• {{%H:%M:%S}} - Current time, format: 15:04:05 (e.g., 17:30:45)
• {{%s}} - Unix timestamp (e.g., 1727859600)
• {{%Y}} - Current year (e.g., 2025)
• {{%m}} - Current month, format: 01-12
• {{%d}} - Current date, format: 01-31
• {{%H}} - Current hour, format: 00-23
• {{%M}} - Current minute, format: 00-59
• {{%S}} - Current second, format: 00-59
• {{%B}} - Full month name (e.g., September)
• {{%b}} - Short month name (e.g., Sep)
• {{%A}} - Full weekday name (e.g., Monday)
• {{%a}} - Short weekday name (e.g., Mon)

🎲 Random Number Parameters

• {{rand}} - Generate random number in range 0-1000000
• {{rand_int}} - Generate large range random integer
• {{rand(min,max)}} - Generate random number in specified range
  • Example: {{rand(1,100)}} - Generate random number between 1-100
  • Example: {{rand(1000,9999)}} - Generate 4-digit random number

🔤 Random String Parameters

• {{rand_str}} - Generate 8-character random string (letters + numbers)
• {{rand_str(length)}} - Generate random string of specified length
  • Example: {{rand_str(16)}} - Generate 16-character random string
• {{rand_str_secure}} - Generate 16-character cryptographically secure random string
• {{rand_hex(length)}} - Generate hexadecimal random string of specified length
  • Example: {{rand_hex(8)}} - Generate 8-character hexadecimal string
  • Example: {{rand_hex(32)}} - Generate 32-character hexadecimal string

🆔 UUID Parameters

• {{uuid}} - Generate standard UUID (with hyphens)
  • Example: bf3655f7-8a93-4822-a458-2913a6fe4722
• {{uuid_short}} - Generate short UUID (without hyphens)
  • Example: 14d44b7334014484bb81b015fb2401bf

🌍 Environment Variable Parameters

• {{env(variable_name)}} - Read environment variable value
  • Example: {{env(API_KEY)}} - Read API_KEY environment variable
  • Example: {{env(VERSION)}} - Read VERSION environment variable
  • Returns empty string if environment variable doesn't exist

Environment variables can be set through GitHub Actions Repository Secrets

📊 Sequence and Hash Parameters

• {{seq}} - Time-based sequence number (6 digits)
• {{seq_daily}} - Daily sequence number (seconds since midnight)
• {{hash_short}} - Short hash value (6-character hexadecimal)
• {{hash_md5_like}} - MD5-style long hash value (32-character hexadecimal)

🌐 Network and System Information Parameters

• {{local_ip}} - Get system local IP address
• {{hostname}} - Get system hostname
• {{user_agent}} - Generate random User-Agent string
• {{http_method}} - Generate random HTTP method (GET, POST, PUT, DELETE, etc.)

🔐 Encoding and Decoding Parameters

• {{base64(content)}} - Base64 encode the provided content
  • Example: {{base64(hello world)}} - Encode "hello world" to Base64
• {{url_encode(content)}} - URL encode the provided content
  • Example: {{url_encode(hello world)}} - URL encode "hello world"
• {{json_escape(content)}} - JSON escape the provided content
  • Example: {{json_escape("test")}} - Escape quotes and special characters for JSON

🔢 Mathematical Operation Parameters

• {{add(a,b)}} - Add two numbers
  • Example: {{add(10,5)}} - Returns 15
• {{sub(a,b)}} - Subtract two numbers
  • Example: {{sub(10,5)}} - Returns 5
• {{mul(a,b)}} - Multiply two numbers
  • Example: {{mul(10,5)}} - Returns 50
• {{div(a,b)}} - Divide two numbers
  • Example: {{div(10,5)}} - Returns 2

📝 Text Processing Parameters

• {{upper(text)}} - Convert text to uppercase
  • Example: {{upper(hello)}} - Returns "HELLO"
• {{lower(text)}} - Convert text to lowercase
  • Example: {{lower(HELLO)}} - Returns "hello"
• {{reverse(text)}} - Reverse text
  • Example: {{reverse(hello)}} - Returns "olleh"
• {{substr(text,start,length)}} - Extract substring from text
  • Example: {{substr(hello world,0,5)}} - Returns "hello"

🎨 Color Generation Parameters

• {{color_hex}} - Generate random hexadecimal color code
  • Example: #FF5733
• {{color_rgb}} - Generate random RGB color value
  • Example: rgb(255, 87, 51)
• {{color_hsl}} - Generate random HSL color value
  • Example: hsl(120, 50%, 75%)

📁 File and MIME Type Parameters

• {{mime_type}} - Generate random MIME type
  • Example: application/json, image/png, text/html
• {{file_ext}} - Generate random file extension
  • Example: .jpg, .pdf, .txt

👤 Fake Data Generation Parameters

• {{fake_email}} - Generate realistic fake email address
  • Example: [email protected]
• {{fake_phone}} - Generate fake phone number
  • Example: +1-555-0123
• {{fake_name}} - Generate fake person name
  • Example: John Smith
• {{fake_domain}} - Generate fake domain name
  • Example: example-site.com

⏰ Time Calculation Parameters

• {{time_add(duration)}} - Add specified duration to current time
  • Example: {{time_add(1h)}} - Add 1 hour to current time
  • Example: {{time_add(30m)}} - Add 30 minutes to current time
  • Supported units: s (seconds), m (minutes), h (hours), d (days)
• {{time_sub(duration)}} - Subtract specified duration from current time
  • Example: {{time_sub(1d)}} - Subtract 1 day from current time
  • Example: {{time_sub(2h30m)}} - Subtract 2 hours 30 minutes from current time

PongHub supports the following notification methods:

• Default Notification - Notification through GitHub Actions workflow failure
• Email Notification - Send emails via SMTP with advanced security options
• Custom Webhook - Send to any HTTP endpoint with advanced configuration

To use, add a notifications configuration block in your config.yaml file:

notifications:
  enabled: true  # Enable notification functionality
  methods:       # Notification methods to enable
    - email
    - webhook

  # Specific configuration for each notification method...

⚙️ Default Notification

By default, PongHub will send notifications when GitHub Actions workflows fail.

Default notification is automatically enabled when:

• No notifications field is configured
• notifications.enabled: true but no methods specified or only non-email/webhook methods are specified
• Explicitly configured methods: ["default"]

If notifications is configured with email or webhook methods, default notification is disabled by default unless explicitly enabled in notifications.default.enabled.

📧 Email Notification

email:
  smtp_host: "smtp.gmail.com"       # SMTP server host
  smtp_port: 587                    # SMTP port, default is 587
  from: "[email protected]"     # Sender email address
  to:                               # Recipient email addresses
    - "[email protected]"
    - "[email protected]"
  subject: "PongHub Service Alert"  # Email subject (optional)
  use_tls: true                     # Use TLS encryption (optional)
  use_starttls: true                # Use STARTTLS (optional)
  skip_verify: false                # Skip TLS certificate verification (optional)
  timeout: 30                       # Connection timeout in seconds (optional)
  username: ""                      # SMTP username (optional, uses env var if empty)
  password: ""                      # SMTP password (optional, uses env var if empty)
  template: ""                      # Custom email template path (optional)
  is_html: true                     # Send as HTML email (optional)

Required environment variables:

• SMTP_USERNAME - SMTP username
• SMTP_PASSWORD - SMTP password

🔗 Custom Webhook Configuration

webhook:
  url: "https://your-webhook-endpoint.com/notify"  # Leave empty to read from environment variables
  method: "POST"                        # HTTP method (optional, default POST)
  headers:                              # Custom request headers (optional)
    Content-Type: "application/json"
    Authorization: "Bearer {{env(API_TOKEN)}}"  # Supports Special Parameters
    X-Request-ID: "{{uuid}}"           # Dynamic request ID using Special Parameters

  # Authentication options (all fields support Special Parameters)
  auth_type: "bearer"                   # Authentication type: bearer, basic, apikey (optional)
  auth_token: "{{env(WEBHOOK_TOKEN)}}"  # Bearer token with environment variable (optional)
  auth_username: "user-{{rand(1000,9999)}}"  # Basic auth username with dynamic suffix (optional)
  auth_password: "{{env(AUTH_PASSWORD)}}"     # Basic auth password from environment (optional)
  auth_header: "X-API-Key"              # Custom header name for API key (optional)

  # Request configuration
  timeout: 30                           # Request timeout in seconds (optional, default 30)
  retries: 3                            # Number of retry attempts (optional, default 0)
  skip_tls_verify: false                # Skip TLS certificate verification (optional)

  # Advanced payload customization with Special Parameters support
  custom_payload:                       # Custom request payload (optional)
    template: |
      {
        "alert": "{{.Title}}",
        "details": "{{.Message}}",
        "timestamp": "{{%Y-%m-%d %H:%M:%S}}",
        "request_id": "{{uuid}}",
        "environment": "{{env(ENVIRONMENT)}}",
        "random_id": "{{rand(10000,99999)}}"
      }
    content_type: "application/json"    # Content type for the payload (optional)
    fields:                             # Additional fields with Special Parameters support (optional)
      environment: "prod-{{rand(100,999)}}"
      session_id: "{{uuid_short}}"
      build_number: "{{env(BUILD_NUMBER)}}"
      timestamp_unix: "{{%s}}"
    include_title: true                 # Include title in additional fields (optional)
    include_message: true               # Include message in additional fields (optional)
    title_field: "alert_title"          # Custom field name for title (optional)
    message_field: "alert_message"      # Custom field name for message (optional)

Special Parameters Support in Webhooks:

Webhook configurations now fully support Special Parameters in the following fields:

• URL: url: "https://hooks.example.com/{{env(HOOK_ID)}}"
• Headers: All header values can use Special Parameters
• Authentication: All auth fields support dynamic values
• Templates: Both Go template syntax ({{.Title}}) and Special Parameters ({{uuid}}) work together
• Custom Fields: All custom payload fields support Special Parameters

Template Syntax Compatibility:

The webhook template system supports both syntaxes seamlessly:

• Go Template Syntax: {{.Title}}, {{.Message}} - Access notification data
• Special Parameters: {{uuid}}, {{%Y-%m-%d}}, {{env(VAR)}} - Dynamic values

Example combining both syntaxes:

custom_payload:
  template: |
    {
      "service_alert": "{{.Title}}",
      "description": "{{.Message}}",
      "alert_id": "{{uuid_short}}",
      "timestamp": "{{%Y-%m-%d %H:%M:%S}}",
      "environment": "{{env(DEPLOY_ENV)}}",
      "correlation_id": "{{rand_str(12)}}"
    }
  fields:
    datacenter: "{{env(DATACENTER)}}"
    version: "{{env(APP_VERSION)}}"

Required environment variables:

• WEBHOOK_URL - Custom Webhook URL (if url field is empty)
• Any environment variables referenced in Special Parameters (e.g., API_TOKEN, ENVIRONMENT)