Welcome to the Freshworks Paid Apps Developer Workshop! This hands-on workshop will guide you through building apps for the Freshdesk platform using the Freshworks App SDK v3.0.
This workshop provides a progressive, step-by-step learning experience for building Freshworks marketplace apps. You'll learn essential concepts of the Freshworks Developer Platform, from basic app structure to integrations with external services.
Throughout this workshop, you'll create increasingly sophisticated apps:
- First App - A simple ticket sidebar app that displays requester information
- Multi-Placeholder App - An app that appears in multiple locations across Freshdesk
- Full Page App - Advanced apps with full-page views
- Shopify Integration App - A real-world integration connecting Freshdesk with Shopify
Before starting this workshop, ensure you have:
- Node.js v18.20.8 or higher
- Freshdesk Trial Account - Sign up for free
- Code Editor - VS Code recommended
- Basic Knowledge of HTML, CSS, and JavaScript
Follow the comprehensive setup guide to prepare your development environment:
This guide covers:
- Installing the FDK CLI
- Setting up your Freshdesk trial account
- Configuring your development environment
- Running your first app locally
📁 Location: apps/first_app
Your introduction to Freshworks app development. This simple app displays the ticket requester's name in the ticket sidebar.
What You'll Learn:
- Basic app structure and files
- Manifest.json configuration
- Using the Data API to fetch ticket data
- Handling the
app.activatedevent
📁 Location: apps/placeholder_app
Learn how to make your app available in multiple locations across Freshdesk.
What You'll Learn:
- Configuring multiple placeholders in one app
- Module architecture (support_ticket, support_contact, common)
- Creating placeholder-specific views
- Context-aware data fetching
Placeholders:
- Ticket Sidebar
- Ticket Requester Info
- Contact Sidebar
- Full Page App
- CTI Global Sidebar
📁 Location: apps/full_page_placeholder
Build immersive full-page applications.
What You'll Learn:
- Creating full-page applications
- Using the common module for global access
- Configuring external API requests with requests.json
Special Features:
- Dedicated full-page workspace
- Always-accessible CTI sidebar
- External API configuration
- Advanced placeholder usage
📁 Location: apps/sf-integration
A real-world example integrating Freshdesk with Shopify.
What You'll Learn:
- Secure external API requests
- Working with e-commerce data
- Freshworks Developer Portal
- App SDK v3.0 Documentation
- Freshdesk App Locations
- Data API Reference
- Freshworks Crayons v4 - UI Component Library
If you have questions during the workshop:
- Refer to the app-specific README files
- Check the documentation resources
- Ask the workshop facilitators
- Post in the Developer Community
🚀 Ready to start? Head over to the Getting Started Guide!