Friendbuy Web Mode (Actions) Destination
Destination Info
- Accepts Page, Alias, Group, Identify, and Track calls
- Refer to it as Friendbuy (Actions), or Friendbuy (Web Destinations), or Friendbuy (Web Destination) in the Integrations object
Partner Owned
- This integration is partner owned. Please reach out to the partner's support for any issues.
Friendbuy is a referral marketing platform.
Friendbuy’s web mode Segment integration allows you to enable your Friendbuy referral program through Segment’s dashboard instead of adding Friendbuy’s JavaScript directly to your site.
This Segment integration is a web mode destination action that loads and configures Friendbuy’s JavaScript for you. If you’re already using Segment’s Analytics.js to identify your customers and track their purchases, either directly or through Segment source integrations that you’ve installed, you can configure Segment to send this data to Friendbuy for use in your referral program.
The Friendbuy JavaScript won’t be loaded unless at least one Mapping is enabled. Even if you’re not sending data to Friendbuy through Analytics.js calls, if you’re using Segment to load the Friendbuy JavaScript you must define and enable at least one Mapping. A safe mapping to enable is the pre-built Track Page mapping.
Overview
The Friendbuy web mode destination sends information about your customers and their actions to Friendbuy. It supports the following Friendbuy tracking events.
- Track Customer: Converts Segment
analytics.identify
calls to Friendbuy track customer calls. Use this to add your customer ID and other customer data to the information that Friendbuy has about the customer. - Track Purchase: Converts Segment
analytics.track('Order Completed')
calls to Friendbuy track purchase calls. Use this to send purchase data to Friendbuy and reward advocates based on their friends’ purchases. - Track Sign-Up: Converts Segment
analytics.track('Signed Up')
calls to Friendbuy track sign_up calls. Use this to reward customers for account creation and other sign-up actions. - Track Page: Converts Segment
analytics.page
calls to Friendbuy track page calls. Use this to enable your Friendbuy widgets based on page name. - Track Custom Event: Converts an arbitrary Segment
analytics.track
call with an event name and properties of your choosing to a Friendbuy track custom event call. Use this to reward your customers for actions other than purchases or sign-ups.
Benefits of Friendbuy Web Mode (Actions) vs Friendbuy Classic
Friendbuy Web Mode (Actions) is the Segment web mode destination that works with Friendbuy’s current platform. The classic Segment Friendbuy destination works with Friendbuy’s legacy platform.
Getting started
Please contact your Friendbuy Customer Success Manager or email support@friendbuy.com to set up Friendbuy’s Segment integration.
Before you start, you must have Segment’s Analytics.js 2.0 installed on your site. See Segment’s documentation for instructions.
- Find your Friendbuy Merchant ID, a unique UUID that Friendbuy uses to identify your account. Log in to your Friendbuy account and visit the Developer Center > Friendbuy Code page to locate your Merchant ID.
- From the Segment web app, click Catalog, then click Destinations.
- Filter the destinations on Friendbuy in the Catalog and select Friendbuy Web Device Mode (Actions). Click Configure Friendbuy Web Device Mode (Actions) to configure the Friendbuy destination, and choose which of your sources to connect the destination to.
- Give the destination a name, and fill in the settings manually.
- On the Basic Settings page enter your Merchant ID value from step one, and click Save Changes.
- Select the Mappings tab. A number of pre-built mappings are configured for you that map standard events defined in the Segment Spec to their equivalent Friendbuy events, as displayed below. You can disable events that you don’t use or edit the pre-built field mappings.
- After you configure the destination, enable it from the Settings tab. As noted above, the Friendbuy JavaScript will not be loaded unless at least one Mapping is enabled.
Destination Settings
Setting | Description |
---|---|
Friendbuy Merchant ID | Required. Find your Friendbuy Merchant ID by logging in to your Friendbuy account and going to Developer Center > Friendbuy Code. |
Available Presets
Friendbuy (Web Destination) has the following presets:
Preset Name | Trigger | Default Action |
---|---|---|
Track Page | Event type = "page" |
Track Page |
Track Purchase | Event event = "Order Completed" |
Track Purchase |
Track Sign Up | Event event = "Signed Up" |
Track Sign Up |
Track Customer | Event type = "identify" |
Track Customer |
Available Actions
Build your own Mappings. Combine supported triggers with the following Friendbuy (Web Destination)-supported actions:
Mapping limits per destination
Individual destination instances have support a maximum of 50 mappings.
Track Custom Event
Record when a customer completes any custom event that you define.
Track Custom Event is a Web action.
Field | Description |
---|---|
Event Type* | Type: STRING The type of the event to track. |
Event Properties* | Type: OBJECT Object containing the properties for the event being tracked. All of the fields in this object will be sent in the root of the Friendbuy track event. |
Event ID | Type: STRING An identifier for the event being tracked to prevent the same event from being rewarded more than once. |
Customer ID* | Type: STRING The user’s customer ID. |
Anonymous ID | Type: STRING The user’s anonymous id |
Type: STRING The user’s email address. |
Track Sign Up
Record when a customer signs up for a service.
Track Sign Up is a Web action. The default Trigger is: event = "Signed Up"
Field | Description |
---|---|
Customer ID* | Type: STRING The user’s customer ID. |
Anonymous ID | Type: STRING The user’s anonymous ID. |
Email* | Type: STRING The user’s email address. |
New Customer Flag | Type: BOOLEAN Flag to indicate whether the user is a new customer. |
Loyalty Program Status | Type: STRING The status of the user in your loyalty program. Valid values are “in”, “out”, or “blocked”. |
First Name | Type: STRING The user’s given name. |
Last Name | Type: STRING The user’s surname. |
Name | Type: STRING The user’s full name. |
Age | Type: NUMBER The user’s age. |
Birthday | Type: STRING The user’s birthday in the format “YYYY-MM-DD”, or “0000-MM-DD” to omit the year. |
Coupon Code | Type: STRING Coupon code that customer supplied when they signed up. |
Friendbuy Attribution ID | Type: STRING Friendbuy attribution ID that associates the customer who is signing up with the advocate who referred them. |
Friendbuy Referral ID | Type: STRING Friendbuy referral code that associates the customer who is signing up with the advocate who referred them. |
Custom Attributes | Type: OBJECT Custom attributes to send to Friendbuy. You should pass an object whose keys are the names of the custom attributes and whose values are strings. Non-string-valued attributes will be dropped. |
Track Purchase
Record when a customer makes a purchase.
Track Purchase is a Web action. The default Trigger is: event = "Order Completed"
Field | Description |
---|---|
Order ID* | Type: STRING The order ID. |
Purchase Amount* | Type: NUMBER Purchase amount to be considered when evaluating reward rules. |
Currency* | Type: STRING The currency of the purchase amount. |
Coupon | Type: STRING The coupon code of any coupon redeemed with the order. |
Friendbuy Attribution ID | Type: STRING Friendbuy attribution ID that associates the purchase with the advocate who referred the purchaser. |
Friendbuy Referral ID | Type: STRING Friendbuy referral code that associates the purchase with the advocate who referred the purchaser. |
Gift Card Codes | Type: STRING An array of gift card codes applied to the order. |
Products | Type: OBJECT Products purchased. |
Customer ID | Type: STRING The user’s customer ID. |
Anonymous ID | Type: STRING The user’s anonymous ID. |
Type: STRING The user’s email address. |
|
New Customer Flag | Type: BOOLEAN Flag to indicate whether the user is a new customer. |
Loyalty Program Status | Type: STRING The status of the user in your loyalty program. Valid values are “in”, “out”, or “blocked”. |
First Name | Type: STRING The user’s given name. |
Last Name | Type: STRING The user’s surname. |
Name | Type: STRING The user’s full name. |
Age | Type: NUMBER The user’s age. |
Birthday | Type: STRING The user’s birthday in the format “YYYY-MM-DD”, or “0000-MM-DD” to omit the year. |
Custom Attributes | Type: OBJECT Custom attributes to send to Friendbuy. You should pass an object whose keys are the names of the custom attributes and whose values are strings. Non-string-valued attributes will be dropped. |
Track Customer
Create a new customer profile or update an existing customer profile.
Track Customer is a Web action. The default Trigger is: type = "identify"
Field | Description |
---|---|
Customer ID* | Type: STRING The user’s customer ID. |
Anonymous ID | Type: STRING The user’s anonymous id. |
Email* | Type: STRING The user’s email address. |
First Name | Type: STRING The user’s given name. |
Last Name | Type: STRING The user’s surname. |
Name | Type: STRING The user’s full name. If the name trait doesn’t exist then it will be automatically derived from the firstName and lastName traits if they are defined. |
Age | Type: NUMBER The user’s age. |
Birthday | Type: STRING The user’s birthday in the format “YYYY-MM-DD”, or “0000-MM-DD” to omit the year. |
Language | Type: STRING The user’s language. |
Country | Type: STRING The user’s country. |
State | Type: STRING The user’s state. |
City | Type: STRING The user’s city. |
State | Type: STRING The user’s postal code. |
Customer Since | Type: STRING The date the user became a customer. |
Loyalty Status | Type: STRING The status of the user in your loyalty program. Valid values are “in”, “out”, or “blocked”. |
New Customer Flag | Type: BOOLEAN Flag to indicate whether the user is a new customer. |
Custom Attributes | Type: OBJECT Custom attributes to send to Friendbuy. You should pass an object whose keys are the names of the custom attributes and whose values are strings. Non-string-valued attributes will be dropped. |
Track Page
Record when a customer visits a new page. Allow Friendbuy widget targeting by Page Name instead of URL.
Track Page is a Web action. The default Trigger is: type = "page"
Field | Description |
---|---|
Page Name | Type: STRING The page name. |
Page Category | Type: STRING The page category. |
Page Title | Type: STRING The page title. |
Edit Friendbuy mappings
There are four steps to configure a Segment mapping.
- Set up event trigger: Choose the event trigger, which is the event type (such as Identify) or event name (such as Order Completed) for events that should be sent to Friendbuy.
- Test event trigger: Find a sample event in your Segment event stream that matches the trigger you defined in step one.
- Configure action fields: Define how the fields in the Segment event are mapped to fields in the Friendbuy track event.
- Review mappings: Verify that the fields in the sample event are mapped correctly.
Configuring action fields
In the configure action fields step, the mapping is pre-populated with mappings from the standard Segment event properties to the corresponding Friendbuy fields. You can edit each field if you want to populate that field from a different Segment event property or not send the field at all.
Note that the default mappings for the Purchase, Sign Up, and custom events populate Friendbuy’s Customer ID field from the User ID passed in the analytics.identify
call. Unless you change the Customer ID field mapping when you configure the action, you must make an analytics.identify
call before you make the analytics.track
call for Purchase, Sign Up, or custom events if you want to associate a Customer ID with those events.
Custom attributes
In the Track Customer, Track Purchase, or Track Sign Up mappings you can use the Custom Attributes field to send additional custom properties that aren’t included in the predefined field names for that event. Use the mapping’s Custom Attributes field to specify the path to a JSON object that contains those custom attributes. Then, when your code makes its Segment Analytics.js call, include an object at the path that you configured containing your custom attributes to include them at the root of the Friendbuy track event.
For example, if your Track Purchase call has the default Custom Attributes value of properties.friendbuyAttributes
, and if your track purchase call is:
analytics.track("Order Completed", {
order_id: "82f250a3-32eb-40be-95fc-77e685ed8448",
total: 54.82,
currency: "USD",
friendbuyAttributes: {
orderNumber: "3",
promotion: "black friday"
}
});
then the Friendbuy track purchase call will be:
friendbuyAPI.push(["track", "purchase", {
id: "82f250a3-32eb-40be-95fc-77e685ed8448",
amount: 54.82,
currency: "USD",
orderNumber: "3",
promotion: "black friday"
}, true]);
Note that a Friendbuy track call is limited to a maximum of 10 custom attributes, custom attribute values must be strings, and the maximum length of a custom attribute is 128 characters. Custom attributes that do not comply with these restrictions are dropped.
Custom events
To allow Friendbuy to act on an event that isn’t one of the standard events described in the Overview, use a custom event.
To configure a custom event:
-
Click New Mapping and choose Track Custom Event.
-
For the Event Name, choose the name of the Segment event you are tracking. For example, if you want to reward on app downloads that you are tracking with
analytics.track("Downloaded", { downloadId: "My App" }
, selectDownloaded
as your Event Name. -
When you configure your action fields, you can accept the default Event Type of
event
which will cause Friendbuy to receive track events with the same names as the Segment events. If you want to rename the Friendbuy events, you can replace the Event Type with a different value, such as the static stringdownload
. -
Event Properties is set from the path
properties
by default, which means that all the properties that you include in your Segmentanalytics.track
call are passed to Friendbuy. If you only want to pass custom attributes to Friendbuy, you need to segregate the fields to pass to Friendbuy into an object and then specify the path to that object, similar to what is described above in Custom Attributes. -
To prevent an event that is tracked multiple times from being rewarded more than once, you should include a deduplication ID in your event as described in Friendbuy’s Track Custom Event documentation. You can either pass an explicit Event ID field in your event (defaulting to the
deduplicationId
property) or you can create the Event ID out of other event properties (such as theuserId
, a.
, and theproperties.downloadId
in the above example).
This page was last modified: 08 Mar 2022
Need support?
Questions? Problems? Need more info? Contact Segment Support for assistance!