App types
| Type | Description | Use case |
|---|---|---|
| Integration app | Connects HoopAI with an external service | CRM sync, payment processor, analytics |
| Workflow action | Adds custom actions to the Workflow Builder | Custom API calls, data enrichment |
| Custom page | Embeds a UI inside HoopAI via iframe | Dashboards, custom tools |
| Widget | Adds UI elements to specific areas of HoopAI | Contact sidebar widgets, dashboard widgets |
Building your app
Register on the Developer Marketplace
Go to marketplace.gohighlevel.com and create a developer account.
Create a new app
Click Create App and configure:
- App name and description
- OAuth redirect URI
- Required scopes
- Webhook subscriptions
Implement OAuth flow
Follow the Authentication guide to implement the OAuth 2.0 Authorization Code flow.
Build your integration
Use the API Reference to implement your app’s features. Handle token refresh, webhooks, and error cases.
Test with a sandbox account
Install your app on a test account and verify all features work correctly.
App lifecycle events
When your app is installed or uninstalled, HoopAI sends webhook events:| Event | When it fires |
|---|---|
AppInstall | A user installs your app on a account |
AppUninstall | A user removes your app from a account |
Monetization
Marketplace apps can charge users through the External Billing system:- Set a monthly or annual subscription price
- HoopAI handles billing and payments
- You receive payouts minus the marketplace commission
Custom menus and UI
Apps can inject custom navigation items and pages into HoopAI:Best practices
Handle installation gracefully
Handle installation gracefully
When a user installs your app, set up all necessary resources (database records, webhook subscriptions) and provide a clear onboarding experience.
Respect rate limits
Respect rate limits
Design your app to work within rate limits. Use caching and batch operations where possible.
Clean up on uninstall
Clean up on uninstall
When your app is uninstalled, clean up webhooks, revoke tokens, and remove any data you no longer need.
Provide clear documentation
Provide clear documentation
Include setup instructions, feature descriptions, and support contact information in your marketplace listing.
.png?fit=max&auto=format&n=EQK5eX9kTD8NzWwA&q=85&s=878008bf159fcc4964d0c0d508b6e400)