Skip to main content

setHelpHubFilter(filter)

Set the HelpHub to only include help docs with matching labels/tags. This filter applies to both HelpHub and Copilot.

Currently only supported for Zendesk labels.

Examples​

Include help docs with Article and Video labels:​

const labels = ["Article", "Video"];
window.CommandBar.setHelpHubFilter({ labels: labels });

Match help docs according to a user's feature set​

if (!user.isPaid) {
  window.CommandBar.setHelpHubFilter({ labels: ["Free"]; });
} else (
  window.CommandBar.setHelpHubFilter({ labels: ["Free", "Professional"]; });
)

Method parameters​

filter​

object

Filter to apply

PropertyTypeDescription
labelsstring[]List of labels. Any Help Docs tagged with matching labels will be displayed in HelpHub and all others will be excluded.