IBM Cloud Docs
Sending events to Segment

Sending events to Segment Enterprise plan only

IBM Cloud

You can use the Segment extension to send watsonx Assistant events to Segment.

Overview

With this extension, you can use Segment to capture and centralize data about your customers' behavior, including their interactions with your assistant. Events are sent from watsonx Assistant to Segment, making them available to destinations such as data warehouses, raw data tools, and analytic tools.

For more information about the events that are sent to Segment, see Segment event reference.

Adding the extension to the draft environment

To add the Segment extension to your assistant, follow these steps:

  1. On the Integrations icon Integrations page, scroll to the Extensions section and find the tile for the Segment extension.

  2. Click Add. Review the overview of the extension and click Add to configure it for your assistant.

    When you first add the Segment extension to an assistant, the configuration settings you provide are applied only to the draft environment. You must complete configuration for the draft environment before you can add the extension in the live environment.

  3. In the Connect step, click the link to log in to your Segment account in another browser tab.

    If you do not already have a Segment account, click Sign up for free account to create one. Verify your email address and complete your profile to activate your account.

  4. In the Segment web app, go to your workspace. In the Sources section, find the Add IBM watsonx Assistant Source tile and click Add Source.

  5. In the Source Name field, type a descriptive name for your watsonx Assistant instance (for example, Customer Care Assistant). Click Create Source.

  6. Click Copy to copy the generated key to the clipboard.

  7. Go back to the Segment integration settings in the watsonx Assistant interface. In the Segment key field, paste the key you copied from the Segment web app in the previous step. Click Next.

  8. In the Select events step, review the list of events watsonx Assistant can send to Segment.

    Each row in the table shows the name of a supported event, along with a brief description.

  9. Click the checkboxes to select the events you want to send to Segment. Click Next.

  10. In the Review & Confirm step, review the configuration and click Finish.

The Segment extension is now connected to your assistant in the draft environment. Click Close to close the integration settings.

Configuring the extension for the live environment

To configure the Segment extension for the live environment, follow these steps:

  1. On the Integrations icon Integrations page, scroll to the Extensions section and find the tile for the Segment extension.

  2. Click Open. The Open extension window opens.

  3. In the Environment field, select Live. Click Confirm.

  4. Repeat the configuration process, specifying the values you want to use for the live environment.

    If you are using multiple environments, follow the same steps to configure the extension for each environment. For more information, see Adding and using multiple environments.

The Segment extension is now available in the environments you have configured, and events will be sent to the destinations configured in your Segment workspace. (For more information about the events that are sent to Segment, see Segment event reference.)