PUQ Mautic

Mattermost Export

Instantly share WHMCS reports, tickets, and invoices in your Mattermost server.

Description

The "Mattermost Export" extension establishes a unidirectional link from your WHMCS server to your Mattermost workspace, facilitating seamless communication and timely notifications for events. This extension is designed to efficiently transmit updates regarding new tickets, payments, client responses to tickets, and reports deliveries directly to your Mattermost messenger.

Key Features:

Overall, the "Mattermost Export" extension enhances collaboration and efficiency by delivering timely notifications for key events within your WHMCS system directly to your Mattermost messenger. By leveraging this integration, you can ensure that your team stays informed, responsive, and coordinated, ultimately enhancing customer service and operational effectiveness.

Configuration

image-1707825089516.png

Enabled - Enabling or disabling all custom functions of this extension affects the automation and visibility of its features in the client area. When the extension is disabled, the automation capabilities and related features provided by the extension will not be active or visible to clients. However, as an administrator, you will still have access to configure and utilize the extension's functionalities through the administration interface. This gives you the flexibility to control the visibility and automation aspects of the extension based on your specific needs and preferences.

Server URL - The URL of your Mattermost server to which you want to send all data and notifications. Please be careful when filling out this field as it is one of the most important in this extension. When entering, it is very important to maintain the correct structure: before the domain or IP address, enter http:// or https://, depending on your server settings, and then add a trailing slash (/).

Access Token - This is the personal token of the administrator from whose account all notifications will be sent. You can obtain this token by following the instructions here: https://docs.mattermost.com/developer/personal-access-tokens.html 

The user role from which notifications will be sent must be System Admin. Otherwise, most of the functionality may not work properly.

Test Connection - Button to test the connection to the server. 

Click this button after "Save Changes" to ensure that the test runs correctly.

Tickets Export

Export Setup
2.png

To configure notifications for new tickets, establish a connection between departments and channels. You can create this connection by selecting the department and the corresponding notification channel, then click the "Save Changes" button.

You can delete the necessary connection to change the channel for a particular department. To do this, click on the red icon "image-1707741931383.png"

 

Annotation containing a direct link to discuss

When creating a new ticket, an annotation will appear within the same ticket from the administrator's side, containing a direct link to discuss this ticket on your Mattermost server.

If you encounter an error upon accessing the link, it indicates that you do not have access to this channel.

12.png

 

What new ticket notifications look like

The main view of the ticket has a special structure and represents a link directly to the ticket in your WHMCS: #(Ticket Number) - (Ticket Title). There is also a reaction image-1707743296180.png indicating that the ticket is new and has no new replies from the client.

image-1709899313735.png

In the Thread, the message about the new ticket will have the text of the client's email. This will help you immediately see the content of the ticket.

image-1709899364968.png

What ticket reply notifications look like

When receiving a notification that the client has replied to the ticket, the Thread will display the text of the client's email. The reaction will also change toimage-1707744091240.png  indicate that the ticket has a client reply.

Please note that this only works with tickets created after installing and configuring this module. All tickets opened before this and their replies will not be displayed on your Mattermost server.

image-1709899686607.png

 

What closed ticket notifications look like

When a ticket is closed, the reaction will change to image-1707744373712.png indicate that the ticket has a closed status.

image-1709899703386.png

Invoices Export

10.png

Enabled Reports Export - You can easily activate or deactivate sending notifications about paid invoices.

Channel for sending invoices - Select the channel on your server where notifications about paid invoices will be sent.

Color for invoice message - Choose the color of the sidebar on notifications about paid invoices.

image-1709899951968.png

Reports Export

11.png

Enabled Reports Export- You can easily activate or deactivate sending reports from your WHMCS.

Channel for sending reports - Select the channel on your server where reports from your WHMCS will be sent.

Color for report message - Choose the color of the sidebar on report notifications.

Reports are sent when the daily cron job runs.
Daily Report - The report is generated every day for the previous day, i.e., the previous date (for example, if today is 02/13/2024, the report will be for the period 02/12/2024 00:00:00 - 02/12/2024 23:59:59).
Weekly Report - The report is generated every Monday for the previous week (for example, if today is 02/13/2024 (Monday), the report will be for the period 02/05/2024 00:00:00 (Monday) - 02/11/2024 23:59:59 (Sunday)).
Monthly Report - The report is generated on the first day of each month (for example, if today is 02/01/2024, the report will be for the period 01/01/2024 00:00:00 - 01/31/2024 23:59:59).

All data except for unpaid invoices is taken for a specific period (day, week, month). Information about unpaid invoices is aggregated. This means that the report includes the total number of unpaid invoices on your server at the time of report generation and sending.

image-1709899995669.png

4.png