Skip to contentSkip to navigationSkip to topbar
On this page
Looking for more inspiration?Visit the
(information)
You're in the right place! Segment documentation is now part of Twilio Docs. The content you are used to is still here—just in a new home with a refreshed look.

White Label Loyalty Source


Source Info
  • The White Label Loyalty Source is an Event Cloud source. This means that it sends data as events, which are behaviors or occurrences tied to a user and a point in time. Data from these sources can be loaded into your Segment warehouses, and also sent to Segment streaming destinations. Learn more about cloud sources.
  • This source is in Beta
  • This integration is partner owned. Please reach out to the partner's support for any issues.

White Label Loyalty(link takes you to an external page) is an event-powered loyalty solution to drive customer retention.

This is an Event Cloud Source that can not only export data into your Segment warehouse but also federate the exported data into your other Segment-enabled destinations.

White Label Loyalty maintains this source. For any issues with the source, contact their support team.


Getting started

getting-started page anchor
  1. From your workspace's Sources catalog page(link takes you to an external page), click Add Source.

  2. Search for "White Label Loyalty" in the Sources Catalog, select White Label Loyalty, and click Add Source.

  3. On the next screen, give the source a name and configure any other settings.

    • The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name can be anything, but Segment recommend using something that reflects the source itself and distinguishes amongst your environments (for example, WhiteLabel_Prod, WhiteLabel_Staging, WhiteLabel_Dev).
  4. Click Add Source to save your settings.

  5. Copy the write key from the Segment UI.

  6. In the White Label Loyalty Console, navigate to Settings > Integrations > Extensions and click Create. Alternatively, you can edit an existing Segment integration.

  7. Paste the write key in when prompted.

  8. (Optional:) Specify a JSON path to use for the users ID (defaults to authIdentifier).

  9. Click Save.


White Label Loyalty uses Segment's stream source component to send Segment event data. The source uses server-side Track and Identify methods to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL.

By default, White Label Loyalty passes the authIdentifier associated with the user as the userId. You can specify a custom JSONPath in the White Label Loyalty Console to change the source of the userId.


White Label Loyalty will send all custom and intrinsic event types created in the White Label Loyalty Console, as per the schema provided when you set it up. White Label Loyalty will send all events reported against a user and include the userId.


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

Log in to your downstream tools and verify that your events appear as expected, and that they contain all of the properties you expect. If your events and properties don't appear, check the Event Delivery tool, and refer to the destination docs for each tool for troubleshooting.

If you experience any issues with how events are arriving to Segment, contact the White Label Loyalty support team.