Malcolm! will automatically send you email alerts when certain activity happens on your instance, such as a user leaving feedback or a Workflow being completed. Wherever possible we aggregate these alerts so you receive fewer emails but if you'd rather not receive them you can easily turn them off. To do this, from the MyMalcolm control panel area, click your name at the top of the screen where it says "Logged in as" You'll then be taken to your personal preferences. If you select the "Notifications" tab on the left you'll be able to edit the notifications you receive. Remember to hit "Save" once you are done! Note that your notificatons are based on an instance. If you are a user on more than one instance you should first switch to the instance you wish to adjust notifications for. You can do this using the drop down selector at the top right of the screen. You can therefore have different notification preferences for different instances. The notificiation preferences you choose are personal to you and will not affect the notifications of other team members on an instance.

Malcolm! will automatically send you email alerts when certain activity happens on your instance, such as a user leaving feedback or a Workflow being completed. Wherever possible we aggregate these alerts so you receive fewer emails but if you'd rather not receive them you can easily turn them off. To do this, from the MyMalcolm control panel area, click your name at the top of the screen where it says "Logged in as" You'll then be taken to your personal preferences. If you select the "Notifications" tab on the left you'll be able to edit the notifications you receive. Remember to hit "Save" once you are done! Note that your notificatons are based on an instance. If you are a user on more than one instance you should first switch to the instance you wish to adjust notifications for. You can do this using the drop down selector at the top right of the screen. You can therefore have different notification preferences for different instances. The notificiation preferences you choose are personal to you and will not affect the notifications of other team members on an instance.

You can use your own domain or sub-domain with Malcolm! There is no extra cost for doing this. To set this up go to the Settings Section in MyMalcolm then Custom Domains. Enter your custom domain and you will be given instructions on how to verify domain control/ownership and set up your DNS. We can host on SSL too and we'll automatically generate a secure certifcate for you. Once again, there is no extra cost for doing this! Once you have set up your custom domain or sub-domain both that and your malcolm.support / malcolm.app URL will work and serve content. If you don't want the .malcolm domains to work just select the redirect option and any traffic will be redirected. Watch a video guide to setting uo your own domain below.

You can use your own domain or sub-domain with Malcolm! There is no extra cost for doing this. To set this up go to the Settings Section in MyMalcolm then Custom Domains. Enter your custom domain and you will be given instructions on how to verify domain control/ownership and set up your DNS. We can host on SSL too and we'll automatically generate a secure certifcate for you. Once again, there is no extra cost for doing this! Once you have set up your custom domain or sub-domain both that and your malcolm.support / malcolm.app URL will work and serve content. If you don't want the .malcolm domains to work just select the redirect option and any traffic will be redirected. Watch a video guide to setting uo your own domain below.

