Building Custom Applications


#1

Building Custom Applications in Helpmonks

With the “Custom Application” plugin you will be able to embed data from 3rd-party providers, i.e. from your own web services or from another application. You can also use the “Custom Application” plugin to pull data from your CRM or even post the data back to your web services.

You have the option to build static or dynamic applications. Dynamic applications are far more powerful, but require some knowledge in building a web service. Static applications are good for quickly showing data or linking to another application you use.

In addition, you can use “Dynamic variables” that are being populated with data from the conversation view your user is on.

Static Applications

The static application allows you to enter your own HTML code in the text-area field and display the HTML in the conversation view in Helpmonks. You can use any valid HTML code, but any “script” tags will be removed. All “Dynamic variables” can be used (see below).

Dynamic Applications

A dynamic application will execute a POST to the provided URL and will pass along the optional app key and the complete conversation object (see the API).

Helpmonks expects the returning data to be your HTML that you want to display. Please note that any “script” will be stripped before your HTML is being rendered. All “Dynamic variables” can be used (see below).

Dynamic Variables

Dynamic variables are strings that you can insert into your HTML code that will be replaced with actual values upon rendering in the conversation view. The following table shows the variables and the values.

Variable Value
$conversation_id$ The ID of the conversation
$mailbox_id$ The ID of the mailbox
$conversation_subject$ The SUBJECT of the conversation
$customer_id$ The ID of the last user who replied
$customer_first_name$ The FIRST NAME of the last user who replied
$customer_last_name$ The LAST NAME of the last user who replied
$customer_email$ The EMAIL of the last user who replied
$current_user_id$ The ID of the user within Helpmonks
$current_user_email$ The email of the user within Helpmonks
$current_user_name$ The full name of the user within Helpmonks

Dynamic Variables Objects

In addition to the above variables, you can also access the conversation and the current user’s data object.

Variable Value
$conversation$ This is the conversation object and you can access the data within the object with, e.g., $conversation.status$ or $conversation.subject$. Please refer to the data model of the conversation*.
$current_user$ This is the user object of the currently signed in user in Helpmonks. $current_user.id$, $current_user.name$, and $current_user.email$ are available.

*Conversation data model

Styling your content

Your HTML code can use any Bootstrap valid CSS and HTML and the Font Awesome library to style the HTML further.