corbitaltech

Appearance

⚙️ Initial Setup ​

After installing the Ecommerce Webhook Notifications Addon, follow this comprehensive setup guide to configure your automated notification system.

🎯 Setup Overview ​

The initial setup process involves five main steps:

  1. License Activation - Activate your addon license
  2. WhatsApp Integration - Connect your WhatsApp Business API
  3. Template Configuration - Set up notification templates
  4. Platform Connection - Connect your ecommerce platform
  5. Testing & Verification - Test the complete notification flow

🔑 Step 1: License Activation ​

Access License Settings ​

  1. Navigate to Addon Settings

    • Go to Admin Panel → Addons → Ecommerce Webhook Notifications
    • Click on License & Activation

  2. Enter License Information

    • Purchase Code: Enter your CodeCanyon purchase code
    • Domain: Verify your domain is correct
    • Email: Enter the email used for purchase

  3. Activate License

    • Click Activate License
    • Wait for activation confirmation
    • Verify activation status shows "Active"

Troubleshooting License Issues ​

Common license activation problems:

IssueSolution
Invalid purchase codeVerify code from CodeCanyon purchase receipt
Domain mismatchContact support to update registered domain
Already activatedDeactivate previous installation first
Network errorCheck server's outbound internet connection

📱 Step 2: WhatsApp Integration ​

Configure WhatsApp Business API ​

  1. Access WhatsApp Settings

    • Navigate to WhatsApp → Business API → Configuration
    • Ensure your WhatsApp Business API is already connected to WhatsMarkSaaS

  2. Verify API Status

    • Check that API status shows "Connected"
    • Verify phone number is verified and active
    • Confirm webhook URL is accessible

  3. Set Notification Permissions

    • Enable Send Notifications permission
    • Confirm Template Messages are allowed
    • Verify rate limits are appropriate for your volume

Template Management Access ​

  1. Access Template Manager

    • Go to WhatsApp → Templates → Manage Templates
    • Verify you can see existing templates
    • Confirm template creation permissions

  2. Import Notification Templates

    • Navigate to Ecommerce Notifications → Templates
    • Click Import Default Templates
    • Review and customize imported templates
    • Submit templates for WhatsApp approval if needed

🎨 Step 3: Template Configuration ​

Default Template Setup ​

The addon comes with pre-configured templates for common scenarios:

Order Management Templates ​

  1. Order Confirmation

    • Template Name: order_confirmation
    • Trigger: Order placement
    • Variables: Customer name, order number, total, items

  2. Order Processing

    • Template Name: order_processing
    • Trigger: Order status change to "processing"
    • Variables: Customer name, order number, items, processing time

  3. Order Shipped

    • Template Name: order_shipped
    • Trigger: Shipping confirmation
    • Variables: Customer name, order number, tracking number, carrier

  4. Order Delivered

    • Template Name: order_delivered
    • Trigger: Delivery confirmation
    • Variables: Customer name, order number, delivery date

Custom Template Creation ​

  1. Create New Template

    • Go to Templates → Create New
    • Select Ecommerce Notification category
    • Choose template type (Order, Payment, Shipping, etc.)

  2. Configure Template Content

    • Header: Add optional header text or media
    • Body: Write message content with variables
    • Footer: Add optional footer text
    • Buttons: Add action buttons if needed

  3. Submit for Approval

    • Review template content for compliance
    • Submit to WhatsApp for approval
    • Wait for approval (typically 24-48 hours)

Template Language Setup ​

Configure multi-language support:

  1. Language Detection

    • Enable automatic language detection
    • Set fallback language (usually English)
    • Configure language mapping rules

  2. Create Language Variants

    • Create templates for each supported language
    • Use same variable structure across languages
    • Test each language variant

🔗 Step 4: Platform Connection ​

WooCommerce Setup ​

  1. Install Webhook Plugin (if needed)

    • Ensure WooCommerce webhooks are enabled
    • Verify webhook delivery URLs are accessible

  2. Configure Webhooks

    • Go to WooCommerce → Settings → Advanced → Webhooks
    • Add webhook for each notification type:
      • Order created → your-domain.com/webhooks/woocommerce/order-created
      • Order updated → your-domain.com/webhooks/woocommerce/order-updated
      • Order completed → your-domain.com/webhooks/woocommerce/order-completed

  3. Test Webhook Delivery

    • Create a test order
    • Verify webhook is received
    • Check notification is sent

Shopify Setup ​

  1. Access Shopify Admin

    • Log into your Shopify admin panel
    • Navigate to Settings → Notifications

  2. Configure Webhooks

    • Go to Settings → Webhooks
    • Add webhooks for:
      • Order created
      • Order updated
      • Order fulfilled
      • Order cancelled

  3. Set Webhook URLs

    • Use format: your-domain.com/webhooks/shopify/[event-type]
    • Example: your-domain.com/webhooks/shopify/order-created

Magento Setup ​

  1. Access Magento Admin

    • Log into Magento admin panel
    • Go to System → Configuration → Services

  2. Enable Webhooks

    • Install webhook extension if needed
    • Configure webhook endpoints
    • Set authentication credentials

Custom Platform Setup ​

For custom ecommerce platforms:

  1. API Documentation

    • Review provided API documentation
    • Understand webhook payload format
    • Note authentication requirements

  2. Configure Endpoints

    • Set up webhook endpoints on your platform
    • Format: your-domain.com/webhooks/custom/[event-type]
    • Implement proper authentication

🧪 Step 5: Testing & Verification ​

