Discord Messenger by Blesta.Club - Product Overview

Welcome, and thank you for choosing the Discord Messenger! We're delighted to have you as a customer and are committed to ensuring you have a seamless experience. This guide aims to walk you through the installation and configuration of your new extension. If you're new to Blesta or encounter any issues, please don't hesitate to reach out for support.

Messenger Capabilities

The Discord Messenger is designed to send notifications for various events in Blesta, ensuring you stay informed and connected with your clients and team. The notifications are categorized as follows:

Client Messages

1. Account Registration
   • Description: Welcome notice sent for new account registrations.
2. Auto-Debit Pending
   • Description: Notice indicating an upcoming automatic payment.
3. Invoice Delivery (Paid)
   • Description: Notice containing the total amount of a paid invoice.
4. Invoice Delivery (Unpaid)
   • Description: Notice containing the total amount of an unpaid invoice.
5. Invoice Notice (1st, 2nd, 3rd)
   • Description: Reminder or late notice for invoice payments.
6. Quote Delivery
   • Description: Notice containing a quote number and link.
7. Service Creation
   • Description: Notice sent when a service is created.
8. Service Scheduled Cancellation
   • Description: Notice sent when a service is scheduled for cancellation.
9. Service Suspension
   • Description: Notice sent when a service is automatically suspended.
10. Service Unsuspension
    • Description: Notice sent when a service is automatically unsuspended.

Staff Messages

1. Quote Approval
   • Description: Notice sent after a quote is approved by the client.

Plugin Messages

1. Order Received
   • Plugin: Order System
   • Description: Notice sent when an order is received.
2. Staff Ticket Assigned
   • Plugin: Support Manager
   • Description: Notice sent to a staff member when a ticket is assigned to them.
3. Staff Ticket Updated
   • Plugin: Support Manager
   • Description: Notice sent to a staff member when a ticket is updated.

Things to Note

1. A notification too long for a single Discord embed is split across consecutive messages, so nothing is cut off the end. Only the first message carries the mention, so a split notification pings once.
2. HTML formatting is removed from notifications before sending, so they appear as plain text in the embed.
3. Both webhook URLs are stored encrypted and are never shown again on the settings page. Leave a webhook field blank to keep the stored URL, and fill it in only to replace it. For the same reason, "Test Connection" needs the Webhook URL typed in before it can test a live webhook.
4. Only https:// webhook addresses on discord.com or discordapp.com are accepted, because Discord does not issue webhooks anywhere else.

Setting Up the Messenger

Install the Messenger

1. Download the Messenger:

   • Obtain the Discord Messenger from the download section of the client area.

2. Upload to Blesta:

   • Upload the Discord Messenger to your Blesta messenger directory:

     /var/www/html/blesta/components/messengers/discord/

3. Install the Messenger:

   • Log in to your admin Blesta account and navigate to Settings > Messengers.
   • Find the Discord Messenger and click the "Install" button.

Configure the Messenger

1. Manage the Messenger:

   • Navigate to Settings > Messengers (/admin/settings/company/messengers/installed/).
   • Find the "Discord" Messenger and click on "Manage".
   • Input your Webhook URL which you got from Discord.
   • Optionally fill in any of the following, all of which can be left blank:
     • Staff Webhook URL - a second webhook. Notifications addressed to a staff member are posted to its channel instead, keeping internal alerts out of the main channel.
     • Embed Title, Embed Color (a 6-digit hex code such as 5865F2) and Footer Text - how each embed looks. Blank keeps the built-in defaults.
     • Bot Username and Bot Avatar URL - override the name and picture the webhook posts under. Blank uses the webhook's own.
     • Mention on Delivery and Mention ID - ping a Discord role or user with each notification. Pick Role or User, then paste the numeric ID: in Discord enable Developer Mode, right-click the role or user and choose "Copy ID". A role or user name is not accepted.
     • Enable Mock API - simulate deliveries from built-in sample responses instead of contacting Discord, for testing and demos.
   • Click Test Connection to send one test message and see the result on the page. Testing never saves your settings.
   • Click "Update Settings" to save.

2. Messenger Configuration:

   • Under "Messengers", click on "Messenger Configuration".
   • Assign Discord to the SMS Message Type (currently the only one supported by Blesta).

3. Enable Notifications:

   • Under "Messengers", go to "Message Templates".
   • Ensure the relevant templates are enabled.

Quick Support

How to Create a Discord Webhook

1. Login to Discord:

   • Open Discord and navigate to the server where you want to create the webhook.

2. Create Webhook:

   • Go to Server Settings > Integrations > Webhooks.
   • Click "New Webhook" and choose the channel where you want to send notifications.
   • Copy the webhook URL.

3. Configure Webhook in Blesta:

   • Paste the webhook URL into the plugin settings in Blesta and customise your notifications as needed.

Troubleshooting Notifications

