Messaging SDK - Node.js & PHP / Laravel

team key   →  sb_…                       (Console → SDK keys)
scopes     →  email:send, contacts:write… (chosen when the key is created)
class      →  transactional | commercial  (REQUIRED on every send)

npm install signalbird        # Node 18+, zero dependencies
composer require pariette/signalbird    # PHP 8.1+, ext-curl, no Guzzle

import { SignalbirdMessaging } from 'signalbird'

const sb = new SignalbirdMessaging({ domainKey: process.env.SIGNALBIRD_DOMAIN_KEY! })

const res = await sb.sendEmail({
  to: 'ahmet@example.com',
  class: 'transactional',
  subject: 'Your order was received',
  body: '<p>Order #1042 is being prepared.</p>',
})

if (res.ok) console.log(res.data.id, res.data.status)   // 'msg_…', 'queued'
else console.warn(res.code, res.message)                // 'NO_SENDING_DOMAIN', …

use Signalbird\Sdk\Messaging\MessagingClient;

$sb = new MessagingClient(getenv('SIGNALBIRD_DOMAIN_KEY'));

$res = $sb->sendSms([
    'to'    => '+905321234567',
    'class' => 'transactional',
    'body'  => 'Your verification code: 482913',
]);

if ($res['ok']) { $id = $res['data']['id']; }
else            { $code = $res['code']; }

# .env
SIGNALBIRD_DOMAIN_KEY=sb_xxxxxxxxxxxxxxxxxxxxxxxx
# SIGNALBIRD_MESSAGING_URL=https://signalbird.io/api   # optional

use Signalbird\Sdk\Facades\Signalbird;

$res = Signalbird::messaging()->sendPush([
    'to'      => 'external:user-1042',
    'class'   => 'commercial',
    'subject' => 'Weekend sale',
    'body'    => '20% off everything in your cart',
]);

// Node
type SbResult<T> =
  | { ok: true;  status: number; data: T }
  | { ok: false; status: number; code: string; message: string; data?: unknown }

// PHP
['ok' => bool, 'status' => int, 'data' => ?array, 'code' => ?string, 'message' => ?string]

const sb = new SignalbirdMessaging({ domainKey, throwOnError: true })
try {
  await sb.sendEmail({ … })
} catch (e) {
  if (e instanceof SignalbirdError) console.error(e.code, e.status, e.data)
}

$sb = new MessagingClient($key, throwOnError: true);
try {
    $sb->sendEmail([...]);
} catch (\Signalbird\Sdk\SignalbirdException $e) {
    $e->getErrorCode();   // 'LIMIT_REACHED'
    $e->getStatus();      // 429
    $e->getBody();        // raw API response
}

const list = await sb.createContactList({ name: 'Newsletter - August' })

const res = await sb.bulkContacts({
  list_id: list.data.id,
  consent_source: 'web-form',
  consent_text: 'I agree to receive marketing emails.',
  contacts: rows.map(r => ({
    email: r.email,
    first_name: r.name,
    attributes: { plan: r.plan },
  })),
})

// { imported: 4120, updated: 310, skipped: [{ email: 'x', reason: 'invalid' }, …] }

// 1. list + contacts
const list = await sb.createContactList({ name: 'New feature announcement' })
await sb.bulkContacts({ list_id: list.data.id, contacts })

// 2. create the campaign (immediate or scheduled)
const created = await sb.createCampaign({
  name: 'August announcement',
  channel: 'email',
  domain_id: 7,               // your TXT-verified domain (required)
  list_id: list.data.id,
  subject: 'New: calendar integration',
  body: '<p>Hi {{first_name}}, …</p>',
  scheduled_at: '2026-08-21T09:00:00+03:00',
  external_ref: 'crm-cmp-77',
})
// created.data.summary → { total, queued, skipped, stopped_reason }

// 3. watch status
const detail = await sb.getCampaign(created.data.batch.id)
// detail.data.status_breakdown → { queued: 120, sent: 3900, bounced: 12, … }

// 4. walk the messages
for await (const m of sb.iterateCampaignMessages(created.data.batch.id, { status: 'bounced' })) {
  console.log(m.recipient, m.last_code)
}

import express from 'express'
import { verifyWebhook } from 'signalbird'

app.post('/webhooks/signalbird', express.raw({ type: 'application/json' }), (req, res) => {
  const ok = verifyWebhook(req.body, req.header('X-Signalbird-Signature'), process.env.SIGNALBIRD_WEBHOOK_SECRET!)
  if (!ok) return res.status(401).end()

  const event = JSON.parse(req.body.toString('utf8'))
  if (event.type === 'message.bounced') { /* … */ }
  res.status(204).end()
})

use Illuminate\Http\Request;
use Signalbird\Sdk\Messaging\Webhook;

Route::post('/webhooks/signalbird', function (Request $request) {
    $ok = Webhook::verify(
        $request->getContent(),                       // raw body
        $request->header('X-Signalbird-Signature'),
        config('services.signalbird.webhook_secret'),
    );
    abort_unless($ok, 401);

    $event = $request->json()->all();
    // $event['type'], $event['data']['message_id'] …
    return response()->noContent();
})->withoutMiddleware([\Illuminate\Foundation\Http\Middleware\VerifyCsrfToken::class]);