Feedple PHP SDK

composer require feedple/feedple-sdk

1. Stateless HTTP Webhook (Default for Production Web & Shared Hosting)
   Feedple Cloud ──[Signed HTTPS POST]──> Your App (/api/feedple/bridge) ──[Query]──> Database
   (Zero background daemons, zero persistent workers, runs within standard PHP-FPM/CGI request)

2. Persistent WebSocket Daemon (Local Dev & Dedicated VPS)
   Your Background Process (proc_open) ──[Outbound WSS Connection]──> Feedple Cloud
   (Continuous outbound daemon with auto-reconnection and background schema polling)

# Required: Feedple Workspace API Key
FEEDPLE_API_KEY=fdpl_live_your_actual_api_key

# Optional: Transport mode ('webhook' in production, 'websocket' in local dev)
FEEDPLE_TRANSPORT=webhook

# Optional: Bridge route path (defaults to /api/feedple/bridge)
FEEDPLE_BRIDGE_PATH=/api/feedple/bridge

# Optional: SSL Certificate verification (set false for self-signed certs or local Windows Apache)
FEEDPLE_VERIFY_SSL=true

php artisan feedple:sync

# Push schema and register/update webhook bridge URL
php artisan feedple:sync

# Force schema re-synchronization even if the local hash hasn't changed
php artisan feedple:sync --force

# Manually override the registered webhook bridge URL (e.g. for ngrok tunneling)
php artisan feedple:sync --bridge-url=https://xyz.ngrok-free.app/api/feedple/bridge

# Check SDK configuration, transport status, database connection, and recent logs
php artisan feedple:status

# Start the background WebSocket worker daemon (development mode)
php artisan feedple:start
php artisan feedple:start --tail

# Force start WebSocket daemon even if transport is configured for webhook mode
php artisan feedple:start --force

# Stop the background WebSocket daemon
php artisan feedple:stop

# (Optional) Publish configuration file for advanced customizations
php artisan vendor:publish --tag=feedple-config

curl http://localhost:8000/api/feedple/bridge

{
  "status": "active",
  "service": "Feedple Webhook Bridge",
  "transport": "webhook",
  "configured": true,
  "secret_set": true
}

# Display CLI status and connection health
./vendor/bin/feedple status

# View the last 25 lines of the SDK log file
./vendor/bin/feedple status --lines=25

# Synchronize database schema and register webhook bridge
./vendor/bin/feedple sync

# Force schema synchronization
./vendor/bin/feedple sync --force --bridge-url=https://myapp.com/feedple-bridge.php

# Start persistent WebSocket daemon (with optional live log tail)
./vendor/bin/feedple start
./vendor/bin/feedple start --tail

# Stop background WebSocket daemon
./vendor/bin/feedple stop

<?php

require __DIR__ . '/vendor/autoload.php';

use Feedple\Sdk\FeedpleSDK;
use Feedple\Sdk\DbConfig;
use Feedple\Sdk\Core\Identity;
use Feedple\Sdk\Core\WebhookBridge;

// 1. Configure database connection
$dbConfig = DbConfig::mysql(
    host:     getenv('DB_HOST') ?: '127.0.0.1',
    database: getenv('DB_DATABASE') ?: 'myapp',
    username: getenv('DB_USERNAME') ?: 'root',
    password: getenv('DB_PASSWORD') ?: '',
    port:     (int) (getenv('DB_PORT') ?: 3306),
);

// 2. Define table access permissions (RBAC)
$identity = new Identity(name: 'production', allTables: true);

// 3. Initialize SDK in stateless webhook mode
$sdk = new FeedpleSDK(
    apiKey:    getenv('FEEDPLE_API_KEY'),
    dbConfig:  $dbConfig,
    identity:  $identity,
    transport: 'webhook',
);

// 4. Initialize WebhookBridge with cryptographic signing secret
$bridge = new WebhookBridge(
    sdk:           $sdk,
    webhookSecret: getenv('FEEDPLE_WEBHOOK_SECRET'),
);

// Support GET health check
if ($_SERVER['REQUEST_METHOD'] === 'GET') {
    header('Content-Type: application/json');
    echo json_encode(['status' => 'active', 'service' => 'Feedple Webhook Bridge']);
    exit(0);
}

// 5. Handle incoming signed query
$rawBody = file_get_contents('php://input') ?: '';
$headers = function_exists('getallheaders') ? getallheaders() : $_SERVER;

$result = $bridge->handle($rawBody, $headers);

http_response_code($result['status_code']);
header('Content-Type: application/json');
echo json_encode($result['body']);

FEEDPLE_VERIFY_SSL=false

$sdk = new FeedpleSDK(
    apiKey:    $apiKey,
    dbConfig:  $dbConfig,
    identity:  $identity,
    verifySsl: false,
);

FEEDPLE_CA_BUNDLE="C:\Server\ssl\custom-ca.pem"

$dbConfig = DbConfig::pgsql(
    host:     '127.0.0.1',
    database: 'myapp',
    username: 'postgres',
    password: 'secret_password',
    port:     5432,
);

$dbConfig = DbConfig::mysql(
    host:     '127.0.0.1',
    database: 'myapp',
    username: 'root',
    password: 'secret_password',
    port:     3306,
    charset:  'utf8mb4',
);

$dbConfig = DbConfig::sqlite(
    path: '/path/to/database.sqlite',
);

$dbConfig = DbConfig::raw(
    dsn:      'sqlsrv:Server=localhost;Database=myapp',
    username: 'sa',
    password: 'Password123!',
);

// Option A: Whitelist specific tables (Recommended)
$identity = new Identity(
    allowedTables: ['orders', 'products', 'customers'],
);

// Option B: Allow access to all tables
$identity = new Identity(
    allTables: true,
);

X-Feedple-Signature: t=1728678000,v1=5d41402abc4b2a76b9719d911017c592...