W
Wil Casillas
Use Case - Webhook Notifications for Theme and Template Events
Background and Current Process
  • We (Vast Reach) use Unlayer's admin dashboard to create and manage email themes and templates
  • After a designer publishes or updates a theme in the Unlayer cloud, we want to make those themes immediately available in our system
  • Currently, we rely on a scheduled script (daily, hourly, etc.) to fetch the latest themes and synchronize them with our local database
Problem to Solve
  • Because we depend on a scheduled sync, there is a delay between the time a theme is published or updated and when it appears in our system
  • Time-sensitive updates can be delayed if we must wait for a scheduled task
  • Manual or scheduled processes can introduce inefficiency and potential human error
Desired Feature - Webhook Notifications
  • A webhook that Unlayer triggers when events occur (new theme published, theme updated, template modified, etc.)
  • This webhook would send a real-time POST request to our endpoint with event details (theme ID, type of update, etc.)
  • Upon receipt, our system would immediately fetch the updated content from Unlayer and update our database, eliminating delays
Use-Case Flow Example
1) A designer publishes a new theme using Unlayer's admin dashboard
2) Unlayer sends a webhook notification to our endpoint indicating the new theme
3) Our system retrieves the updated data and stores it locally
4) End users see the new or updated theme right away
Benefits
  • Real-time updates remove the need for frequent scheduled syncs
  • Immediate availability of new or updated themes improves user experience
  • Reduced reliance on manual scripts lowers operational overhead
  • Faster turnaround for time-sensitive campaigns
Technical Considerations
  • Secure webhook delivery via HTTPS and token-based or key-based authentication
  • Retry handling if our endpoint is temporarily unavailable
  • Ability to specify the exact event types we wish to receive to avoid unnecessary traffic
Summary
By providing webhook notifications for theme and template events, we can achieve real-time synchronization and eliminate reliance on scheduled scripts. This feature would significantly enhance both our workflow efficiency and the user experience within our platform.