Connectors / Service / Segment

Segment

Segment

Segment is an analytics API and customer data platform that allows you to easily move data between different sources and destinations.

Overview

API INFO: The Base URL used for the Segment connector is https://api.segment.io/v1/. More information can be found on their main API documentation (v1.0) site. This is where users will also be able to find the API Limitations page.

Authentication

Within the workflow builder, highlight the Segment connector.

In the Segment connector properties panel to the right of the builder, click on the Authenticate tab and the 'Add new authentication' button.

This will result in a Tray.io authentication pop-up modal. The first page will ask you to name your authentication and select the type of authentication you wish to create ('Personal' or 'Organisational').

The next page asks you for your 'Write Key' and 'Personas Key' credentials.

In order to get the Segment Key, head to the Segment dashboard. Select the 'Sources' tab from the left panel and then select the source of your choice.

Click the collapsable arrow beside 'How to add Segment to your HTTP API codebase'.

Copy and paste the 'Write Key' on the Tray authentication modal.

You can always exclude adding the Personas Key as it is optional.

If you wish to add the key then you can refer to the Personas Profile API documentation.

Once you have added these fields to your Tray.io authentication pop-up window, click the 'Create authentication' button.

Go back to your settings authentication field (within the workflow builder properties panel), and select the recently added authentication from the dropdown options now available.

Your connector authentication setup should now be complete.

Trigger Setup

If you wish your workflow to be kicked off by a particular action in Segment, you can use the Segment Trigger.

The Segment trigger allows you to receive notifications and trigger workflows when given events occur associated with the selected trigger operation.

Before you set up your segment trigger, you need to configure the Tray.io destination on Segment.com. To know how to add Tray.io as a Destination in Segment refer to the Destination section below.

Assuming that you have configured and enabled your Tray.io destination in Segment let's set up the Segment trigger on the Tray.io platform.

To do so, select the Segment trigger from the trigger options available.

There are various operations that the Segment trigger facilitates, and you can choose any based on your needs. Here, we are selecting the 'On all messages' operation. This will fire the trigger on any type of event that occurs on your Source (Webiste).

You can also filter the message type when you configure the trigger within Tray by specifying them in the 'Allowed events' section.

You can also select the type of 'Channel' you wish the trigger to monitor and receive the data from. You can do this by selecting the available options from the drop-down.

Notes on using Segment

Source

In Segment, a Source is a website or an app you wish to track.

If you wish to track the activities on your website and then manage those activities using the Tray platform, you need to add your website as a Source in Segment. To learn about how to add and manage a Source please refer to the Segment documentation on Sources.

Once you have added a Source in your Segment dahboard, it should appear on the Connections overview page under 'Sources'.

You can create a Source for each unique source of data.

Once you have created the Source you can now add the Source ID in your Segment connector authentication on the Tray platform to manage the data received from the specific Source.

To learn how to do that, refer to the Authentication section above.

Destination

A Destination in Segment is what receives data from the Source.

To track the activities on your website and then manage those activities using the Tray platform, you need to add Tray as a Destination in Segment.

To do so in your Segment Dashboard, select 'Connections' from the left panel and click the button 'Add Destination'.

Once done, you can search for Tray using the Filter on the 'Catalog' page and then select 'tray.io'.

You will then see a page with Tray.io and Segment integration information, feel free to read this in detail. On the same page, click the 'Configure tray.io' button for further configurations, and then select the Source of your choice and click 'Next'.

On the 'Connect Connector token to tray.io' page provide a suitable 'Destination Name'. For the field 'How would you like to set up this destination?', select the 'Fill in settings manually' option from the drop-down and click 'Save'.

You will be directed to the Tray settings page, which means your Destination is now created. The last steps are to add your Tray workflow URL and then enable the configured destination.

To get the URL for your Tray workflow, open the workflow where you wish to send the source data to. Select the horizontal hamburger icon on the top left corner of the Tray platform.

Navigate to 'Workflow settings' > 'General settings'. From here, copy the 'Workflow public URL'.

Now, to paste this URL, from the 'Tray Settings' page in your Segment dashboard select the tab under 'Connection Settings'. Paste the URL in the 'Workflow Urls' field and click 'Save'.

You can add multiple workflows as your destination by clicking the 'Add row' button.

To enable the newly added Destination, select the 'Destinations' tab from the left navigation panel. It will display the list of all the Destinations. Select your Destination.

On the next page enable the selected Destination using the toggle button.

Now, you have successfully added, configured, and enabled Tray as your destination.

The next step is to build a Segment trigger that would listen for the activities and fetch the data from your Source to the configured Tray workflow destination.

To learn how to configure the Segment trigger, refer to the Trigger Setup section above.

Operations handled by Segment connector

The Segment connector operations can be segregated into two sections:

Segment operations:

  • Alias identities (Alias)
  • Batch
  • Group user (Group)
  • Identify user (Identify)
  • Track event (Track)
  • Track page (Page)

To know more about these Segment operations refer to Segment's Spec Overview documentation.

Segment Personas specific operations:

  • Get Profile Events
  • Get Profile External ID’s
  • Get Profile Properties
  • Get Profile Traits
PLEASE NOTE: If you wish to use the Personas-specific operations, you should provide the Personas Key in the connector authentication.

To know more about Segment's Personas-specific operations refer to Segment's Personas Profile API documentation.

All Operations

Latest version:

1.4