Skip to main content

HTTP Webhook Module

The HTTP Webhook Module forwards webhook payloads to external HTTP endpoints.

Configuration​

{
"http_forward_webhook": {
"data_type": "json",
"module": "http_webhook",
"module-config": {
"url": "https://api.example.com/webhooks",
"method": "POST",
"headers": {
"Authorization": "Bearer {$API_TOKEN}",
"X-Custom-Header": "value"
},
"timeout": 30,
"forward_headers": false
},
"authorization": "Bearer token"
}
}

Module Configuration Options​

OptionTypeDefaultDescription
urlstringRequiredTarget HTTP endpoint URL
methodstring"POST"HTTP method: POST, PUT, or PATCH
headersobject{}Custom headers to include
timeoutinteger30Request timeout in seconds
forward_headersbooleanfalseForward incoming request headers
allowed_headersarray-Whitelist of headers to forward
allowed_hostsarray-Whitelist of allowed destination hosts
Supported Methods

Only POST, PUT, and PATCH methods are supported. GET and DELETE are not available for forwarding webhook payloads.

Security Features​

SSRF Protection​

URLs are validated to prevent Server-Side Request Forgery (SSRF):

  • Only http:// and https:// schemes allowed
  • Localhost and loopback addresses blocked
  • Private IP ranges blocked (RFC 1918)
  • Cloud metadata endpoints blocked (169.254.169.254)
  • Octal and hex IP encoding detected and blocked

Host Whitelist​

For additional security, restrict destinations to specific hosts:

{
"secure_forward": {
"module": "http_webhook",
"module-config": {
"url": "https://api.trusted.com/webhook",
"allowed_hosts": [
"api.trusted.com",
"backup.trusted.com"
]
}
}
}

When allowed_hosts is configured, SSRF checks are bypassed for whitelisted hosts only.

Header Sanitization​

Headers are sanitized to prevent HTTP header injection:

  • Hop-by-hop headers filtered (Host, Connection, Transfer-Encoding, etc.)
  • Newlines and control characters blocked
  • Header name/value length limits enforced

Header Whitelist​

Control which headers are forwarded:

{
"filtered_forward": {
"module": "http_webhook",
"module-config": {
"url": "https://api.example.com/webhook",
"forward_headers": true,
"allowed_headers": [
"content-type",
"x-request-id",
"x-correlation-id"
]
}
}
}

Features​

  • HTTP/HTTPS support
  • SSRF protection
  • Custom and forwarded headers
  • Header whitelist and sanitization
  • Timeout configuration
  • Environment variable substitution

Example​

Basic Forwarding​

{
"forward_to_api": {
"data_type": "json",
"module": "http_webhook",
"module-config": {
"url": "https://api.example.com/events",
"method": "POST",
"headers": {
"Authorization": "Bearer {$API_TOKEN}"
}
},
"authorization": "Bearer {$WEBHOOK_SECRET}"
}
}

With Header Forwarding​

{
"proxy_webhook": {
"data_type": "json",
"module": "http_webhook",
"module-config": {
"url": "https://downstream.example.com/webhook",
"method": "POST",
"forward_headers": true,
"allowed_headers": ["x-request-id", "x-trace-id"],
"timeout": 60
},
"authorization": "Bearer token"
}
}

In a Chain​

{
"multi_forward": {
"data_type": "json",
"chain": [
{
"module": "http_webhook",
"module-config": {
"url": "https://primary.example.com/webhook"
}
},
{
"module": "http_webhook",
"module-config": {
"url": "https://backup.example.com/webhook"
}
}
],
"chain-config": {
"execution": "parallel"
},
"authorization": "Bearer token"
}
}