Webhooks allow you to set up your own integrations to Malcolm! Workflow. By subscribing to the Workflow Completed event you will receive a HTTP POST Payload containing information about the completed Session. You could use this information to keep local records of when your Workflows are completed as well as receiving meta data like the start and completed times. For security and data privacy reasons we do not include the submitted Values in the payload. There are numerous ways the Values can be retrieved and matched up to the Session. The simplest way is to use the MyMalcolm Control Panel. Here you can view or export the Values. Alternatively, if you're on our Enterprise Plan, you can request an API Key and programmatically fetch the Values using our friendly REST API. ## Configuration Webhooks are are configured in "Workflow > Configure > Webhooks" section of MyMalcolm. The only requirement when adding or editing an existing Webhook is the URL. This is the URL Malcolm! will send the HTTP POST Payload to. The URL should be a secure URL (that means it starts with https://) and publicly accessible - i.e. not behind a firewall or on a local machine. There are conditional controls available too. If you have a condition configured the HTTP POST Payload will only be sent if the conditions at the end of the Workflow are satisfied. ## Payload The Payload is a simple HTTP POST with JSON Body. The Payload will contain the following special Headers. | Header | Description | |---|---| | X-Instance-Id | The ID of the Instance. E.g. "xxxxxxxxxx" | The Body will contain the following attributes. | Attribute | Description | |---|---| | id | The ID of the Workflow Session. E.g. "xxxxxxxxxx" | | label | A descriptive label, which will include the name of the person who completed the Workflow if your Workflow contains name attributes. E.g. "Completed by Malcolm!" | | locale | The locale used during the Workflow. E.g. "en-GB" | | started-at | The localised date and time the Session was started. E.g. "2020-04-01 12:00:00" | | completed-at | The localised date and time the Session was completed. E.g. "2020-04-01 12:00:00" | | workflow | The ID of the Workflow. E.g. "xxxxxxxxxx" | | workflow.name | The name of the Workflow. E.g. "Open Support Ticket" | | workflow.published-at | The localised date and time the Workflow was published. E.g. "2020-04-01 09:00:00" | | workflow.version | The name of the Workflow version. E.g. "Version 1" | ### Example Payload ``` POST /workflow-completed HTTP/1.1 Host: webhooks.my-domain.com Content-Type: application/json X-Instance-Id: xxxxxxxxxx { "id": "xxxxxxxxxx", "label": "Completed by Malcolm!", "locale": "en-GB", "started-at": "2020-04-01 12:00:00", "completed-at": "2020-04-01 12:05:00", "workflow": { "id": "xxxxxxxxxx", "name": "Open Support Ticket", "published-at": "2020-04-01 09:00:00", "version": "Version 1" } } ``` ## API For Enterprise customers a further HTTP GET Payload can be used to fetch the associated Values. | Endpoint | |---| | GET /sessions/xxxxxxxxxx/values | | Header | Description | |---|---| | Host | api.malcolm.solutions/1.0/workflow-api | | Accept | application/json | | Authorization | A Bearer string composed by concatenating "api-key:" and your API key and then Base 64-encoding the result. E.g. "Bearer xxxxxxxxxx" | | X-Instance-Id | The ID of the Instance. E.g. "xxxxxxxxxx" | ### Example Response ``` { "data": [ { "attributes": { "is-valid": true, "value": "Malcolm!" }, "id": "xxxxxxxxxx", "links": { "self": "/values/xxxxxxxxxx" }, "meta": { "field": { "id": "xxxxxxxxxx", "name": "Name", "required": true, "type": "Name" } }, "relationships": { "field": { "links": { "related": "/values/xxxxxxxxxx/field", "self": "/values/xxxxxxxxxx/relationships/field" } } }, "type": "values" }, ... ], "links": { "first": "/sessions/xxxxxxxxxx/values?page=1", "last": "/sessions/xxxxxxxxxx/values?page=1", "self": "/sessions/xxxxxxxxxx/values?page=1" }, "meta": { "pagination": { "total": 1, "per-page": 1, "current-page": 1, "page-count": 1, "from": 1, "to": 1 } } } ``` For further help or information on our Enterprise Plan please contact the [Support Team](mailto:support@malcolm.support).

