Segment Stream

Send your user insights to any Segment-connected app.

Goal

Export data from Sprig to Segment whenever a study response is collected. The data can then be exported to Segment's hundreds of Destination integrations.

Supported Capabilities

  • Send study responses collected in Sprig to Segment

Installing Segment Stream

  1. Sprig currently does not appear as a Source in Segment, but you can set a HTTP endpoint as a source in Segment’s workspace to receive Sprig’s data as a stream. From the Segment app Sources page, click on Add Source.
  2. Search for HTTP API in the Sources Catalog and click Add Source.
  1. You’ll be prompted to give the source a name. We recommend using any internal naming conventions. Please note, if you plan on adding more than one source (production and development environments) then we recommend you name them as such.
  2. For the source you just added, find and copy its Write Key in the source Overview tab.
  1. Open the Sprig Dashboard and make sure you're viewing the desired Product and Environment (Development or Production). On Sprig Dashboard > Connect > Segment Stream, add your copied Write Key by clicking Add Key, pasting in the key, and clicking Save. Sprig will now forward study results to Segment.
  1. In the Segment app Overview tab for the source, for each destination where you'd like to send study response data, click Add Destination and follow the configuration flow.

Troubleshooting installation

The Segment Write Key is unique to each source connected in Segment, so please check to make sure you add the right one, and that the environment in the Sprig Connect page in which the Write Key is set matches the Segment Source for that Write Key. For example, a source for your app's Production environment should be added in Sprig's Connect page viewed in Production.

A User ID is required to receive Sprig data in Segment. Sprig cannot send a response to Segment if the study taker is anonymous: if the visitor does not have a User ID.

Integration data fields

This table describes the data that will be sent from Sprig's Segment Stream to your destination integrations.

Name

Description

userId (required)

Also known as externalUserId, userId is required by the Segment Stream. This value should be consistent across all data flowing through Segment (more details)

event

Name of the action that a user has performed. We will use SDK - Submitted - Survey Response as a default value

properties.surveyName

Name of the survey

properties.surveyId

Uuid of the survey

properties.createdAt

Timestamp when the survey was created (ISO-8061 format)

properties.question

Question text

properties.questionType

Question type

properties.visitorId

Uuid of the visitor who submitted the response

properties.oldVisitorId

[deprecated] Legacy identifier of a visitor. Different from visitorId (uuid), oldVisitorId is a number

properties.responseGroupId

A response group is a set of responses for a visitor for a given survey

properties.response

The survey response to the question

properties.email

Visitor's email

properties.attributes

Other attributes of the visitor, like plan, company, role etc.

properties.triggeringEvent

The label of the event that triggered this survey. Can be NULL

context

Dictionary of extra information that provides useful context about a message. Each call is required to contain a context.integration object in the call body that identifies where the call is coming from

sentAt

Timestamp of when a message is sent to Segment

receivedAt

Automatically set by Segment, the timestamp of when a message is received by Segment

timestamp

Timestamp when the message itself took place, defaulted to the current time by the Segment Tracking API, as a ISO-8601 format date string

type

Type of message, corresponding to the Segment API method: identify, group, track, page, screen, or alias. Sprig will call Segment’s track API to publish the events to destinations, so the type will be track