How to create commands in Dashboard?
Last updated
Last updated
To start creating commands, access the beacon in the sidebar or use the shortcut "Command + K" (for Mac) or "CTRL + K" (for Windows) to open the beacon bar. From there, search for commands, and upon hitting enter, you'll be directed straight to the commands page.
Initiate the creation of a new category that will be utilized to organize commands based on different categories.
Next, select the "Create Command" button and input details such as the command name, which will be utilized for searching in the command bar. Provide a description, assign a category, and choose the action type based on your specific requirements.
Video Action type : This action type allows you the flexibility to include an external link, enabling you to share any video link of your choice.
Link Action type : Within this link action type, you can choose from various options such as a static path, dynamic path, or external link, giving you the freedom to select the one that best suits your needs.
Click Action type : The click action type is employed to interact with a specific element. In cases where identical paths exist across multiple pages, this command can be applied by including elements' classname and xpath. If the classname undergoes dynamic changes, you have the option to incorporate an id, or alternatively, you can include the data-beacon-id attribute for the element.
Callback Action type : This is utilized when you wish to invoke a function upon clicking the command. Additionally, you have the option to input both success and failure text. Furthermore, you can activate confetti upon successful execution.
Web Request Action type : Using this action type, you can initiate web requests for methods such as get, post, patch, delete, or put, specifying the endpoint. Optionally, you can input callback keys for success or failure, along with success and failure text. Additionally, you have the capability to trigger confetti on success and perform server-side requests by enabling the toggle switch.
Embed Action type : To launch an embedded form, opt for this action type and input the external link.
Support Action type : Activate this action type by establishing connections with Zendesk or Slice in integrations page. Choose the support integration and enable the necessary fields to receive support tickets as per your requirements.
If you wish to click on a specific element, choose "Click" as the action type. Fill in the element details based on the selector type and input the path where the element is located. Utilize the "Add Sub-Action" button to include multiple actions if needed.
Within the "Other Details" section, input keywords that users can utilize to search for the command, including alternate words. Enable GR, CR, or CO as per your specific requirements.
Global Recommendation (GR) : It can be enabled for only 8 commands. These 8 recommended commands will appear at the top of the list of commands in the bar, before a user searches.
Context Recommendation (CR) : It can be enabled for 8 commands in every context. These 8 recommended commands will appear at the top of the list of commands in the bar, before a user searches when invoked in that context/section of the app.
Context Only (CO) : Enabling context only restricts the availability of the command to just the context it is created in. This does not assign any higher priority to the command. It only restricts the command availability.
Use the view list link to see the GR, CR or CO enabled commands.
Within the advanced configuration, choose a segment that will be employed to limit the command view based on predefined rules.
To restrict the command view, you can also utilize metadata key-value pairs by clicking on the "Add" button.
To initiate the creation of segments, navigate to the segment page or search for "Create Segment" in the command bar. You have the option to create multiple segments.
Once you have added all the essential details, click on the "Save" button.
Refer to the provided screenshot where you can observe a list of commands on the view. On the left side, commands are categorized. You can search for any specific command using the search field. Additionally, you have the option to filter commands using the filter icon.