Account Setup: Step-by-step instructions on how to register, create a company profile, and navigate the dashboard.
Basic Walkthrough: Overview of key features and dashboard functionality, including template creation and tracking.
Environment Setup: Guide on installing the Notify npm package, setting up API keys, and configuring environment variables.
2. Template Creation and Management
Creating and Editing Templates: Guide to creating, saving, and updating email templates within the Notify dashboard.
Dynamic Content in Templates: Documentation on using placeholders and variables (like {name} or {company}) to insert dynamic content into emails.
Styling Templates: Guide on using Tailwind CSS (or other CSS options) within templates, including a list of supported classes and styling best practices.
3. Sending Emails Programmatically
API Endpoints Overview: Detailed list of API endpoints (e.g., send, schedule, fetch templates) with parameter explanations.
Usage Limits and Throttling: Documentation on email sending limits, rate limiting, and how to monitor usage.
Error Handling: Guide to common API errors, their causes, and solutions.
4. Customizing Email Components
Working with JSON-based Templates: Examples and instructions for creating modular, JSON-based email content.
Using Custom Data Fields: Explanation of how to add and utilize custom fields in email templates, including examples.
Real-time Template Previews: Guide to using the split-screen preview feature for instant feedback during template creation.
5. API Authentication and Security
API Key Management: Instructions for creating, regenerating, and revoking API keys, with security best practices.
Securing API Requests: Information on securing API requests with headers and JWT, and tips on avoiding API key exposure.
Permissions and Access Control: Guide to managing user roles and access for multi-user/company accounts.
6. Dashboard Features
Managing Credentials: Instructions on accessing and securing API keys, as well as handling company-level access control.
Viewing Usage Analytics: Guide on tracking email usage, delivery rates, and recipient engagement metrics.
User Limits and Subscription Plans: Explanation of different tiers, including monthly email limits and associated feature access.
7. Testing and Debugging Emails
Testing Emails Locally: Instructions on how to simulate or test emails before sending them to real recipients.
Error Logs and Tracking: How to use Notify's email_logs and other monitoring tools to troubleshoot email delivery issues.
Mock Data for Testing: Guide on using placeholder data to test dynamic templates and preview emails effectively.
8. Real-time Delivery and Event Tracking
Setting Up Event Webhooks: Instructions for configuring webhooks to receive real-time updates on email delivery, bounces, opens, and clicks.
Event Types and Payloads: List of available event types (sent, delivered, bounced, etc.) and details on the data payloads sent for each event.
Viewing and Exporting Logs: Guide on accessing and exporting logs to analyze email performance or troubleshoot issues.
9. Best Practices and Compliance
Transactional Email Best Practices: Tips on optimizing email deliverability, engaging recipients, and avoiding spam filters.
Email Compliance (GDPR, CAN-SPAM): Compliance guidelines on email content, opt-out links, and data privacy.
Managing User Preferences: Guide to handling unsubscribe requests, preferences, and user data management in line with compliance.