Integration Guides

Step-by-step guides for integrating NotiBoost into your system.

Quick Start

Integrate NotiBoost in a few simple steps:

Step 1: Send First Event

Send an event from your system to NotiBoost API:

curl -X POST https://api.notiboost.com/api/v1/events \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "event_name": "order_created",
    "event_id": "evt_001",
    "occurred_at": "2025-12-01T10:00:00Z",
    "user_id": "u_123",
    "properties": {
      "order_id": "A001"
    }
  }'

Step 2: Create Rule

Create a rule to match events and trigger flows.

Step 3: Create Flow

Define notification flow with channels and templates.

Step 4: Test and Monitor

Test integration and monitor delivery status.

Integration Patterns

Order Lifecycle

Pattern for order notifications:

• order_created → Send confirmation
• payment_success → Send receipt
• order_shipped → Send tracking info

Payment Notifications

Pattern for payment notifications: payment_success, payment_failed, refund_processed.

Shipping Updates

Pattern for shipping: order_shipped, delivery_confirmed, delivery_failed.

Best Practices

• Use unique event_id for each event
• Send events immediately after occurrence
• Don't retry events on client side - NotiBoost handles retry
• Monitor delivery status via webhooks
• Test thoroughly before deploying to production

Troubleshooting

Events not being processed

Check API key, event structure, and rule matching.

Messages not being sent

Check channel configuration, quota, and flow status.

Delivery failures

View audit logs and delivery status to debug.