• Order Notifications:

  • Go to Billing > Overview (/admin/billing/index/).
  • Scroll to the bottom. You should see an "Orders" panel. In its corner, there is a cogwheel for changing its settings. Click on it, then under "Order Notifications" enable "Messengers". Click "Update Settings" to save your changes.

• Ticket Notifications:

  • Go to Support > Departments (/admin/plugin/support_manager/admin_departments/).
  • Edit your desired department and check "Send Auto-Response Emails for New Tickets". Save your changes by clicking "Edit Department".

• Staff Ticket Notifications:

  • Go to Support > Staff (/admin/plugin/support_manager/admin_staff/).
  • Edit your desired staff member and check which ticket priorities should be sent to the Messenger. Save your changes by clicking "Edit Staff".

Contact Us

If you encounter any issues or have suggestions for improving the extension, please get in touch with us. We are committed to providing robust updates and welcome customer feedback.

Discord Messenger by Blesta.Club - Installation Guide

Welcome, and thank you for choosing the Discord Messenger! We're delighted to have you as a customer and are committed to ensuring you have a seamless experience. This README aims to guide you through the installation of your new extension. If you're new to Blesta or encounter any issues, please don't hesitate to reach out for support.

Installation Guide

For detailed instructions on how to install the Discord Messenger, please ensure you have the license manager installed for leased extensions and then follow these steps:

1. Obtain the Messenger:

   • Download the Discord Messenger from the download section of the client area.

2. Upload to Blesta:

   • Upload the Discord Messenger to your Blesta messenger directory:

     /var/www/html/blesta/components/messengers/discord/

3. Install the Messenger:

   • Log in to your Blesta admin account.
   • Navigate to Settings > Messengers, then click the Available tab.
   • Find the Discord Messenger and click the "Install" button.
   • This page needs the "Messengers" staff permission, and installing needs "Install Messengers" too; ask your admin to grant them under Settings > Staff > Staff Groups if the page or the button is missing.

4. Creating Your Discord Webhook

   • Open Discord and navigate to the server where you want to receive notifications.
   • Go to Server Settings > Integrations > Webhooks.
   • Click "New Webhook" and choose the channel notifications should be posted to.
   • Copy the webhook URL.

Setting Up the Messenger

1. Configure the Messenger:

   • Navigate to Settings > Messengers (/admin/settings/company/messengers/installed/).
   • Find the "Discord" Messenger and click on "Manage" (needs the "Manage Messenger" staff permission).
   • Input your Webhook URL. If you don't know how to find it, refer to the install instructions above.

2. Messenger Configuration:

   • Under "Messengers", click on "Messenger Configuration".
   • Assign Discord to the SMS Message Type (currently the only one supported by Blesta).

3. Enable Notifications:

   • Under "Messengers", go to "Message Templates".
   • Ensure the relevant templates are enabled.

You're now done with the installation! Proceed to configure the messenger as needed by following the usage guide!

Contact Us

If you encounter any issues or have suggestions for improving the extension, please get in touch with us. We are committed to providing robust updates and welcome customer feedback.

Discord Messenger by Blesta.Club - Updating Guide

Updating Guide

To keep your Discord Messenger up-to-date, follow these steps:

1. Download the Updated Messenger:

   • Obtain the updated messenger from the download section of my.blesta.club.

2. Upload the Updated Messenger:

   • Upload the updated messenger to your Blesta messenger directory. For example:

     /var/www/html/blesta/components/messengers/discord/

3. Update the Messenger:

   • Log in to your admin Blesta account and navigate to Settings > Messengers.
   • Find the Discord Messenger and click the "Update" button to update it.

4. Blesta version (updating to 3.0.0):

   • From 3.0.0 the Discord Messenger is built for Blesta 6.0 and newer and no longer runs on Blesta 5. Upgrade Blesta first; if you must stay on Blesta 5, keep the last 2.x release.
   • Nothing else changes on update: your saved settings carry over exactly as they are, and the Manage page only picks up the Blesta 6 admin styling.

5. Re-save your settings once (recommended, updating to 1.1.0):

   • From 1.1.0 onward the Webhook URL is stored encrypted. URLs saved by an earlier version remain readable and keep working, but they stay in plain text until the settings are saved again. Open Manage on the Discord Messenger and click "Update Settings" once to have the Webhook URL re-stored encrypted.

6. What changes when updating to 2.0.0:

   • Your existing Webhook URL keeps working and nothing needs to be reconfigured. Every new setting is optional and blank means "behave exactly as before".
   • The webhook fields are now masked. They are never displayed again once saved, so the settings page shows them blank even when a URL is stored. Leaving a webhook field blank keeps the stored URL; only fill one in when you want to replace it. Because the stored URL is not readable from the page, "Test Connection" needs the Webhook URL typed in before it can test a live webhook.
   • Once a Staff Webhook URL is stored, blanking the field no longer removes it. To stop routing staff notifications separately, set the Staff Webhook URL to the same address as the Webhook URL.
   • Webhook addresses are now checked when you save. Only https:// URLs on discord.com or discordapp.com are accepted. If you had saved something else, the settings page will ask you to correct it the next time you save.
   • If you use Mention on Delivery, the Mention ID must be the numeric ID of the role or user, not its name. A name was previously accepted at save time and then made every notification fail; it is now rejected on the settings page instead.
   • New optional settings: Staff Webhook URL, Embed Title, Embed Color, Footer Text, Bot Username, Bot Avatar URL, Mention on Delivery and Mention ID. See the usage guide.

