Migrate from Pusher

Relay is wire-compatible with Pusher. Most apps can switch by changing configuration only — no code changes needed.

Step 1: Create a Relay App

Sign up at Relay and create a new app. Note your Key and Secret.

Step 2: Update Your Client

Using pusher-js

Change the constructor options to point to your Relay server:

// Before (Pusher)
const pusher = new Pusher('pusher-key', {
    cluster: 'us2',
});

// After (Relay)
const pusher = new Pusher('relay-app-key', {
    wsHost: 'relay.yourapp.com',
    wsPort: 6001,
    forceTLS: false,
    enabledTransports: ['ws'],
    cluster: 'mt1',
});

Everything else stays the same — subscribe(), bind(), trigger() all work identically.

Using Laravel Echo

// Before
window.Echo = new Echo({
    broadcaster: 'pusher',
    key: 'pusher-key',
    cluster: 'us2',
});

// After
window.Echo = new Echo({
    broadcaster: 'pusher',
    key: 'relay-app-key',
    wsHost: 'relay.yourapp.com',
    wsPort: 6001,
    forceTLS: false,
    enabledTransports: ['ws'],
    cluster: 'mt1',
});

Step 3: Update Your Server

REST API

Replace Pusher's trigger API URL with Relay's:

# Before
POST https://api-us2.pusher.com/apps/APP_ID/events

# After
POST https://your-relay-host.com/api/v1/apps/APP_ID/events

The request/response format is identical. Auth headers change from Pusher's HMAC to either:

• X-Relay-Key + X-Relay-Secret (simplest)
• Authorization: Bearer <app-token> (token-based)

Auth Endpoint

If you have a custom /broadcasting/auth endpoint, it works as-is. The HMAC signature format is the same (key:sha256(socket_id:channel, secret)).

What's Different

What's Compatible

• All channel types (public, private, presence)
• Client events (client-*)
• Subscription succeeded/member_added/member_removed events
• Ping/pong keepalive
• pusher-js and Laravel Echo client libraries
• HMAC auth signature format