Skip to main content

Segment integration

CommandBar has a no-code integration with Segment, that allows you to configure CommandBar as both a Segment source and destination.

  • Source integration: lets CommandBar send event data directly to Segment, which allows you to easily route it to any other tool you have connected to Segment
  • Destination integration: lets CommandBar ingest any Segment user attributes and user events, which can then be used for targeting. User attributes are used in Who targeting, while user events are used in When targeting.

How to set up the Segment source integration​

  1. From your workspace’s Sources catalog page search for “CommandBar” and click Add Source. Segment add source
  2. On the next screen, give the Source a nickname configure any other settings. The nickname will be used to designate the source in the Segment interface, and Segment will create a related schema name. The schema name is the namespace you’ll be querying against in your warehouse.
  3. Copy the Write Key from the Segment UI. If you are not sure where to find your write key, visit Segment’s help document.
  4. Log in to your CommandBar account, and navigate to the Segment integration page. Segment integration card
  5. Paste your Segment Write Key into the text box.
    Segment write key input
  6. Click “Connect”.
  7. [Optional] Send a test event from the CommandBar Segment integration page, and check your Segment Source Debugger to ensure the integration is properly configured.
tip

For more details, please refer to Segment’s documentation on setting up a CommandBar source.

Testing the source integration​

To confirm the integration is working, we recommend sending a test event via the integration page within CommandBar here. Click the button "Send test event", and check the Source Debugger within Segment for the test event. If you see it, you are all set!

Segment integration card

What events are sent to Segment?​

The events sent to Segment are the same as those captured by addEventSubscriber, which can be found here.

Adding Destinations​

Now that your Source is set up, you can connect it with Destinations.

Log into your downstream tools and check to see that your events are populating and they contains all the properties you expect. If all your events and properties are not showing up, refer to the Destination docs for troubleshooting.

How to set up the Segment destination integration​

Segment integration card

  1. From the Segment web app, navigate to Connections > Catalog, then select the Destinations tab at the top of the catalog.
  2. Search for CommandBar and select it.
  3. Click Configure CommandBar.
  4. Sign in to CommandBar, 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 through Segment, check Deploy via Segment. Please note that we recommend installing CommandBar directly rather than through Segment where possible.
  6. Select an existing Source to connect to CommandBar.
tip

For more details, please refer to Segment’s documentation on setting up a CommandBar destination.

Using the destination integration​

Once installed, the destination integrations allows you to use two CommandBar-supported Segment actions: