Build your first Card

7. Modify Card metadata

After designing our Card the last step is to define where and when it shows up in the Digital Assistant app. This article will explain how to do that by modifying the Card's metadata.

Going into the metadata

To access the metadata editor, you need to locate the folder where your card is stored. For our example card, this is Spaces/Global/Components/my-first-card/.

The link to the metadata editor is located in the top right of the folder view. In the screenshot below, it is Card: Basic Card (with test data) above the blue buttons.

Metadata Editor link

Here it is called Card: Basic Card (with test data).

Metadata Editor interface

Metadata Editor interface

There are a variety of options in the editor, all of which modify the behavior of the card.


Here you can edit the name of the card.

This must be unique and contain no spaces.


This is the title that will be shown in the Card Title element, and in the Card Store.

Assistant Command Type

There are 3 types of commands we will cover in this article; No command, Keywords, and Utterances.

No command

If this command type is selected, then the card will not show up in search results. There will be no search trigger terms or phrases.


For this command type, you can provide a comma separated list of values. If these values are present in a search term, or phrase, then the Card will show in the results.

Provide these keywords in the Command field.


This is one of the more intelligent command types as utterances capture complete sentences a user might type into the search field. You could specify various phrases that will trigger the card to appear in search. For example, (show me|who is) (the) manager of {employee}

For our video card example, we only need to know about the basic pattern matching syntax. We're going to enter the following into the 'Command' field below the dropdown.

    (show me|i want to see) (my|the) video card
    Where is (my) video?
    I'd (like|want|need) to see (my|the) video card

When a word or phrase is in parentheses, it is matched conditionally. For example, in the first line above MARKDOWN_HASH1f8658dce159010fa080ac3abdcfbddbMARKDOWN_HASH_ translates to "Match against 'Show me' OR 'I want to see'"_.

The first pattern we've entered translates into the following english-language phrases:

    show me my video card
    show me the video card
    i want to see my video card
    i want to see the video card


The Schedule field provides settings for when you wish the card to be updated. If the card is on the users dashboard then it will automatically show the latest data. If the card has been dismissed, it will show up on their dashboard again according to the schedule.

Additionally, you can define a web hook. Whenever this webhook is triggered, the card will be refreshed on the users dashboard.

Collection mode

The Collection Mode dropdown lets you choose between aggregated or isolated.

Updates for this card will be aggregated into a list that is then passed to the card.
Each update will trigger a new card to be displayed.

Max. number of items defines the maximum amount of items that will be passed to a card.

Card Store

Under Store Metadata you will find several options relating to how the card is shown and behaves in the card store.

A description of the card that will be shown in the card store.
Logo Url
A link to a logo image that will be shown alongside the card in the card store. It must be relative to the `spaces/Global/Components` folder. For example, `my-first-card/card-logo.png`.
Hide in My Cards
Hides the card so that it will not show up in the card store.
Disable pin to workplace
If enabled, the user will no longer be able to pin this card to their dashboard.

Service Type

Here you can choose from

  • Internal
  • Service Connecters
  • Database Connecters

As we are showing a static video, we want to use "Internal", as in data that belongs to the Card and is not grabbed from an external source.


Here we choose Test Data Response .test.json (proxy)


Here you can select the roles that are allowed to view this card and its content. By default, any authenticated user is able to see it in the Card Store.


Here you can specify groups that will have this card enabled, and viewable on their dashboard, by default.

For our example, we will add "Authenticated", so that all logged in users see our video card.