Question 1

Can I embed YouTube or Vimeo videos in my FAQs and Workflows?

Accepted Answer

You can easily embed YouTube or Vimeo videos into your FAQs and/or Workflows. Within the FAQ compose interface press the video icon. This will bring up an area where you can paste the URL of the video you wish to embed.

Insert video dialog in MyMalcolm

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/oFZ9QoY435/screenshot-my.malcolm.app-2023.04.02-17_56_57.png (Insert video dialog in MyMalcolm)

If you want to use some of the embed customisation options that YouTube and Vimeo offer you should use the full embed code from those platforms (rather than just pasting the URL). Paste their embed code into the lower part of the MyMalcolm insert video dialog.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/m6StT5M3j9/Screenshot%202018-11-08%2020.01.41.png (Screenshot 2018-11-08 20.01.41.png)

For Workflows add a content element to your Workflow, then in the Workflow builder click to edit the content element and hit the video icon. This will bring up the same dialog as above.

Question 2

What are Webhooks and how do I use them to receive notifications when Workflows are completed?

Accepted Answer

Webhooks allow you to set up your own integrations to Malcolm! Workflow.

Webhooks are endpoints on web servers you own. Whenever a Workflow is completed the configured Webhooks will be notified. The Payload will contain the completed Workflow Session, related Workflow and (optionally) the submitted Workflow Values.

Configuration

Webhooks are are configured in "Workflows > Edit > Configure > Webhooks" section of MyMalcolm.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/IWqLLH7kgn/Screenshot%202021-01-26%20at%2016.17.46.png (Screenshot 2021-01-26 at 16.17.46.png)

Webhook URL

The only requirement is to provide the URL of your Webhook. This is the URL Malcolm! will send the Payload to.

The URL should be a secure endpoint which means it should start with https://, although we do support http:// too. The endpoint should also be accessible which means hosted on a remote machine, not behind a firewall and not requiring Authentication.

Include the Workflow Values

There is an additional option to include the submitted Workflow Values in the Payload. This option is disabled by default for security reasons but available to use should you wish to enable it. By enabling the option you agree to the following terms -

(a) I would like the Workflow Values included in the Webhook Payload (b) the recieving web server is private and properly secured (c) I am aware the use of Webhooks can facilitate the transfer of end-user personal data to third party Data Processors and my use of Webhooks adheres to my responsibilities as Data Controller under applicable Data Protection Laws.

Secure your Webhook with a secret token

Webhook URLs can be called by anyone and are therefore insecure.

To ensure a request to your Webhook URL comes from Malcolm! a secret token known only by yourself and Malcolm! can be used to generate a Signature.

Malcolm! will take the Payload and the secret and create a Signature. This will be passed to your App as the request header X-Signature. Your App will use the same secret and the received Payload to generate a second Signature. If the Signatures match you know the request came from Malcolm! and not another source.

The secret token can be any string you like, but Malcolm! recommends using a random string of at least 36 characters. For example in a Terminal window run -

To validate the Payload from Malcolm! use the HMAC SHA-256 algorithm to create a hash using the Payload as the data and your secret as the key.

For example in PHP use the hash_hmac function to generate a binary hash.

Next encode the binary hash using a Base 64 encoder, in PHP this is the base64_encode function.

Finally prefix the encoded hash with "sha256=" and compare with the value of X-Signature. In PHP you can use the $_SERVER variable to access the headers.

Conditional settings

There are conditional controls available too. If you have a condition configured the Webhook will only be notified if the conditions at the end of the Workflow are satisfied.

Headers

The HTTP POST will contain the following Headers.

Payload

The Payload will be a JSON Body containing the Workflow Session.

Workflows are defined as -

Workflow Values are defined as -

Workflow Fields are defined as -

Example

Question 3

What is MyMalcolm?

Accepted Answer

MyMalcolm is comprehensive control panel area of Malcolm! where you can manage your instances. It is accessed at https://my.malcolm.app.

Question 4