Webhooks allow you to set up your own integrations to Malcolm! Workflow. By subscribing to the Workflow Completed event you will receive a HTTP POST Payload containing information about the completed Session. You could use this information to keep local records of when your Workflows are completed as well as receiving meta data like the start and completed times. For security and data privacy reasons we do not include the submitted Values in the payload. There are numerous ways the Values can be retrieved and matched up to the Session. The simplest way is to use the MyMalcolm Control Panel. Here you can view or export the Values. Alternatively, if you're on our Enterprise Plan, you can request an API Key and programmatically fetch the Values using our friendly REST API. ## Configuration Webhooks are are configured in "Workflow > Configure > Webhooks" section of MyMalcolm. The only requirement when adding or editing an existing Webhook is the URL. This is the URL Malcolm! will send the HTTP POST Payload to. The URL should be a secure URL (that means it starts with https://) and publicly accessible - i.e. not behind a firewall or on a local machine. There are conditional controls available too. If you have a condition configured the HTTP POST Payload will only be sent if the conditions at the end of the Workflow are satisfied. ## Payload The Payload is a simple HTTP POST with JSON Body. The Payload will contain the following special Headers. | Header | Description | |---|---| | X-Instance-Id | The ID of the Instance. E.g. "xxxxxxxxxx" | The Body will contain the following attributes. | Attribute | Description | |---|---| | id | The ID of the Workflow Session. E.g. "xxxxxxxxxx" | | label | A descriptive label, which will include the name of the person who completed the Workflow if your Workflow contains name attributes. E.g. "Completed by Malcolm!" | | locale | The locale used during the Workflow. E.g. "en-GB" | | started-at | The localised date and time the Session was started. E.g. "2020-04-01 12:00:00" | | completed-at | The localised date and time the Session was completed. E.g. "2020-04-01 12:00:00" | | workflow | The ID of the Workflow. E.g. "xxxxxxxxxx" | | workflow.name | The name of the Workflow. E.g. "Open Support Ticket" | | workflow.published-at | The localised date and time the Workflow was published. E.g. "2020-04-01 09:00:00" | | workflow.version | The name of the Workflow version. E.g. "Version 1" | ### Example Payload ``` POST /workflow-completed HTTP/1.1 Host: webhooks.my-domain.com Content-Type: application/json X-Instance-Id: xxxxxxxxxx { "id": "xxxxxxxxxx", "label": "Completed by Malcolm!", "locale": "en-GB", "started-at": "2020-04-01 12:00:00", "completed-at": "2020-04-01 12:05:00", "workflow": { "id": "xxxxxxxxxx", "name": "Open Support Ticket", "published-at": "2020-04-01 09:00:00", "version": "Version 1" } } ``` ## API For Enterprise customers a further HTTP GET Payload can be used to fetch the associated Values. | Endpoint | |---| | GET /sessions/xxxxxxxxxx/values | | Header | Description | |---|---| | Host | api.malcolm.solutions/1.0/workflow-api | | Accept | application/json | | Authorization | A Bearer string composed by concatenating "api-key:" and your API key and then Base 64-encoding the result. E.g. "Bearer xxxxxxxxxx" | | X-Instance-Id | The ID of the Instance. E.g. "xxxxxxxxxx" | ### Example Response ``` { "data": [ { "attributes": { "is-valid": true, "value": "Malcolm!" }, "id": "xxxxxxxxxx", "links": { "self": "/values/xxxxxxxxxx" }, "meta": { "field": { "id": "xxxxxxxxxx", "name": "Name", "required": true, "type": "Name" } }, "relationships": { "field": { "links": { "related": "/values/xxxxxxxxxx/field", "self": "/values/xxxxxxxxxx/relationships/field" } } }, "type": "values" }, ... ], "links": { "first": "/sessions/xxxxxxxxxx/values?page=1", "last": "/sessions/xxxxxxxxxx/values?page=1", "self": "/sessions/xxxxxxxxxx/values?page=1" }, "meta": { "pagination": { "total": 1, "per-page": 1, "current-page": 1, "page-count": 1, "from": 1, "to": 1 } } } ``` For further help or information on our Enterprise Plan please contact the [Support Team](mailto:support@malcolm.support).

No - all plans include extensive branding options. We want to make it as easy as possible for you to integrate Malcolm! and reflect the existing look and feel of your business. Some of the branding options include: * Upload your logo * Change fonts * Change colours * Change favicon * Configure header and background images * Choose from a range of icons or upload your own * Show / hide / configure page elements * Configure excerpts * Configure suggested search * Change button labels * Configure number of search results returned per page * Configure filters * Featured Box and Promo management * Footer management * Configure 404 page * Choose different Workflow layouts * Configure SEO options * ....and lots more! If you need a hand creating logos, headers or other graphical assets we do offer a service that can help - [see here for more information. ](https://malcolm.support/services)

No - all plans include extensive branding options. We want to make it as easy as possible for you to integrate Malcolm! and reflect the existing look and feel of your business. Some of the branding options include: * Upload your logo * Change fonts * Change colours * Change favicon * Configure header and background images * Choose from a range of icons or upload your own * Show / hide / configure page elements * Configure excerpts * Configure suggested search * Change button labels * Configure number of search results returned per page * Configure filters * Featured Box and Promo management * Footer management * Configure 404 page * Choose different Workflow layouts * Configure SEO options * ....and lots more! If you need a hand creating logos, headers or other graphical assets we do offer a service that can help - [see here for more information. ](https://malcolm.support/services)

Yes, the best way to do this is via an external host like YouTube or Vimeo. [Find out more here. ](https://support.malcolm.support/faqs/can-i-embed-youtube-or-vimeo-videos-in-my-faqs)

A Workflow is a web based form that your customers complete. You can build these forms quickly in MyMalcolm and use them to create a digital version of a business process. **For example** * A contact form * A survey * A customer enquiry * A new customer details form You can build everything from simple single screen journeys through to more complex multi-step journeys with conditional routing (ie offering certain choices based on previous answers). Malcolm! automatically stores all data - including abandoned forms. You can export this data at any time. You can also pass that collected data through to other systems via Integrations or Webhooks.

A Workflow is a web based form that your customers complete. You can build these forms quickly in MyMalcolm and use them to create a digital version of a business process. **For example** * A contact form * A survey * A customer enquiry * A new customer details form You can build everything from simple single screen journeys through to more complex multi-step journeys with conditional routing (ie offering certain choices based on previous answers). Malcolm! automatically stores all data - including abandoned forms. You can export this data at any time. You can also pass that collected data through to other systems via Integrations or Webhooks.

Within Malcolm! you can choose the title of your FAQs and Workflows, but you may want to use Malcolm! in a way where the terminology "FAQs" and "Workflows" doesn't make sense. For example you might want to rename FAQs "Policies" or "Help Articles". You might want to rename Workflows "Requests" or "Tasks". This is no problem - you can rename both things in the Brand section of MyMalcolm. Edit your chosen theme, then navigate to the "FAQ" and "Workflow" section in the vertical side navigation. MyMalcolm will still refer to FAQs and Workflows but any references your users see will be updated to the value you set above.

Within Malcolm! you can choose the title of your FAQs and Workflows, but you may want to use Malcolm! in a way where the terminology "FAQs" and "Workflows" doesn't make sense. For example you might want to rename FAQs "Policies" or "Help Articles". You might want to rename Workflows "Requests" or "Tasks". This is no problem - you can rename both things in the Brand section of MyMalcolm. Edit your chosen theme, then navigate to the "FAQ" and "Workflow" section in the vertical side navigation. MyMalcolm will still refer to FAQs and Workflows but any references your users see will be updated to the value you set above.

It can be very useful to give your users the option to save progress on a Workflow and come back to complete the rest later. It's especially helpful if a you have built a long multi-stage Workflow like an application form. You turn this feature on in MyMalcolm - go to the Configure screen of each individual Workflow. When turned on users will see an option to "Finish Later" at the bottom of each Workflow screen. When clicked this will bring up an overlay asking them to enter their email address. A unique link will then be emailed that when clicked will take the user back to the same stage of the Workflow they were previously at. If you need to retrieve these links (for example someone completing the form didn't receive or has lost the email with the resume link in) you can also get to the link via the Completions area of the Workflow section of MyMalcolm - click the link under "Resume link" to copy the URL your clipboard.

It can be very useful to give your users the option to save progress on a Workflow and come back to complete the rest later. It's especially helpful if a you have built a long multi-stage Workflow like an application form. You turn this feature on in MyMalcolm - go to the Configure screen of each individual Workflow. When turned on users will see an option to "Finish Later" at the bottom of each Workflow screen. When clicked this will bring up an overlay asking them to enter their email address. A unique link will then be emailed that when clicked will take the user back to the same stage of the Workflow they were previously at. If you need to retrieve these links (for example someone completing the form didn't receive or has lost the email with the resume link in) you can also get to the link via the Completions area of the Workflow section of MyMalcolm - click the link under "Resume link" to copy the URL your clipboard.

Within MyMalcolm go the FAQ Section and click "Create a FAQ" towards to the top right of the screen. This will bring up the "compose your question and answer" dialogue. Here you can input the question, an optional brief summary answer (used in search and browse results) and your full answer. [For tips on how to write a good FAQ click here!](https://support.malcolm.support/faqs/how-do-i-write-a-good-frequently-asked-question-faq) When composing your FAQ you can use the formating controls in the "full answer" box or directly enter Markdown. Markdown is a great way of quickly adding formatting to textual content. If you've not used it before it can take a minute or two to get used to it but it's very fast to work with once you have got the hang of it. You can click the "Need help with Markdown?" button bottom left anytime for a quick reference Markdown guide. You can see what your FAQ will look like to your users by pressing the "Preview" button top right. When you have written your content press "Next: Configure" to move onto the configuration options for your FAQ. In this area you can control various things about your FAQ such as whether an author is shown, what the URL is, your choice of tags, whether the feedback form is enabled and the category or categories the FAQ lives in. You also have various options around whether the FAQ can be seen by search engines, is password protected or not and can be found or not via the Malcolm! search/browse capability. You can even set the FAQ (or versions of it) to publish and un-publish automatically at certain dates and time in the future. Watch a video guide to creating an FAQ below.

Within MyMalcolm go the FAQ Section and click "Create a FAQ" towards to the top right of the screen. This will bring up the "compose your question and answer" dialogue. Here you can input the question, an optional brief summary answer (used in search and browse results) and your full answer. [For tips on how to write a good FAQ click here!](https://support.malcolm.support/faqs/how-do-i-write-a-good-frequently-asked-question-faq) When composing your FAQ you can use the formating controls in the "full answer" box or directly enter Markdown. Markdown is a great way of quickly adding formatting to textual content. If you've not used it before it can take a minute or two to get used to it but it's very fast to work with once you have got the hang of it. You can click the "Need help with Markdown?" button bottom left anytime for a quick reference Markdown guide. You can see what your FAQ will look like to your users by pressing the "Preview" button top right. When you have written your content press "Next: Configure" to move onto the configuration options for your FAQ. In this area you can control various things about your FAQ such as whether an author is shown, what the URL is, your choice of tags, whether the feedback form is enabled and the category or categories the FAQ lives in. You also have various options around whether the FAQ can be seen by search engines, is password protected or not and can be found or not via the Malcolm! search/browse capability. You can even set the FAQ (or versions of it) to publish and un-publish automatically at certain dates and time in the future. Watch a video guide to creating an FAQ below.

When creating a Workflow (you might prefer to call it a form or a user journey) you may want to vary what is presented to the user based on their earlier inputs. For example if you sell different types of product and want to build a returns form the information you ask for might vary from product to product. So you'd ideally ask the user to choose the type of product they want to return, then show them further relevant questions that related to that type of product only. Rules and routing in Malcolm! Workflows let you do just this - you can create complex and adaptive multi-step user journeys / forms easily via this feature. Below is a simple example of how rules and routing work. In this example we create a simple form that asks a user for some basic details (their name, email address and "further details"). If they select "yes" to the question "Do you have documents or files to upload?" we'll include a screen for them to upload those files before they complete the form. If the user selects "no" we won't show them this screen and they will go direct to the Thank You screen. Here is the setup in the Workflow builder in MyMalcolm: Conceptually it is important to understand that rules and routing works at a page level (not at a question level). So where you have questions that will only be shown to the user in certain scenarios you should put those questions on their own page. You then use rules to show or hide those pages. In our example we have set the "Include page by default" setting on page 2 to be off. By doing this page 2 is "hidden" and can only be seen by routing to it via a rule. You configure rules at a question/element level. So in our example we now need to set up a rule on the "Do you have files or documents to upload?" question/element. To do this click on that question/element. In the overlay that appears select "rules". Then add the rule that if the value is equal to yes to include page 2. The available options in values will vary according to the type of question/element you are editing. In "Then...." you have the option of including a page, hiding a page or moving to it. If you move to a page the Workflow will then continue from that page and jump over any pages before. You can see the full range of options for this element type below.

When creating a Workflow (you might prefer to call it a form or a user journey) you may want to vary what is presented to the user based on their earlier inputs. For example if you sell different types of product and want to build a returns form the information you ask for might vary from product to product. So you'd ideally ask the user to choose the type of product they want to return, then show them further relevant questions that related to that type of product only. Rules and routing in Malcolm! Workflows let you do just this - you can create complex and adaptive multi-step user journeys / forms easily via this feature. Below is a simple example of how rules and routing work. In this example we create a simple form that asks a user for some basic details (their name, email address and "further details"). If they select "yes" to the question "Do you have documents or files to upload?" we'll include a screen for them to upload those files before they complete the form. If the user selects "no" we won't show them this screen and they will go direct to the Thank You screen. Here is the setup in the Workflow builder in MyMalcolm: Conceptually it is important to understand that rules and routing works at a page level (not at a question level). So where you have questions that will only be shown to the user in certain scenarios you should put those questions on their own page. You then use rules to show or hide those pages. In our example we have set the "Include page by default" setting on page 2 to be off. By doing this page 2 is "hidden" and can only be seen by routing to it via a rule. You configure rules at a question/element level. So in our example we now need to set up a rule on the "Do you have files or documents to upload?" question/element. To do this click on that question/element. In the overlay that appears select "rules". Then add the rule that if the value is equal to yes to include page 2. The available options in values will vary according to the type of question/element you are editing. In "Then...." you have the option of including a page, hiding a page or moving to it. If you move to a page the Workflow will then continue from that page and jump over any pages before. You can see the full range of options for this element type below.