​

Webhookevent Receiver

​

Supported Telemetry

​

Overview

​

Configuration

Note: This receiver was renamed from webhookevent to webhook_event to match the snake_case naming convention. The deprecated component type webhookevent is still accepted as an alias and will log a deprecation warning.

• endpoint (no default): The endpoint where you may point your webhook to emit events to

• path (default: ‘/events’): Path where the receiver instance will accept events
• health_path (default: ‘/health_check’): Path available for checking receiver status
• read_timeout (default: ‘500ms’): Maximum wait time while attempting to read a received event
• write_timeout (default: ‘500ms’): Maximum wait time while attempting to write a response
• required_header (optional):
  • key (required if required_header config option is set): Represents the key portion of the required header.
  • value (required if required_header config option is set): Represents the value portion of the required header.
• split_logs_at_newline (default: false): If true, the receiver will create a separate log record for each line in the request body.
• split_logs_at_json_boundary (default: false): If true, the receiver will parse the request body to JSON and send each object as a log. Splitting on new line overrides json boundary so only enable one at a time.
• convert_headers_to_attributes (optional): add all request headers (excluding required_header if also set) log attributes
• header_attribute_regex (optional): add headers matching supplied regex as log attributes. Header attributes will be prefixed with header.
• max_request_body_size (default comes from confighttp module): Maximum size in bytes for request body. Requests exceeding this limit will be rejected with an error.
• hmac_signature (optional): HMAC-SHA256 hex digest signature verification for webhook payloads. Compatible with GitHub webhook signatures and Fingerprint webhook signatures.
  • secret (required if hmac_signature is set): The shared secret used to compute the HMAC-SHA256 digest.
  • header (required if hmac_signature is set): The HTTP header name containing the signature (e.g. X-Hub-Signature-256 for GitHub, fpjs-event-signature for Fingerprint).
  • prefix (required if hmac_signature is set): The prefix before the hex digest in the header value (e.g. sha256= for GitHub, v1= for Fingerprint).

​

Split logs at newline example

{
"name": "francis",
"city": "newyork"
}
a fifth line

{ "name": "francis", "city": "newyork" }
{ "name": "john", "city": "paris" }
a third line

​

Split logs at JSON boundary example

{ "name": "francis", "city": "newyork", "multiple lines?": "you 
know it!"}
{ "name": "john", "city": "paris" }{ "name": "tim", "city": "london" }

​

HMAC Signature Verification

​

GitHub webhook example

receivers:
    webhook_event:
        endpoint: localhost:8088
        path: "/github/webhooks"
        hmac_signature:
            secret: "your-github-webhook-secret"
            header: "X-Hub-Signature-256"
            prefix: "sha256="

​

Fingerprint webhook example

receivers:
    webhook_event:
        endpoint: localhost:8088
        path: "/fingerprint/webhooks"
        hmac_signature:
            secret: "your-fingerprint-webhook-secret"
            header: "fpjs-event-signature"
            prefix: "v1="

​

Configuration Example

receivers:
    webhook_event:
        endpoint: localhost:8088
        read_timeout: "500ms"
        path: "eventsource/receiver"
        health_path: "eventreceiver/healthcheck"
        required_header:
            key: "required-header-key"
            value: "required-header-value"
        split_logs_at_newline: false
        max_request_body_size: 1000000000

​

Configuration

​

Example Configuration

# each webhook will require its own webhook event receiver
webhookevent/valid_config:
  endpoint: localhost:8080
  read_timeout: "500ms"
  write_timeout: "500ms"
  path: "some/path"
  health_path: "health/path"
  required_header:
    key: key-present
    value: value-present