Skip to content

commandbar destination doc #3827

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

commandbar destination doc #3827

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions src/connections/destinations/catalog/commandbar/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
# The end name should be similar to `Slack Destination`
title: CommandBar Destination
hide-boilerplate: true
hide-dossier: true
---

<!-- This template is meant for Actions-based destinations that do not have an existing Classic or non-Actions-based version. For Actions Destinations that are a new version of a classic destination, see the doc-template-update.md template. -->

{% include content/plan-grid.md name="actions" %}

<!-- Include a brief description of the destination here, along with a link to your website. -->

[CommandBar](https://www.commandbar.com) gives your users a searchable index of your app's features and content, as well as customizable in-app components, like onboarding nudges. Better understand user intent and deliver step-change improvements in UX, for new and power users alike. By connecting Segment to CommandBar as a destination, you can trigger nudges and customize CommandBar functionality based on user events and user attributes. The integration also allows you to deploy CommandBar to your users.

To configure CommandBar as an Event Source to get data into your warehouse or other downstream tools, see the [CommandBar Source](/docs/connections/sources/catalog/cloud-apps/commandbar/) documentation.

<!-- This include describes the requirement of A.js 2.0 or higher for Actions compatibility, and is required if your destination has a web component. -->

{% include content/ajs-upgrade.md %}

<!-- The section below explains how to enable and configure the destination. Include any configuration steps not captured below. For example, obtaining an API key from your platform and any configuration steps required to connect to the destination. -->

## Getting started

1. From the Segment web app, click **Catalog**, then click **Destinations**.
2. Find the Destinations Actions item in the left navigation, and click it.
3. Click **Configure CommandBar**.
4. Sign in to [CommandBar](app.commandbar.com/login), click on your organization name in the top right, and copy the `Org ID` into "Organization ID" field.
5. If you want to deploy CommandBar to your users via Segment, check "Deploy via Segment".
6. Select an existing Source to connect to CommandBar.
7. Once connected, we recommend removing the CommandBar snippet or `init` call from your code (if you have one).

<!-- The line below renders a table of connection settings (if applicable), Pre-built Mappings, and available actions. -->

{% include components/actions-fields.html %}

<!--
Additional Context

Include additional information that you think will be useful to the user here. For information that is specific to an individual mapping, please add that as a comment so that the Segment docs team can include it in the auto-generated content for that mapping.
-->