Notification Channels

Email Channel

For the email channel, your builder function should return an object with email-specific properties:

build: {
  email() {
    return {
      subject: 'Welcome to our service',
      lines: [
        'Thanks for joining our platform!',
        'We\'re excited to have you on board.'
      ],
      action: {
        label: 'Get Started',
        url: 'https://example.com/get-started',
      },
    }
  }
}

Available email properties:

• subject (required) - The email subject line
• lines (optional) - Array of text lines for the email body
• greeting (optional) - Greeting text shown before the lines
• action (optional) - Button label and URL
• html (optional) - HTML body override
• text (optional) - text body override

Database Channel

For the database channel, return a data object that will be serialized into the notifications table:

build: {
  database() {
    return {
      data: {
        amount: 100.00,
        transactionId: 'txn_123abc',
        status: 'completed',
      },
    }
  }
}

All properties in the database payload will be stored as JSON in the data column of the notifications table.

Broadcast Channel

For the broadcast channel, your builder function should return an object containing the event name and data to broadcast:

build: {
  broadcast() {
    return {
      event: 'notification.sent',
      data: {
        message: 'You have a new notification',
        timestamp: new Date().toISOString()
      }
    }
  }
}

The event property determines the websocket event name, and data contains the payload that will be sent to subscribers.