End-to-End Testing ​

  1. Create Test Order

    • Place a test order on your ecommerce platform
    • Use a valid phone number for testing
    • Use small amount to avoid unnecessary charges

  2. Verify Webhook Reception

    • Check addon logs for webhook reception
    • Verify webhook data is parsed correctly
    • Confirm template variables are populated

  3. Check Notification Delivery

    • Verify WhatsApp message is sent
    • Check message content and formatting
    • Confirm customer receives notification

Test Scenarios ​

Test these key scenarios:

Order Lifecycle Test ​

  1. Order Placement

    • Place order → Verify order confirmation sent
    • Check timing (should be immediate)
    • Verify all order details are correct

  2. Order Processing

    • Change order status to "processing"
    • Verify processing notification sent
    • Check timing and content accuracy

  3. Order Shipment

    • Add tracking information
    • Change status to "shipped"
    • Verify shipping notification with tracking details

  4. Order Delivery

    • Mark order as delivered
    • Verify delivery confirmation sent
    • Check customer satisfaction request

Error Handling Test ​

  1. Invalid Phone Number

    • Test with invalid phone number
    • Verify error is logged appropriately
    • Confirm system continues processing other orders

  2. Template Not Available

    • Disable a template temporarily
    • Trigger corresponding event
    • Verify fallback behavior or error handling

  3. WhatsApp API Unavailable

    • Simulate API downtime
    • Verify retry mechanism activates
    • Check queue processing for delayed delivery

Performance Testing ​

For high-volume stores:

  1. Load Testing

    • Simulate multiple simultaneous orders
    • Monitor system performance
    • Check notification delivery times

  2. Queue Testing

    • Verify queue workers are processing notifications
    • Monitor queue depth during peak times
    • Test queue recovery after downtime

📊 Configuration Verification ​

System Health Check ​

Run the built-in system health check:

bash
# Run system diagnostics
php artisan ecommerce-notifications:health-check

# Check specific components
php artisan ecommerce-notifications:check-whatsapp
php artisan ecommerce-notifications:check-templates
php artisan ecommerce-notifications:check-webhooks

Configuration Review ​

Verify these key settings:

WhatsApp Configuration ​

  • [ ] Business API connected and active
  • [ ] Phone number verified
  • [ ] Templates approved and active
  • [ ] Rate limits configured appropriately

Webhook Configuration ​

  • [ ] Webhook URLs accessible
  • [ ] Authentication configured
  • [ ] SSL certificates valid
  • [ ] Webhook signatures verified

Template Configuration ​

  • [ ] All required templates created
  • [ ] Templates approved by WhatsApp
  • [ ] Variables mapping correctly
  • [ ] Multi-language support active (if needed)

Platform Integration ​

  • [ ] Ecommerce platform webhooks configured
  • [ ] Test orders processed successfully
  • [ ] Notifications delivered correctly
  • [ ] Error handling working properly

🎯 Post-Setup Optimization ​

Performance Tuning ​

  1. Queue Configuration

    • Configure appropriate number of queue workers
    • Set queue priorities for different notification types
    • Monitor queue performance and adjust as needed

  2. Rate Limiting

    • Configure rate limits to match WhatsApp API limits
    • Set up rate limit monitoring and alerts
    • Implement backoff strategies for rate limit hits

  3. Caching

    • Enable template caching for better performance
    • Cache customer data for faster lookup
    • Implement webhook data caching if appropriate

Monitoring Setup ​

  1. Log Monitoring

    • Set up log aggregation and monitoring
    • Create alerts for error patterns
    • Monitor notification delivery rates

  2. Performance Monitoring

    • Track notification delivery times
    • Monitor API response times
    • Set up uptime monitoring for webhook endpoints

  3. Business Metrics

    • Track customer engagement with notifications
    • Monitor customer satisfaction scores
    • Measure reduction in support ticket volume

🚨 Common Setup Issues ​

Installation Problems ​

IssueSymptomsSolution
License activation failsError during activationVerify purchase code and internet connection
WhatsApp not connectingAPI connection errorsCheck API credentials and webhook URL
Templates not importingImport process failsVerify template format and permissions
Webhooks not workingNo notifications sentCheck webhook URL accessibility and SSL

Configuration Issues ​

IssueSymptomsSolution
Notifications not sentOrders created but no messagesCheck template approval and webhook configuration
Wrong template usedIncorrect message contentVerify template mapping and triggers
Variables not populatedMissing data in messagesCheck variable mapping and data source
Delivery failuresMessages not reaching customersVerify phone numbers and WhatsApp API status

🆘 Getting Help ​

If you encounter issues during setup:

Self-Help Resources ​

Support Options ​

Professional Services ​

  • Setup Assistance: Professional setup and configuration
  • Custom Integration: Custom platform integration services
  • Performance Optimization: Speed and reliability improvements
  • Training: Staff training on system usage and management

✅ Setup Completion Checklist ​

Before going live, verify:

Technical Setup ​

  • [ ] License activated and verified
  • [ ] WhatsApp Business API connected
  • [ ] All templates approved and active
  • [ ] Webhook endpoints configured and tested
  • [ ] SSL certificates installed and valid
  • [ ] Queue workers running and monitored

Business Setup ​

  • [ ] Customer notification preferences configured
  • [ ] Staff trained on system usage
  • [ ] Monitoring and alerting configured
  • [ ] Backup and recovery procedures documented
  • [ ] Customer opt-out process implemented

Testing Complete ​

  • [ ] End-to-end order flow tested
  • [ ] All notification types verified
  • [ ] Error handling confirmed
  • [ ] Performance testing completed
  • [ ] Multi-language testing (if applicable)

Congratulations! Your Ecommerce Webhook Notifications system is now configured and ready to enhance your customer communication.

© 2024 - Corbital Technologies. All rights reserved.