No changes should need to be made outside of the updating process. Any breaking changes will be communicated to clients.

Contact Us

If you encounter any issues or have suggestions for improving the extension, please get in touch with us. We are committed to providing robust updates and welcome customer feedback.

Discord Messenger by Blesta.Club - Usage Guide

Usage Guide

Once your messenger is installed and updated, configure it to suit your needs. Follow these steps for setup:

Configure the Messenger

1. Manage the Messenger:

   • Navigate to Settings > Messengers (/admin/settings/company/messengers/installed/).
   • Find the "Discord" Messenger and click on "Manage".
   • Input your Webhook URL which you got from Discord.
   • Optionally fill in any of the following, all of which can be left blank:
     • Staff Webhook URL - a second webhook. Notifications addressed to a staff member are posted to its channel instead, keeping internal alerts out of the main channel.
     • Embed Title, Embed Color (a 6-digit hex code such as 5865F2) and Footer Text - how each embed looks. Blank keeps the built-in defaults.
     • Bot Username and Bot Avatar URL - override the name and picture the webhook posts under. Blank uses the webhook's own.
     • Mention on Delivery and Mention ID - ping a Discord role or user with each notification. Pick Role or User, then paste the numeric ID: in Discord enable Developer Mode, right-click the role or user and choose "Copy ID". A role or user name is not accepted.
     • Enable Mock API - simulate deliveries from built-in sample responses instead of contacting Discord, for testing and demos.
   • Click Test Connection to send one test message and see the result on the page. Testing never saves your settings.
   • Click "Update Settings" to save.

2. Messenger Configuration:

   • Under "Messengers", click on "Messenger Configuration".
   • Assign Discord to the SMS Message Type (currently the only one supported by Blesta).

3. Enable Notifications:

   • Under "Messengers", go to "Message Templates".
   • Ensure the relevant templates are enabled.

Quick Support

How to Create a Discord Webhook

1. Login to Discord:

   • Open Discord and navigate to the server where you want to create the webhook.

2. Create Webhook:

   • Go to Server Settings > Integrations > Webhooks.
   • Click "New Webhook" and choose the channel where you want to send notifications.
   • Copy the webhook URL.

3. Configure Webhook in Blesta:

   • Paste the webhook URL into the plugin settings in Blesta and customise your notifications as needed.

Troubleshooting Notifications

• Order Notifications:

  • Go to Billing > Overview (/admin/billing/index/).
  • Scroll to the bottom. You should see an "Orders" panel. In its corner, there is a cogwheel for changing its settings. Click on it, then under "Order Notifications" enable "Messengers". Click "Update Settings" to save your changes.

• Ticket Notifications:

  • Go to Support > Departments (/admin/plugin/support_manager/admin_departments/).
  • Edit your desired department and check "Send Auto-Response Emails for New Tickets". Save your changes by clicking "Edit Department".

• Staff Ticket Notifications:

  • Go to Support > Staff (/admin/plugin/support_manager/admin_staff/).
  • Edit your desired staff member and check which ticket priorities should be sent to the Messenger. Save your changes by clicking "Edit Staff".

Things to Note

1. A notification too long for a single Discord embed is split across consecutive messages, so nothing is cut off the end. Only the first message carries the mention, so a split notification pings once.
2. HTML formatting is removed from notifications before sending, so they appear as plain text in the embed.
3. Enabling "Mock API" on the manage page simulates webhook deliveries from built-in sample responses instead of contacting Discord - useful for testing and demos without a live webhook URL. Leave the Webhook URL blank for a simulated successful delivery. Webhook addresses are still checked while Mock API is on, so that a placeholder cannot be left behind and go live the moment you turn Mock API off.
4. Both webhook URLs are stored encrypted and are never shown again on the settings page. Leave a webhook field blank to keep the stored URL, and fill it in only to replace it. For the same reason, "Test Connection" needs the Webhook URL typed in before it can test a live webhook.
5. Only https:// webhook addresses on discord.com or discordapp.com are accepted, because Discord does not issue webhooks anywhere else.
6. Once a Staff Webhook URL is stored, blanking the field no longer removes it. To stop routing staff notifications to a separate channel, set the Staff Webhook URL to the same address as the Webhook URL above.

You're now ready to use the Discord Messenger!

If you encounter any issues or have suggestions for improving the extension, please get in touch with us. We are committed to providing robust updates and welcome customer feedback.