Segment Integration Reference

This reference outlines the functionality of the Segment Integration that allows you to send data from Segment to your SaaSquatch program. It includes details about the structure of the method, available parameters, limitations, and examples.

🔗 How do I use the Segment integration?

Segment customers can use the Segment analytics.js library instead of directly using the squatch.js SaaSquatch javascript library.

Use the analytics.js identify method instead of squatch.js userUpsert call to identify, attribute, and convert users in your SaaSquatch program.

🔗 What features are supported with Segment?

Most of the features of the SaaSquatch squatch.js library are available through this Segment Integration. However, there will always be some things that will require you to use squatch.js directly.

🔗 Signed Requests

The Segment Integration supports Signed Requests using checksums.

Please be aware of the following differences:

The structure and contents of the checksum being generated is based on that of the equivalent squatch.js call.

• Ordering of parameters when generating the checksum is based upon squatch.js userUpsert parameters names, not the analytics.js parameter names. For example, avatar should still be sorted with "u" for user_image.
• Omit other analytics.js traits from the checksum, such as Google Analytics IDs.

🔗 SaaSquatch REST API

At this time the Segment integration with SaaSquatch is only an abstraction of the squatch.js javascript library.

🔗 Identify Method Reference

The Segment analytics.js library identify method is used to connect with your SaaSquatch.

🔗 Structure

The Segment analytics.identify method is structured differently than the SaaSquatch squatch.js userUpsert call.

Unlike the squatch.js userUpsert call, in the analytics.identify method the userId and the tenantAlias are not listed among the regular parameters.

🔗 Example

The following example highlights the structure of the analytics.identify method with no parameters:

analytics.identify( "userId", {
    /*
    PARAMETERS GO HERE
    */
},{
    integrations: {
        SaaSquatch: {
            checksum: null
        }
    }
});

🔗 Parameters

🔗 Example

Below is a comparison of a squatch.js init call vs the equivalent Segment analytics.js identify call.

squatch.init({
    tenantAlias: 'test_abzxg88g30tn2'
  });

  var initObj = {
user: {                               
  id: 'u1234',                      
  accountId: 'a5678',       
  email: 'joe.tester@example.com',                
  firstName: 'Joe',       
  lastName: 'Tester',
  referralCode: 'JOETESTER',
  paymentProviderId: 'cus_8rVOAthroptvT6',
  locale: 'en_US'
},
engagementMedium: 'EMBED',
widgetType: 'REFERRER_WIDGET'

  };
  squatch.api().upsertUser(initObj).then(function(response) {
    user = response.user;
  }).catch(function(error){
    console.log(error);
  })
});

analytics.identify( "u1234", {
    accountId: "a5678",
    email: "joe.tester@example.com",
    firstName: "Joe",
    lastName: "Tester",
    userReferralCode: "JOETESTER",
    mode: "EMBED",
    locale: "en_US",
    paymentProviderId: 'cus_8rVOAthroptvT6'
},{
    integrations: {
        SaaSquatch: {
            checksum: 'n3VtXg92TVOuzQ+6EMV8FvjY4em5NptCcesDYv+9tegs='
        }
    }
});

🔗 Additional Resources

Segment provides support documents about their integration with SaaSquatch.

You can also check out the full source code for the integration on Segment's Github.

You can also checkout our full Segment Guide.

Details about squatch.js can be found in our squatch.js Quickstart as well as in the squatch.js reference.