Skip to main content

MySQL/MariaDB Module

The MySQL Module stores webhook payloads in MySQL or MariaDB databases with support for JSON, relational, or hybrid storage modes.

Configuration​

{
    "mysql_webhook": {
        "data_type": "json",
        "module": "mysql",
        "connection": "mysql_local",
        "module-config": {
            "table": "webhook_events",
            "storage_mode": "json",
            "upsert": true,
            "upsert_key": "event_id",
            "include_headers": true
        },
        "authorization": "Bearer db_secret"
    }
}

Connection Configuration​

In connections.json:

{
    "mysql_local": {
        "type": "mysql",
        "host": "localhost",
        "port": 3306,
        "database": "webhooks",
        "user": "root",
        "password": "password",
        "ssl": false
    }
}

Storage Modes​

JSON Mode (Default)​

Stores entire payload in JSON column:

{
    "storage_mode": "json"
}

Relational Mode​

Maps payload fields to table columns with schema validation:

{
    "storage_mode": "relational",
    "schema": {
        "event_id": "VARCHAR(255)",
        "event_type": "VARCHAR(100)",
        "timestamp": "DATETIME"
    }
}

Hybrid Mode​

Stores mapped fields in columns + full payload in JSON:

{
    "storage_mode": "hybrid",
    "schema": {
        "event_id": "VARCHAR(255)",
        "event_type": "VARCHAR(100)"
    }
}

Module Configuration Options​

  • table: Table name (required)
  • storage_mode: "json", "relational", or "hybrid" (default: "json")
  • upsert: Whether to use INSERT ... ON DUPLICATE KEY UPDATE (default: false)
  • upsert_key: Column name for upsert key
  • include_headers: Whether to include HTTP headers (default: false)
  • schema: Column definitions for relational/hybrid modes

Features​

  • Multiple storage modes
  • Automatic table creation
  • Upsert support
  • Connection pooling
  • Transaction support
  • Compatible with both MySQL and MariaDB