Webhook Relay

Learn about configurations >

• auth-pass | string

  Admin password for /admin endpoint (server mode only)

• auth-user | string

  Default: admin

  Admin username for /admin endpoint (server mode only)

• base-path | string

  Base path for the webhook relay endpoints (server mode only)

• channel0 | string

  Channel ID for channel 0 (server mode only). MUST be exactly 40-character hexadecimal string (SHA1 format). Generate with: uuidgen | sha1sum | awk '{print $1}' Used as webhook URL path: http://server:port/{channel0}

• channel1 | string

  Channel ID for channel 1 (server mode only). MUST be exactly 40-character hexadecimal string (SHA1 format).

• channel2 | string

  Channel ID for channel 2 (40-char hex SHA1, webhook mode only)

• channel3 | string

  Channel ID for channel 3 (40-char hex SHA1, webhook mode only)

• channel4 | string

  Channel ID for channel 4 (40-char hex SHA1, webhook mode only)

• channel5 | string

  Channel ID for channel 5 (40-char hex SHA1, webhook mode only)

• channel6 | string

  Channel ID for channel 6 (40-char hex SHA1, webhook mode only)

• channel7 | string

  Channel ID for channel 7 (40-char hex SHA1, webhook mode only)

• channel8 | string

  Channel ID for channel 8 (40-char hex SHA1, webhook mode only)

• channel9 | string

  Channel ID for channel 9 (40-char hex SHA1, webhook mode only)

• forward | string

  HTTP POST URL to forward webhook payloads (client mode only). If specified, decrypted webhook payloads will be POSTed to this URL instead of being printed to stdout. Ping events are never forwarded.

• host | string

  Default: 0.0.0.0

  Host address to bind the webhook server (server mode only)

• key | string

  RSA private key PEM for decryption (client mode only)

• key0 | string

  RSA public key PEM for channel 0 encryption (server mode)

• key1 | string

  RSA public key PEM for channel 1 encryption (server mode)

• key2 | string

  RSA public key PEM for channel 2 encryption (server mode)

• key3 | string

  RSA public key PEM for channel 3 encryption (server mode)

• key4 | string

  RSA public key PEM for channel 4 encryption (server mode)

• key5 | string

  RSA public key PEM for channel 5 encryption (server mode)

• key6 | string

  RSA public key PEM for channel 6 encryption (server mode)

• key7 | string

  RSA public key PEM for channel 7 encryption (server mode)

• key8 | string

  RSA public key PEM for channel 8 encryption (server mode)

• key9 | string

  RSA public key PEM for channel 9 encryption (server mode)

• mode | string

  Default: server

  Operation mode: 'server' (relay server) or 'client' (relay client).

  • server: Run as SSE webhook relay server
  • client: Run as relay client connecting to a webhook server

• ping-interval-ms | int

  Default: 7500

  Ping interval in milliseconds for heartbeat (server mode only)

• port | int

  Default: 3000

  Port to bind the webhook server (server mode only)

• public-path | string

  Public path prefix for the application (server mode only)

• secret0 | string

  Secret key for channel 0 signature validation (server mode)

• secret1 | string

  Secret key for channel 1 signature validation (server mode)

• secret2 | string

  Secret key for channel 2 signature validation (server mode)

• secret3 | string

  Secret key for channel 3 signature validation (server mode)

• secret4 | string

  Secret key for channel 4 signature validation (server mode)

• secret5 | string

  Secret key for channel 5 signature validation (server mode)

• secret6 | string

  Secret key for channel 6 signature validation (server mode)

• secret7 | string

  Secret key for channel 7 signature validation (server mode)

• secret8 | string

  Secret key for channel 8 signature validation (server mode)

• secret9 | string

  Secret key for channel 9 signature validation (server mode)

• url | string

  SSE endpoint URL to connect to (client mode only)