Interface-methods is a mechanism that the developer platform provides, to enable your app to trigger certain actions on the Freshworks product UI.
Common interface actions that an app can perform on the product UI are as follows.
- Display certain UI elements such as Modals, Dialog boxes, Confirmation boxes, and Notifications.
- Mimic click actions - such as starting or stopping a timer or navigating to specific pages.
- Show/Hide certain fields, field values, and elements (such as icons or other relevant information).
- Enable/Disable certain buttons.
- Set the values of certain fields.
An app built for the common module can trigger the following interface actions on the product UI, based on the product where the app is deployed.
Notes:- When building a common module app, you must specify at least one other module in the app manifest. The other module(s) specified determine the product where the common module app is deployed.
- If the only other non-common modules included in the app manifest are any modules other than those in the following table, you cannot use the interface method in your app logic.
- Clicking on any of the links in the following table navigates you to the corresponding module’s documentation. To come back to the common module documentation, in the left navigation pane of this document, from the Module drop-down box, select the common module.
| If the other module is… | The app is deployed on… | The app can… |
|---|---|---|
support_email support_ticket support_portal support_agent support_contact support_company | Freshdesk | |
service_ticket service_asset service_change service_user | Freshservice | |
appointment contact cpq_document deal phone product sales_account task | Freshsales Suite Freshsales Classic | Additionally, if you build a common placeholder app that you intend to be made available only for stand-alone Freshsales Classic users, you can use the following interface methods in your app logic: |
| lead | Freshsales Classic | |
chat_conversation | Freshchat |