Do you support animated GIFs?

Accepted Answer

Yes you can use animated GIFs in Malcolm! placing them in your FAQs or in Workflows (via the Content element).

You can upload the animated GIF into the media section of MyMalcolm or you can pull in externally hosted GIFs.

This cat has been uploaded to MyMalcolm:

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/WsOiR3iaEG/Cat.gif (Animated Cat.gif)

To pull in external GIFs use the following Markdown syntax:

The above Markdown results in this:

https://media.giphy.com/media/QpWDP1YMziaQw/source.gif (Image Description)

Have fun!

Question 5

How do I switch between Instances?

Accepted Answer

If you are a user on more than one instance you'll see a "My Instances" screen when you login to MyMalcolm.

Once you are in one instance you can also easily switch to another via the drop down that appears at the top of the MyMalcolm interface.

Question 6

What is my Hosted Hub?

Accepted Answer

Every instance of Malcolm! comes with a Hosted Hub. This is a website that we host for you. You can customise it entirely to your requirements. You can change the branding, the colours, the fonts, the layout, the copy, the icons etc etc. You can even configure it to work on one of your own domains or sub domains.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/V93ed8Zu51/brand-facebook%402x.png (Hosted Hub on Malcolm!)

If you don't have a current website your Hosted Hub could be your main website. If you already have your main website at www.domain.com you could set up your fully branded Malcolm! Hosted Hub at a sub domain like support.domain.com or help.domain.com or customers.domain.com

Some customers may not wish to do this and instead may wish to integrate Malcolm! into their current website. No problem! We have a whole section in the MyMalcolm Control Panel dedicated to this and there a variety of ways you can bring content and functionality from Malcolm! into your own website. We've also got a plugin for Wordpress and a variety of widgets and further integration options coming soon. Customers on our Enterprise plans can have full progamatic access to Malcolm! content and functionality via our comprehensive API.

Question 7

Can I turn tags off?

Accepted Answer

You can turn the display of all tags or individual tags off/on. This will also affect the tag listing/results screens.

This feature can be useful in a number of ways, for example if you are prepping a new tag to go live and want to attach it to all your relevant FAQs/Articles but don't want it to display just yet you can simply leave it switched off until you are ready.

You can turn Tags off globally in Settings --> FAQs --> General (under the "Listings" heading)

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/WW0eQrCvC4/screenshot-my.malcolm.app-2023.04.02-15_42_17.png (Turning tags off globally in MyMalcolm)

Individual tags and their associated listings/results can be turned off via FAQs --> Tags then the three-dot menu to the right of the tag in question

Question 8

Can I embed HTML or add iframes to Malcolm! content?

Accepted Answer

Malcolm! FAQ supports embedding content via HTML iframes.

Most popular content channels such as YouTube and Vimeo offer an embed sharing option via HTML iframes.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/TEt5gCaFXw/Screenshot%202021-01-29%20at%2011.06.24.png (Screenshot 2021-01-29 at 11.06.24 (1).png)

Malcolm! has two buttons on its editor toolbar. One for inserting video or presentation type content and one for other type of content. To use these features simply locate the HTML iframe code on your content channel and copy/paste it into one of these two dialogs.

Question 9

What are Tags in FAQs?

Accepted Answer

Tags are a way of describing your content and allow an alternate way for your customers to browse FAQ's aside from search and categories.

You can add and manage the tags that are attached to each of your FAQs via the "configure" area.

You may also be interested in invisible tags.

Question 10

Can I turn off the "last updated" date on FAQs?

Accepted Answer

If you'd like to hide the "last updated" date displayed on an FAQ you can do this on a per FAQ basis via the Configure / General area of the FAQ in MyMalcolm:

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/rAF6afXiNL/screenshot-my.malcolm.app-2019.10.23-11_42_54.png (Enabling or disabling the last updated date globally)

If you want to turn off this feature for all FAQ's in the instance you can do this globally via Settings / FAQs / General Settings: