It's quick and easy to embed a Workflow into your website or app. In the Library screen of the Workflow section of MyMalcolm click the three dots on the right hand side of the screen and select "Embed" This will take you into the Share section of MyMalcolm! Here you can choose the type of embed you want to create. * If you want to float your Workflow over your webpage in a widget launched from a button or drawer that hugs the side or top/bottom of the screen select Widget. * If you want to launch an overlay that contains your Workflow from your webpage choose the Overlay option. * If you want your Workflow to appear within a part of an exisiting webpage select the inline option. * Finally if you want your Workflow to replace the entire content of a page select Full page. Follow the create embed process through - the Workflow you came from will be preselected as the content you want to embed. You will be offered various styling and display options based on the type of embed you choose. At the end of the process you will be supplied with the embed code that you can add to he site or app where you want the Workflow to appear.

It's quick and easy to embed a Workflow into your website or app. In the Library screen of the Workflow section of MyMalcolm click the three dots on the right hand side of the screen and select "Embed" This will take you into the Share section of MyMalcolm! Here you can choose the type of embed you want to create. * If you want to float your Workflow over your webpage in a widget launched from a button or drawer that hugs the side or top/bottom of the screen select Widget. * If you want to launch an overlay that contains your Workflow from your webpage choose the Overlay option. * If you want your Workflow to appear within a part of an exisiting webpage select the inline option. * Finally if you want your Workflow to replace the entire content of a page select Full page. Follow the create embed process through - the Workflow you came from will be preselected as the content you want to embed. You will be offered various styling and display options based on the type of embed you choose. At the end of the process you will be supplied with the embed code that you can add to he site or app where you want the Workflow to appear.

You can change the text label next to the email an FAQ feature on an indiviual FAQ. This can be useful if you are using the FAQ part of Malcolm! to publish articles or other types of content rather than just answers to questions and the "email this answer" language no longer makes sense. To update the text go to the Brand section in MyMalcolm, then Themes, then click the edit icon in the relevant theme then select "FAQs" in the left hand nav.

You can change the text label next to the email an FAQ feature on an indiviual FAQ. This can be useful if you are using the FAQ part of Malcolm! to publish articles or other types of content rather than just answers to questions and the "email this answer" language no longer makes sense. To update the text go to the Brand section in MyMalcolm, then Themes, then click the edit icon in the relevant theme then select "FAQs" in the left hand nav.

Integrations are a way of passing data you collect in a Malcolm! Workflow into other third party software or systems. We currently offer integrations with: * [Dropbox](http://www.dropbox.com) * [Mailchimp](http://www.mailchimp.com) * [Mandrill](http://www.mandrill.com) * [Twilio](http://www.twilio.com) * [Zendesk](http://www.zendesk.com) * and over 1,500 over apps via Zapier.com ([more info here](https://support.malcolm.support/faqs/how-do-i-use-zapier-to-connect-malcolm-to-other-applications-or-services-i-use)) **Configuring Integrations** Once you have created your Workflow, go to the Configure section and select Integrations. There you can link your third party accounts at our integration partners to your Malcolm! Instance by providing your credentials. Once your accounts are linked you can configure integrations with that partner and choose the data from your Workflow that is passed across. You can configure whether data is passed on every Workflow completion or only when certain conditions are met. It is possible to have multiple integrations so, for example, you could create a form which collected details from a new customer including a copy of their ID. You could then subscribe that new customer to a Mailchimp mailing list and store their uploaded ID documents in your Dropbox account by creating two integrations. **Customer Consent** A reminder that it is good practice - and in certain territories a legal requirement - to ensure that your customers actively consent to their data being passed to third party companies who, like Malcolm!, act as data processors on your behalf. You act as the data controller. Most companies handle this consent via provisions in their Privacy Policy which their customers agree to. It is good practice therefore to include a check box in your Workflows that reminds customers of your Privacy Policy and their continuing agreement of it. **Integration Failures** Sometimes integrations may fail. This could be for a variety of reasons, for example the integration partner's API's may be down and/or there may be a problem with your account at the third party provider (for example your Dropbox account may be over quota). Firstly don't worry re losing customer data - Malcolm! will always store any user submitted data so if there is a problem with an integration you won't lose any data. When a problem occurs we'll create a notification to let you know and periodically retry the integration. You can review the Integration logs and retry a failed integration event manually via MyMalcolm (navigate to the Workflow via Library then select Integration logs) **More Integrations coming soon!** We will be adding more and more integrations to Malcolm! in the coming months. If there is a particular integration you'd like us to add [please let us know! ](https://support.malcolm.support/workflows/feedback)

Integrations are a way of passing data you collect in a Malcolm! Workflow into other third party software or systems. We currently offer integrations with: * [Dropbox](http://www.dropbox.com) * [Mailchimp](http://www.mailchimp.com) * [Mandrill](http://www.mandrill.com) * [Twilio](http://www.twilio.com) * [Zendesk](http://www.zendesk.com) * and over 1,500 over apps via Zapier.com ([more info here](https://support.malcolm.support/faqs/how-do-i-use-zapier-to-connect-malcolm-to-other-applications-or-services-i-use)) **Configuring Integrations** Once you have created your Workflow, go to the Configure section and select Integrations. There you can link your third party accounts at our integration partners to your Malcolm! Instance by providing your credentials. Once your accounts are linked you can configure integrations with that partner and choose the data from your Workflow that is passed across. You can configure whether data is passed on every Workflow completion or only when certain conditions are met. It is possible to have multiple integrations so, for example, you could create a form which collected details from a new customer including a copy of their ID. You could then subscribe that new customer to a Mailchimp mailing list and store their uploaded ID documents in your Dropbox account by creating two integrations. **Customer Consent** A reminder that it is good practice - and in certain territories a legal requirement - to ensure that your customers actively consent to their data being passed to third party companies who, like Malcolm!, act as data processors on your behalf. You act as the data controller. Most companies handle this consent via provisions in their Privacy Policy which their customers agree to. It is good practice therefore to include a check box in your Workflows that reminds customers of your Privacy Policy and their continuing agreement of it. **Integration Failures** Sometimes integrations may fail. This could be for a variety of reasons, for example the integration partner's API's may be down and/or there may be a problem with your account at the third party provider (for example your Dropbox account may be over quota). Firstly don't worry re losing customer data - Malcolm! will always store any user submitted data so if there is a problem with an integration you won't lose any data. When a problem occurs we'll create a notification to let you know and periodically retry the integration. You can review the Integration logs and retry a failed integration event manually via MyMalcolm (navigate to the Workflow via Library then select Integration logs) **More Integrations coming soon!** We will be adding more and more integrations to Malcolm! in the coming months. If there is a particular integration you'd like us to add [please let us know! ](https://support.malcolm.support/workflows/feedback)

You can change the URL of your Hosted Hub via the Settings Section of MyMalcolm. Go to Custom Domains and you choose a new URL on malcolm.support or malcolm.app here. The URL must be available ie not being used by another customer. You can also configure your own external domain or sub domain in this area as well.

You can change the URL of your Hosted Hub via the Settings Section of MyMalcolm. Go to Custom Domains and you choose a new URL on malcolm.support or malcolm.app here. The URL must be available ie not being used by another customer. You can also configure your own external domain or sub domain in this area as well.

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.

**What is GDPR?** "GDPR" refers to The General Data Protection Regulation 2016/679. This is a regulation in EU law on data protection and privacy for all individuals within the European Union and the European Economic Area. It also addresses the export of personal data outside the EU and EEA areas. **How does it apply to Malcolm?** Malcolm! collects, stores and processes data about our own customers - people signing up to Malcolm! and creating and managing instances. We may also - via Workflows - collect, store, process and transfer data about your customers. When talking about GDPR it is important to understand the concept of the Data Controller and the Data Processor. * The **Data Controller** determines the purposes for which and the means by which personal data is processed * The **Data Processor** processes personal data only on behalf of the controller. **Is Malcolm! the Data Controller or the Data Processor?** In the context of information about our own customers, eg people who sign up for Malcolm! accounts and manage Instances we are the Data Controller. In the context of information about your customers, eg information that is collected on your behalf via Workflows you create in Malcolm! we are the Data Processor only. You - as the Data Controller - have the obligation to ensure you are acting lawfully in accordance with the GDPR legislation. **What does all this mean?** When you sign up to Malcolm! you agree to our [Terms of Service](https://malcolm.support/terms) and our [Privacy Policy](https://malcolm.support/privacy) which detail how we handle your data. By agreeing you give us your consent. It is important that when you collect, store, process and potentially transfer (via Integrations or Exports) data from your own customers via a Malcolm! Workflow you have your customers consent to do this. Most companies handle this via provisions in their Privacy Policy and/or Terms and Conditions around data processing which their customers agree to. **It is therefore good practice to include a check box in your Workflows that reminds customers of your Privacy Policy and their continuing agreement of it and/or confirms their consent for you to collect and process their information** **Further Questions** If you have further questions about GDPR or wish to contact our Data Protection Officer [you can contact us here](https://malcolm.support/contact). [You can find out more about GDPR here. ](https://ico.org.uk/for-organisations/guide-to-the-general-data-protection-regulation-gdpr/)

**What is GDPR?** "GDPR" refers to The General Data Protection Regulation 2016/679. This is a regulation in EU law on data protection and privacy for all individuals within the European Union and the European Economic Area. It also addresses the export of personal data outside the EU and EEA areas. **How does it apply to Malcolm?** Malcolm! collects, stores and processes data about our own customers - people signing up to Malcolm! and creating and managing instances. We may also - via Workflows - collect, store, process and transfer data about your customers. When talking about GDPR it is important to understand the concept of the Data Controller and the Data Processor. * The **Data Controller** determines the purposes for which and the means by which personal data is processed * The **Data Processor** processes personal data only on behalf of the controller. **Is Malcolm! the Data Controller or the Data Processor?** In the context of information about our own customers, eg people who sign up for Malcolm! accounts and manage Instances we are the Data Controller. In the context of information about your customers, eg information that is collected on your behalf via Workflows you create in Malcolm! we are the Data Processor only. You - as the Data Controller - have the obligation to ensure you are acting lawfully in accordance with the GDPR legislation. **What does all this mean?** When you sign up to Malcolm! you agree to our [Terms of Service](https://malcolm.support/terms) and our [Privacy Policy](https://malcolm.support/privacy) which detail how we handle your data. By agreeing you give us your consent. It is important that when you collect, store, process and potentially transfer (via Integrations or Exports) data from your own customers via a Malcolm! Workflow you have your customers consent to do this. Most companies handle this via provisions in their Privacy Policy and/or Terms and Conditions around data processing which their customers agree to. **It is therefore good practice to include a check box in your Workflows that reminds customers of your Privacy Policy and their continuing agreement of it and/or confirms their consent for you to collect and process their information** **Further Questions** If you have further questions about GDPR or wish to contact our Data Protection Officer [you can contact us here](https://malcolm.support/contact). [You can find out more about GDPR here. ](https://ico.org.uk/for-organisations/guide-to-the-general-data-protection-regulation-gdpr/)

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.id | 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.id | 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).

You can easily add the Facebook Pixel to any content you create in Malcolm! such as Workflows and FAQs. There are two ways you can do this. The first is to add the Facebook Pixel code directly into the settings area of MyMalcolm - [for more details see this FAQ.](https://support.malcolm.support/faqs/can-i-put-tracking-tags-in-my-faqs-workflows-support-hub). The other way is to use Google Tag Manager. You add your GTM container id in the settings area of MyMalcolm and then add your Facebook Pixel via the Google Tag Manager interface.

You can easily add the Facebook Pixel to any content you create in Malcolm! such as Workflows and FAQs. There are two ways you can do this. The first is to add the Facebook Pixel code directly into the settings area of MyMalcolm - [for more details see this FAQ.](https://support.malcolm.support/faqs/can-i-put-tracking-tags-in-my-faqs-workflows-support-hub). The other way is to use Google Tag Manager. You add your GTM container id in the settings area of MyMalcolm and then add your Facebook Pixel via the Google Tag Manager interface.

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. 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.

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. 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.

Malcolm! auto generates certain listings of FAQs such as most helpful, most popular, recently added and trending. If an FAQ is hidden ([see here for more info](https://support.malcolm.support/faqs/how-do-i-hide-an-faq) it won't be included in these listings but sometimes you may wish to exclude a regular non hidden FAQ from these listings. You can do this via in MyMalcolm via the individual FAQ's visibility settings (FAQs / Library / Configure / Visibility):

Malcolm! auto generates certain listings of FAQs such as most helpful, most popular, recently added and trending. If an FAQ is hidden ([see here for more info](https://support.malcolm.support/faqs/how-do-i-hide-an-faq) it won't be included in these listings but sometimes you may wish to exclude a regular non hidden FAQ from these listings. You can do this via in MyMalcolm via the individual FAQ's visibility settings (FAQs / Library / Configure / Visibility):