diff --git a/scripts/catalog_papi.js b/scripts/catalog_papi.js index dcf0fab524..614e7d5b19 100644 --- a/scripts/catalog_papi.js +++ b/scripts/catalog_papi.js @@ -330,7 +330,7 @@ const updateDestinations = async () => { let regional = ['us-west'] // We need to be able to keep the system slug in some cases. - const slugOverrides = ['actions-google-enhanced-conversions', 'actions-google-analytics-4', 'actions-facebook-conversions-api', 'actions-friendbuy-cloud'] + const slugOverrides = ['actions-google-enhanced-conversions', 'actions-google-analytics-4', 'actions-facebook-conversions-api', 'actions-friendbuy-cloud', 'sprig-web'] let slug = slugify(destination.name) if (slugOverrides.includes(destination.slug)) { slug = destination.slug diff --git a/src/_data/catalog/destination_categories.yml b/src/_data/catalog/destination_categories.yml index 9e4cd0db04..7e793646c5 100644 --- a/src/_data/catalog/destination_categories.yml +++ b/src/_data/catalog/destination_categories.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT -# destination categories last updated 2022-02-01 +# destination categories last updated 2022-02-07 items: - display_name: A/B Testing slug: a-b-testing diff --git a/src/_data/catalog/destinations.yml b/src/_data/catalog/destinations.yml index 9df51bda42..f12972ab2c 100644 --- a/src/_data/catalog/destinations.yml +++ b/src/_data/catalog/destinations.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT -# destination data last updated 2022-02-01 +# destination data last updated 2022-02-07 items: - destination_id: 60b5d0a01f3726b85dc05aab display_name: 2mee @@ -13975,98 +13975,24 @@ items: label: Freshsales subdomain actions: [] presets: [] -- destination_id: 59ce9468cf711e00014a9c12 - display_name: Friendbuy - name: Friendbuy - slug: friendbuy - hidden: false - regional: - - us-west - url: connections/destinations/catalog/friendbuy - previous_names: - - FriendBuy - - Friendbuy - website: http://www.friendbuy.com - status: PUBLIC - categories: - - Referrals - logo: - url: https://cdn.filepicker.io/api/file/ZkStZnT0qg7CyY2wiVgi - mark: - url: https://cdn.filepicker.io/api/file/rRjOUuTtRePNf1AAgnkA - methods: - track: true - identify: true - group: false - alias: false - page: true - platforms: - browser: true - mobile: false - server: false - components: - - code: https://github.com/segment-integrations/analytics.js-integration-friendbuy - type: BROWSER - browserUnbundlingSupported: false - browserUnbundlingPublic: true - replay: false - connection_modes: - device: - web: true - mobile: false - server: false - cloud: - web: false - mobile: false - server: false - settings: - - name: siteId - type: string - defaultValue: '' - description: >- - This is your **Site ID**. It is used to identify your account in our - platform so we can properly attribute referral data. You can find your - Site ID in the in Friendbuy web application at **Settings > Integration - Code** - required: true - label: Site ID - - name: siteWideWidgets - type: mixed - defaultValue: [] - description: >- - By default, Friendbuy recommends you add a site wide overlay widget. You - can enter any of these site wide widgets here and we will load them any - time we receive a `.page()` call. *Note*: If you have custom widgets - mapped to named pages in the *Widgets* setting and you have provided a - site wide widget, we will load both. - required: false - label: Site Wide Widgets - - name: widgets - type: mixed - defaultValue: [] - description: Map your page calls to specific FriendBuy Widgets. - required: false - label: Page Widgets - actions: [] - presets: [] -- destination_id: 6170a348128093cd0245e0ea - display_name: Friendbuy (Actions) - name: Friendbuy (Actions) - slug: actions-friendbuy +- destination_id: 61dde0dc77eb0db0392649d3 + display_name: Friendbuy (Cloud Destination) + name: Friendbuy (Cloud Destination) + slug: actions-friendbuy-cloud hidden: false regional: - us-west - url: connections/destinations/catalog/actions-friendbuy + url: connections/destinations/catalog/actions-friendbuy-cloud previous_names: - - Friendbuy (Actions) - website: http://www.friendbuy.com + - Friendbuy (Cloud Destination) + website: http://www.segment.com status: PUBLIC categories: - Referrals logo: - url: https://cdn.filepicker.io/api/file/0OV3XmHVQi3n8PrFREPQ + url: https://cdn.filepicker.io/api/file/Lv1D71xoTOH6BxY6wcd4 mark: - url: https://cdn.filepicker.io/api/file/3BbFIi2bSsi08ig1RYgQ + url: https://cdn.filepicker.io/api/file/vVMZxAaTomw7iyVlgSo9 methods: track: true identify: true @@ -14076,7 +14002,7 @@ items: platforms: browser: true mobile: false - server: false + server: true components: [] browserUnbundlingSupported: false browserUnbundlingPublic: false @@ -14091,77 +14017,30 @@ items: mobile: false server: false settings: - - name: merchantId + - name: authKey type: string defaultValue: '' description: >- - Find your Friendbuy Merchant ID by logging in to your [Friendbuy - account](https://retailer.friendbuy.io/) and going to Developer Center > - Friendbuy Code. + Contact your Friendbuy account manager to generate your Friendbuy MAPI key + and secret. required: true - label: Friendbuy Merchant ID + label: Friendbuy MAPI Key + - name: authSecret + type: string + defaultValue: '' + description: See Friendbuy MAPI Key. + required: true + label: Friendbuy MAPI Secret actions: - - id: fk2xKEXiXd9qEkQb24nzXh - name: Track Page - slug: trackPage - description: >- - Record when a customer visits a new page. Allow Friendbuy widget targeting - by Page Name instead of URL. - platform: WEB - hidden: false - defaultTrigger: type = "page" - fields: - - id: e49CUAczWNodafjNEkGVLa - sortOrder: 0 - fieldKey: name - label: Page Name - type: STRING - description: The page name. - placeholder: '' - defaultValue: - '@path': $.name - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: neQAzqaMjCLWQ1QAt82tDb - sortOrder: 1 - fieldKey: category - label: Page Category - type: STRING - description: The page category. - placeholder: '' - defaultValue: - '@path': $.category - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: 49oECrHAo9dQiUp2cMY5cw - sortOrder: 2 - fieldKey: title - label: Page Title - type: STRING - description: The page title. - placeholder: '' - defaultValue: - '@path': $.properties.title - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: jK3iMvwwXbgAz1EBm9Akq6 + - id: jGiVy4jyhXLyWfCbu4t9Rg name: Track Custom Event slug: trackCustomEvent description: Record when a customer completes any custom event that you define. - platform: WEB + platform: CLOUD hidden: false defaultTrigger: null fields: - - id: shTHGLkieU1eHuJcSdeLRB + - id: oowkcUpVHmzkBJrJFjy7Gx sortOrder: 0 fieldKey: eventType label: Event Type @@ -14175,7 +14054,7 @@ items: choices: null dynamic: false allowNull: false - - id: 98zxb1CV5o2ke9JngvWEqY + - id: 5fE31vDVwcyJ7STwddGtoc sortOrder: 1 fieldKey: eventProperties label: Event Properties @@ -14192,7 +14071,7 @@ items: choices: null dynamic: false allowNull: false - - id: 43bqAQttGP3YDk6Apnn2Ht + - id: vc2q1ZTU9LURMdNS5oZ5jj sortOrder: 2 fieldKey: deduplicationId label: Event ID @@ -14208,7 +14087,7 @@ items: choices: null dynamic: false allowNull: false - - id: bh1Tzs9mGXTvuDGNC6hYHB + - id: 6KyKwR3v5R1stV8Ai1yWyL sortOrder: 3 fieldKey: customerId label: Customer ID @@ -14228,7 +14107,7 @@ items: choices: null dynamic: false allowNull: false - - id: nk3aufvDqae12iG2gwC6VP + - id: nTza4zUtt7J9inTLaCGBHn sortOrder: 4 fieldKey: anonymousId label: Anonymous ID @@ -14242,7 +14121,7 @@ items: choices: null dynamic: false allowNull: false - - id: vmZWyCzHXzKA4jxaHU5hwr + - id: dnm8AgTE6jcgvXTJuVm5v2 sortOrder: 5 fieldKey: email label: Email @@ -14251,20 +14130,76 @@ items: placeholder: '' defaultValue: '@path': $.properties.email + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 8E22wrRB5nm2Bh5rVaqVvv + sortOrder: 6 + fieldKey: pageUrl + label: Page URL + type: STRING + description: The URL of the web page the event was generated on. + placeholder: '' + defaultValue: + '@path': $.context.page.url required: false multiple: false choices: null dynamic: false allowNull: false - - id: otSYqZFafJi5aae1yTwynq + - id: JU9ksPnAeWWotgb7TtCWY + sortOrder: 7 + fieldKey: pageTitle + label: Page Title + type: STRING + description: The title of the web page the event was generated on. + placeholder: '' + defaultValue: + '@path': $.context.page.title + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: wZNieDhsTwfjgsTYYuMJhj + sortOrder: 8 + fieldKey: userAgent + label: User Agent + type: STRING + description: The browser's User-Agent string. + placeholder: '' + defaultValue: + '@path': $.context.userAgent + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: g21v8UnT2NgMTqtXy6txS8 + sortOrder: 9 + fieldKey: ipAddress + label: IP Address + type: STRING + description: The users's IP address. + placeholder: '' + defaultValue: + '@path': $.context.ip + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: mgg3vBV3yyXq7GxGdWpsPS name: Track Sign Up slug: trackSignUp description: Record when a customer signs up for a service. - platform: WEB + platform: CLOUD hidden: false - defaultTrigger: event = "Signed Up" + defaultTrigger: null fields: - - id: 2gjjqzPLDWN9KLXbM3vu9F + - id: mVpzx1Nx2sFdX725PMNfwc sortOrder: 0 fieldKey: customerId label: Customer ID @@ -14284,7 +14219,7 @@ items: choices: null dynamic: false allowNull: false - - id: di1f8nNefQ7nVLdzBPfqAQ + - id: iDeMAoiX8dBqvZfVCtRpGu sortOrder: 1 fieldKey: anonymousId label: Anonymous ID @@ -14298,7 +14233,7 @@ items: choices: null dynamic: false allowNull: false - - id: 6MU84EwciUiTufPf97csEs + - id: bb81Q5qU2wDxDHJNCftRHt sortOrder: 2 fieldKey: email label: Email @@ -14312,7 +14247,7 @@ items: choices: null dynamic: false allowNull: false - - id: 64C5Xdb6PxU4D9pEav5QDU + - id: p12B9pSzPXh7GiF7YT84t7 sortOrder: 3 fieldKey: isNewCustomer label: New Customer Flag @@ -14326,7 +14261,7 @@ items: choices: null dynamic: false allowNull: false - - id: uNAEn545vDrLmwEdGtKKzK + - id: nnRLte19g1zXhEnTVjMbmB sortOrder: 4 fieldKey: loyaltyStatus label: Loyalty Program Status @@ -14342,7 +14277,7 @@ items: choices: null dynamic: false allowNull: false - - id: kbmgdNcJwLGhfu1x5JDyNy + - id: uXezUiDYVX19rXwpkoPGqU sortOrder: 5 fieldKey: firstName label: First Name @@ -14356,7 +14291,7 @@ items: choices: null dynamic: false allowNull: false - - id: d8M4Wav1wd1kEgr5nz3djv + - id: c5tDaGSBMCt8GcHeWc31Bf sortOrder: 6 fieldKey: lastName label: Last Name @@ -14370,7 +14305,7 @@ items: choices: null dynamic: false allowNull: false - - id: kiNVPyiWJao7H7i2d5vd3P + - id: ed6ZW4TgiebaxNnxLHyuyx sortOrder: 7 fieldKey: name label: Name @@ -14384,7 +14319,7 @@ items: choices: null dynamic: false allowNull: false - - id: jAsUxchPn4dLrtJessdjvP + - id: oox5BrvQnKTUwuouCnHCuW sortOrder: 8 fieldKey: age label: Age @@ -14398,7 +14333,7 @@ items: choices: null dynamic: false allowNull: false - - id: bBwvh1FU6hTx7sZAv9Z4SY + - id: 52RrowQ2EFo5i8dJtAjbg5 sortOrder: 9 fieldKey: birthday label: Birthday @@ -14414,7 +14349,7 @@ items: choices: null dynamic: false allowNull: false - - id: 4PjMfC53zf7q4Dweg3n8jQ + - id: v8Xt9wQFrXQsNeHmcCBY9P sortOrder: 10 fieldKey: coupon label: Coupon Code @@ -14428,7 +14363,7 @@ items: choices: null dynamic: false allowNull: false - - id: kvzmQoZeSmWcBsZBDcVdqH + - id: g1Wn5fsKa3UKjo6KFXiS8a sortOrder: 11 fieldKey: attributionId label: Friendbuy Attribution ID @@ -14444,7 +14379,7 @@ items: choices: null dynamic: false allowNull: false - - id: 8drKi2r5mUiqpxy7uHo2bB + - id: t3fjGpemyUBqP6Hgdd7QdY sortOrder: 12 fieldKey: referralCode label: Friendbuy Referral ID @@ -14460,7 +14395,7 @@ items: choices: null dynamic: false allowNull: false - - id: vBQ96ZiNZ2vejqxaxYdriJ + - id: mdxKmKcDYpwbhhG84qRvjV sortOrder: 13 fieldKey: friendbuyAttributes label: Custom Attributes @@ -14477,538 +14412,650 @@ items: choices: null dynamic: false allowNull: false - - id: vj1sYaj9saWmcRUVbFaPf5 - name: Track Purchase - slug: trackPurchase - description: Record when a customer makes a purchase. - platform: WEB + - id: s6y497EuoSozVqCMzwYKDj + sortOrder: 14 + fieldKey: pageUrl + label: Page URL + type: STRING + description: The URL of the web page the event was generated on. + placeholder: '' + defaultValue: + '@path': $.context.page.url + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 9MY994crHiwQBd2tZ6N1pL + sortOrder: 15 + fieldKey: pageTitle + label: Page Title + type: STRING + description: The title of the web page the event was generated on. + placeholder: '' + defaultValue: + '@path': $.context.page.title + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 23oANDtBoWVKmwo7SMKBFL + sortOrder: 16 + fieldKey: userAgent + label: User Agent + type: STRING + description: The browser's User-Agent string. + placeholder: '' + defaultValue: + '@path': $.context.userAgent + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: jv4wtdTbrJj2WYZ1DymdiV + sortOrder: 17 + fieldKey: ipAddress + label: IP Address + type: STRING + description: The users's IP address. + placeholder: '' + defaultValue: + '@path': $.context.ip + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: qXnqSX3hkPFkzQRR8K5YJp + name: Track Customer + slug: trackCustomer + description: Create a new customer profile or update an existing customer profile. + platform: CLOUD hidden: false - defaultTrigger: event = "Order Completed" + defaultTrigger: null fields: - - id: jtDk7HdbW3h775XotYX7RW + - id: hyufZTKzkhVVYrbFqzKApD sortOrder: 0 - fieldKey: orderId - label: Order ID + fieldKey: customerId + label: Customer ID type: STRING - description: The order ID. + description: The user's customer ID. placeholder: '' defaultValue: - '@path': $.properties.order_id + '@path': $.userId required: true multiple: false choices: null dynamic: false allowNull: false - - id: seyRHj3Jhhsk7kTxXRSLoF + - id: tpxUYtNM6RgnvNZJfcC8DE sortOrder: 1 - fieldKey: amount - label: Amount Source - type: NUMBER - description: Purchase amount to be considered when evaluating reward rules. + fieldKey: anonymousId + label: Anonymous ID + type: STRING + description: The user's anonymous id. placeholder: '' defaultValue: - '@path': $.properties.total - required: true + '@path': $.anonymousId + required: false multiple: false choices: null dynamic: false allowNull: false - - id: erbhwHHEtPwPT7s9GDwC3H + - id: im1MDJmjPihfzjXBiqTTAu sortOrder: 2 - fieldKey: currency - label: Currency + fieldKey: email + label: Email type: STRING - description: The currency of the purchase amount. + description: The user's email address. placeholder: '' defaultValue: - '@path': $.properties.currency + '@path': $.traits.email required: true multiple: false choices: null dynamic: false allowNull: false - - id: apJrPW1frbeo6RF79E1eFs + - id: ih1KaVRRyWrJjiVMpoBNBz sortOrder: 3 - fieldKey: coupon - label: Coupon + fieldKey: firstName + label: First Name type: STRING - description: The coupon code of any coupon redeemed with the order. + description: The user's given name. placeholder: '' defaultValue: - '@path': $.properties.coupon + '@path': $.traits.firstName required: false multiple: false choices: null dynamic: false allowNull: false - - id: nbSRtQ5F7vNxhtEuLymfW + - id: dGYeLsMuqPLsqViv6ozqWz sortOrder: 4 - fieldKey: attributionId - label: Friendbuy Attribution ID + fieldKey: lastName + label: Last Name type: STRING - description: >- - Friendbuy attribution ID that associates the purchase with the advocate - who referred the purchaser. + description: The user's surname. placeholder: '' defaultValue: - '@path': $.properties.attributionId + '@path': $.traits.lastName required: false multiple: false choices: null dynamic: false allowNull: false - - id: x59iiXF7PXj4qX7Z1hXbva + - id: 5or25ohrdDqT31ZrRDtocE sortOrder: 5 - fieldKey: referralCode - label: Friendbuy Referral ID + fieldKey: name + label: Name type: STRING description: >- - Friendbuy referral code that associates the purchase with the advocate - who referred the purchaser. + 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. placeholder: '' defaultValue: - '@path': $.properties.referralCode + '@path': $.traits.name required: false multiple: false choices: null dynamic: false allowNull: false - - id: heQRdcwstpsku192obDNRo + - id: vFFWALL8gYvTQSVwQPTHsY sortOrder: 6 - fieldKey: giftCardCodes - label: Gift Card Codes - type: STRING - description: An array of gift card codes applied to the order. + fieldKey: age + label: Age + type: NUMBER + description: The user's age. placeholder: '' defaultValue: - '@path': $.properties.giftCardCodes + '@path': $.traits.age required: false - multiple: true + multiple: false choices: null dynamic: false allowNull: false - - id: jvZjKtMx75aR6DNQa817c + - id: oCLaaUerUXZVKRX2ZEQ4N4 sortOrder: 7 - fieldKey: products - label: Products - type: OBJECT - description: Products purchased. + fieldKey: birthday + label: Birthday + type: STRING + description: >- + The user's birthday in the format "YYYY-MM-DD", or "0000-MM-DD" to omit + the year. placeholder: '' defaultValue: - '@path': $.properties.products + '@path': $.traits.birthday required: false - multiple: true + multiple: false choices: null dynamic: false allowNull: false - - id: e49BnvXt9CdvsHP3gUddny + - id: fm5y5BWYpHvgRLxk8QcyR7 sortOrder: 8 - fieldKey: customerId - label: Customer ID + fieldKey: language + label: Language type: STRING - description: The user's customer ID. + description: The user's language. placeholder: '' defaultValue: - '@if': - exists: - '@path': $.properties.customerId - then: - '@path': $.properties.customerId - else: - '@path': $.userId + '@path': $.traits.language required: false multiple: false choices: null dynamic: false allowNull: false - - id: 7yu3J3PxaUyg3tuidJ7UaK + - id: 7aEAcqmizMXvrrMPYaWPMD sortOrder: 9 - fieldKey: anonymousId - label: Anonymous ID + fieldKey: addressCountry + label: Country type: STRING - description: The user's anonymous ID. + description: The user's country. placeholder: '' defaultValue: - '@path': $.anonymousId + '@path': $.traits.address.country required: false multiple: false choices: null dynamic: false allowNull: false - - id: pKJ7PkJzLJPmvHaa276pue + - id: kSfc4sggqPfW2LAoS86YpA sortOrder: 10 - fieldKey: email - label: Email + fieldKey: addressState + label: State type: STRING - description: The user's email address. + description: The user's state. placeholder: '' defaultValue: - '@path': $.properties.email + '@path': $.traits.address.state required: false multiple: false choices: null dynamic: false allowNull: false - - id: cxk2hBGqKivvjVi9ppjibC + - id: 5QT67XaNzBvD2bP5BWviGN sortOrder: 11 - fieldKey: isNewCustomer - label: New Customer Flag - type: BOOLEAN - description: Flag to indicate whether the user is a new customer. + fieldKey: addressCity + label: City + type: STRING + description: The user's city. placeholder: '' defaultValue: - '@path': $.properties.isNewCustomer + '@path': $.traits.address.city required: false multiple: false choices: null dynamic: false allowNull: false - - id: aQMFpBXqLfA3PDzRuFtduM + - id: 7jvw8ogMPSYoUh7e2b5o8q sortOrder: 12 - fieldKey: loyaltyStatus - label: Loyalty Program Status + fieldKey: addressPostalCode + label: State type: STRING - description: >- - The status of the user in your loyalty program. Valid values are "in", - "out", or "blocked". + description: The user's postal code. placeholder: '' defaultValue: - '@path': $.properties.loyaltyStatus + '@path': $.traits.address.postalCode required: false multiple: false choices: null dynamic: false allowNull: false - - id: rrpKTJgzEBSzCPg2vyjG9D + - id: nqCK3EhBEExK543hvjT1QW sortOrder: 13 - fieldKey: firstName - label: First Name + fieldKey: customerSince + label: Customer Since type: STRING - description: The user's given name. + description: The date the user became a customer. placeholder: '' defaultValue: - '@path': $.properties.firstName + '@path': $.traits.customerSince required: false multiple: false choices: null dynamic: false allowNull: false - - id: 3GDjggth5iTiT2dqGK7zGP + - id: 7ck4mtXS7pM17qVJPXYbd1 sortOrder: 14 - fieldKey: lastName - label: Last Name + fieldKey: loyaltyStatus + label: Loyalty Status type: STRING - description: The user's surname. + description: >- + The status of the user in your loyalty program. Valid values are "in", + "out", or "blocked". placeholder: '' defaultValue: - '@path': $.properties.lastName + '@path': $.traits.loyaltyStatus required: false multiple: false choices: null dynamic: false allowNull: false - - id: Xd4epHNN3sYt48neN9bN3 + - id: f882GLMrfrr4RCBGLvMT38 sortOrder: 15 - fieldKey: name - label: Name - type: STRING - description: The user's full name. + fieldKey: isNewCustomer + label: New Customer Flag + type: BOOLEAN + description: Flag to indicate whether the user is a new customer. placeholder: '' defaultValue: - '@path': $.properties.name + '@path': $.traits.isNewCustomer required: false multiple: false choices: null dynamic: false allowNull: false - - id: bSx5kxfkJoQ1vvcmXm6Ut2 + - id: 4RKrCbou8QR7vWNU9QZNpq sortOrder: 16 - fieldKey: age - label: Age - type: NUMBER - description: The user's age. + fieldKey: friendbuyAttributes + label: Custom Attributes + type: OBJECT + description: >- + 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. placeholder: '' defaultValue: - '@path': $.properties.age + '@path': $.traits.friendbuyAttributes required: false multiple: false choices: null dynamic: false allowNull: false - - id: hzg7x9k2QSCiBWzBxmwybk + - id: bRraNNAivMUoy5xi1B7qcH sortOrder: 17 - fieldKey: birthday - label: Birthday + fieldKey: pageUrl + label: Page URL type: STRING - description: >- - The user's birthday in the format "YYYY-MM-DD", or "0000-MM-DD" to omit - the year. + description: The URL of the web page the event was generated on. placeholder: '' defaultValue: - '@path': $.properties.birthday + '@path': $.context.page.url required: false multiple: false choices: null dynamic: false allowNull: false - - id: uQbbmFxFGAQJFhBzcHesbB + - id: 98taXo3A2L7qBLp2n6vv3U sortOrder: 18 - fieldKey: friendbuyAttributes - label: Custom Attributes - type: OBJECT - description: >- - 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. + fieldKey: pageTitle + label: Page Title + type: STRING + description: The title of the web page the event was generated on. placeholder: '' defaultValue: - '@path': $.properties.friendbuyAttributes + '@path': $.context.page.title required: false multiple: false choices: null dynamic: false allowNull: false - - id: wTBkHZFw3Mh66G65UkMXBL - name: Track Customer - slug: trackCustomer - description: Create a new customer profile or update an existing customer profile. - platform: WEB + - id: pHYgnkLb6aNpYeBUh86NaW + sortOrder: 19 + fieldKey: userAgent + label: User Agent + type: STRING + description: The browser's User-Agent string. + placeholder: '' + defaultValue: + '@path': $.context.userAgent + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: boje7ArY6dFCB4jc27VEin + sortOrder: 20 + fieldKey: ipAddress + label: IP Address + type: STRING + description: The users's IP address. + placeholder: '' + defaultValue: + '@path': $.context.ip + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: rHduKcyr8ptDrQnFupicxd + name: Track Purchase + slug: trackPurchase + description: Record when a customer makes a purchase. + platform: CLOUD hidden: false - defaultTrigger: type = "identify" + defaultTrigger: null fields: - - id: AkJRqp7x2vwUdqe97reZD + - id: wqe6KdE5WKF22aUQ89YbBk sortOrder: 0 - fieldKey: customerId - label: Customer ID + fieldKey: orderId + label: Order ID type: STRING - description: The user's customer ID. + description: The order ID. placeholder: '' defaultValue: - '@path': $.userId + '@path': $.properties.order_id required: true multiple: false choices: null dynamic: false allowNull: false - - id: xuoGFMgo6dDoMgFiUiK8dy + - id: qWq2mTDVazLgkUMyJgBoqG sortOrder: 1 - fieldKey: anonymousId - label: Anonymous ID - type: STRING - description: The user's anonymous id. + fieldKey: amount + label: Amount Source + type: NUMBER + description: Purchase amount to be considered when evaluating reward rules. placeholder: '' defaultValue: - '@path': $.anonymousId - required: false + '@path': $.properties.total + required: true multiple: false choices: null dynamic: false allowNull: false - - id: rQ91c85WpwF2cA4U8d59i + - id: r3tCWiMg4TkJeVnumM61kR sortOrder: 2 - fieldKey: email - label: Email + fieldKey: currency + label: Currency type: STRING - description: The user's email address. + description: The currency of the purchase amount. placeholder: '' defaultValue: - '@path': $.traits.email + '@path': $.properties.currency required: true multiple: false choices: null dynamic: false allowNull: false - - id: dgVNf5a6rpAbzBgK6B4MWA + - id: sUptyXAjZWNTpp3XRz4oFn sortOrder: 3 - fieldKey: firstName - label: First Name + fieldKey: coupon + label: Coupon type: STRING - description: The user's given name. + description: The coupon code of any coupon redeemed with the order. placeholder: '' defaultValue: - '@path': $.traits.firstName + '@path': $.properties.coupon required: false multiple: false choices: null dynamic: false allowNull: false - - id: sQQ5Q5QFveS1sr6anuYpTV + - id: 6G1UDvw4eSeH4PAKcDfKjg sortOrder: 4 - fieldKey: lastName - label: Last Name + fieldKey: attributionId + label: Friendbuy Attribution ID type: STRING - description: The user's surname. + description: >- + Friendbuy attribution ID that associates the purchase with the advocate + who referred the purchaser. placeholder: '' defaultValue: - '@path': $.traits.lastName + '@path': $.properties.attributionId required: false multiple: false choices: null dynamic: false allowNull: false - - id: miD4YPZSSJAvKashuwP9UK + - id: wdVUENe5YATHcU9mRoVVXU sortOrder: 5 - fieldKey: name - label: Name + fieldKey: referralCode + label: Friendbuy Referral ID type: STRING description: >- - 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. + Friendbuy referral code that associates the purchase with the advocate + who referred the purchaser. placeholder: '' defaultValue: - '@path': $.traits.name + '@path': $.properties.referralCode required: false multiple: false choices: null dynamic: false allowNull: false - - id: 2PGj2M8YErv7Ssz7M9FdCW + - id: bhWQtNmRgCHKAoW74H8h2J sortOrder: 6 - fieldKey: age - label: Age - type: NUMBER - description: The user's age. + fieldKey: giftCardCodes + label: Gift Card Codes + type: STRING + description: An array of gift card codes applied to the order. placeholder: '' defaultValue: - '@path': $.traits.age + '@path': $.properties.giftCardCodes required: false - multiple: false + multiple: true choices: null dynamic: false allowNull: false - - id: 9eutB7uWDAz8eucRfdqTGS + - id: aYi9MVMXoRozMekSzXuPwb sortOrder: 7 - fieldKey: birthday - label: Birthday - type: STRING - description: >- - The user's birthday in the format "YYYY-MM-DD", or "0000-MM-DD" to omit - the year. + fieldKey: products + label: Products + type: OBJECT + description: Products purchased. placeholder: '' defaultValue: - '@path': $.traits.birthday + '@path': $.properties.products required: false - multiple: false + multiple: true choices: null dynamic: false allowNull: false - - id: dLF9tZ39SShVVdoPzxV3Hv + - id: i76YK79Z6FdtNstg2wR1mP sortOrder: 8 - fieldKey: language - label: Language + fieldKey: customerId + label: Customer ID type: STRING - description: The user's language. + description: The user's customer ID. placeholder: '' defaultValue: - '@path': $.traits.language + '@if': + exists: + '@path': $.properties.customerId + then: + '@path': $.properties.customerId + else: + '@path': $.userId required: false multiple: false choices: null dynamic: false allowNull: false - - id: wQR61gJCRoK3TrcM5PdZZg + - id: mT7Di85ZgXTMJi3n7RxG5X sortOrder: 9 - fieldKey: addressCountry - label: Country + fieldKey: anonymousId + label: Anonymous ID type: STRING - description: The user's country. + description: The user's anonymous ID. placeholder: '' defaultValue: - '@path': $.traits.address.country + '@path': $.anonymousId required: false multiple: false choices: null dynamic: false allowNull: false - - id: t4kb37hYMbbNc4vCjGwKXn + - id: bUYzGk6i1CVBZoB53TySfS sortOrder: 10 - fieldKey: addressState - label: State + fieldKey: email + label: Email type: STRING - description: The user's state. + description: The user's email address. placeholder: '' defaultValue: - '@path': $.traits.address.state + '@path': $.properties.email required: false multiple: false choices: null dynamic: false allowNull: false - - id: nhW4J81o75BkVC5oHV5QeR + - id: imjDbTMEmYbpBT2TmX5FY8 sortOrder: 11 - fieldKey: addressCity - label: City - type: STRING - description: The user's city. + fieldKey: isNewCustomer + label: New Customer Flag + type: BOOLEAN + description: Flag to indicate whether the user is a new customer. placeholder: '' defaultValue: - '@path': $.traits.address.city + '@path': $.properties.isNewCustomer required: false multiple: false choices: null dynamic: false allowNull: false - - id: tN4BGwdF3QwVThS899pYKG + - id: LrpY891pMfaoM3EZoCinc sortOrder: 12 - fieldKey: addressPostalCode - label: State + fieldKey: loyaltyStatus + label: Loyalty Program Status type: STRING - description: The user's postal code. + description: >- + The status of the user in your loyalty program. Valid values are "in", + "out", or "blocked". placeholder: '' defaultValue: - '@path': $.traits.address.postalCode + '@path': $.properties.loyaltyStatus required: false multiple: false choices: null dynamic: false allowNull: false - - id: 4j9sK8W15BqpywxbBKazQM + - id: sNkavPa5RSnet4eWWbENQF sortOrder: 13 - fieldKey: customerSince - label: Customer Since + fieldKey: firstName + label: First Name type: STRING - description: The date the user became a customer. + description: The user's given name. placeholder: '' defaultValue: - '@path': $.traits.customerSince + '@path': $.properties.firstName required: false multiple: false choices: null dynamic: false allowNull: false - - id: 4W9aSb3uMBiFo4wixQ1BR7 + - id: v1SY9oFpwEPDkQEar37beY sortOrder: 14 - fieldKey: loyaltyStatus - label: Loyalty Status + fieldKey: lastName + label: Last Name type: STRING - description: >- - The status of the user in your loyalty program. Valid values are "in", - "out", or "blocked". + description: The user's surname. placeholder: '' defaultValue: - '@path': $.traits.loyaltyStatus + '@path': $.properties.lastName required: false multiple: false choices: null dynamic: false allowNull: false - - id: jVnqS7vnxv4BiVFRAgQ93P + - id: pWJgQR3w92hSvuAvPCift8 sortOrder: 15 - fieldKey: isNewCustomer - label: New Customer Flag - type: BOOLEAN - description: Flag to indicate whether the user is a new customer. + fieldKey: name + label: Name + type: STRING + description: The user's full name. placeholder: '' defaultValue: - '@path': $.traits.isNewCustomer + '@path': $.properties.name required: false multiple: false choices: null dynamic: false allowNull: false - - id: po4r4NNZhHZkukEoqWZc1s + - id: ua2vy95ckMFNXXEF2eDWqj sortOrder: 16 + fieldKey: age + label: Age + type: NUMBER + description: The user's age. + placeholder: '' + defaultValue: + '@path': $.properties.age + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: umTCW6h1TVzLBmr53N8Fgf + sortOrder: 17 + fieldKey: birthday + label: Birthday + type: STRING + description: >- + The user's birthday in the format "YYYY-MM-DD", or "0000-MM-DD" to omit + the year. + placeholder: '' + defaultValue: + '@path': $.properties.birthday + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 3VYELbeHb2Y86LRQ9GRxJ2 + sortOrder: 18 fieldKey: friendbuyAttributes label: Custom Attributes type: OBJECT @@ -15018,165 +15065,164 @@ items: strings. Non-string-valued attributes will be dropped. placeholder: '' defaultValue: - '@path': $.traits.friendbuyAttributes + '@path': $.properties.friendbuyAttributes required: false multiple: false choices: null dynamic: false allowNull: false - presets: - - actionId: vj1sYaj9saWmcRUVbFaPf5 - name: Track Purchase - fields: - orderId: - '@path': $.properties.order_id - amount: - '@path': $.properties.total - currency: - '@path': $.properties.currency - coupon: - '@path': $.properties.coupon - attributionId: - '@path': $.properties.attributionId - referralCode: - '@path': $.properties.referralCode - giftCardCodes: - '@path': $.properties.giftCardCodes - products: - '@path': $.properties.products - customerId: - '@if': - exists: - '@path': $.properties.customerId - then: - '@path': $.properties.customerId - else: - '@path': $.userId - anonymousId: - '@path': $.anonymousId - email: - '@path': $.properties.email - isNewCustomer: - '@path': $.properties.isNewCustomer - loyaltyStatus: - '@path': $.properties.loyaltyStatus - firstName: - '@path': $.properties.firstName - lastName: - '@path': $.properties.lastName - name: - '@path': $.properties.name - age: - '@path': $.properties.age - birthday: - '@path': $.properties.birthday - friendbuyAttributes: - '@path': $.properties.friendbuyAttributes - trigger: event = "Order Completed" - - actionId: wTBkHZFw3Mh66G65UkMXBL - name: Track Customer - fields: - customerId: - '@path': $.userId - anonymousId: - '@path': $.anonymousId - email: - '@path': $.traits.email - firstName: - '@path': $.traits.firstName - lastName: - '@path': $.traits.lastName - name: - '@path': $.traits.name - age: - '@path': $.traits.age - birthday: - '@path': $.traits.birthday - language: - '@path': $.traits.language - addressCountry: - '@path': $.traits.address.country - addressState: - '@path': $.traits.address.state - addressCity: - '@path': $.traits.address.city - addressPostalCode: - '@path': $.traits.address.postalCode - customerSince: - '@path': $.traits.customerSince - loyaltyStatus: - '@path': $.traits.loyaltyStatus - isNewCustomer: - '@path': $.traits.isNewCustomer - friendbuyAttributes: - '@path': $.traits.friendbuyAttributes - trigger: type = "identify" - - actionId: otSYqZFafJi5aae1yTwynq - name: Track Sign Up - fields: - customerId: - '@if': - exists: - '@path': $.properties.customerId - then: - '@path': $.properties.customerId - else: - '@path': $.userId - anonymousId: - '@path': $.anonymousId - email: - '@path': $.properties.email - isNewCustomer: - '@path': $.properties.isNewCustomer - loyaltyStatus: - '@path': $.properties.loyaltyStatus - firstName: - '@path': $.properties.firstName - lastName: - '@path': $.properties.lastName - name: - '@path': $.properties.name - age: - '@path': $.properties.age - birthday: - '@path': $.properties.birthday - coupon: - '@path': $.properties.coupon - attributionId: - '@path': $.properties.attributionId - referralCode: - '@path': $.properties.referralCode - friendbuyAttributes: - '@path': $.properties.friendbuyAttributes - trigger: event = "Signed Up" - - actionId: fk2xKEXiXd9qEkQb24nzXh - name: Track Page - fields: - name: - '@path': $.name - category: - '@path': $.category - title: - '@path': $.properties.title - trigger: type = "page" -- destination_id: 61dde0dc77eb0db0392649d3 - display_name: Friendbuy (Cloud Destination) - name: Friendbuy (Cloud Destination) - slug: actions-friendbuy-cloud + - id: msLckf49ZEaf1KsPfQ4x91 + sortOrder: 19 + fieldKey: pageUrl + label: Page URL + type: STRING + description: The URL of the web page the event was generated on. + placeholder: '' + defaultValue: + '@path': $.context.page.url + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: hoZJWaYBJQ9YhvQSJRF66f + sortOrder: 20 + fieldKey: pageTitle + label: Page Title + type: STRING + description: The title of the web page the event was generated on. + placeholder: '' + defaultValue: + '@path': $.context.page.title + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: iVx6fQYSn1TNrdmteTBr5w + sortOrder: 21 + fieldKey: userAgent + label: User Agent + type: STRING + description: The browser's User-Agent string. + placeholder: '' + defaultValue: + '@path': $.context.userAgent + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: sXZcFy1ehAgpDEJe2eo3zN + sortOrder: 22 + fieldKey: ipAddress + label: IP Address + type: STRING + description: The users's IP address. + placeholder: '' + defaultValue: + '@path': $.context.ip + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + presets: [] +- destination_id: 59ce9468cf711e00014a9c12 + display_name: Friendbuy (Legacy) + name: Friendbuy (Legacy) + slug: friendbuy-legacy hidden: false regional: - us-west - url: connections/destinations/catalog/actions-friendbuy-cloud + url: connections/destinations/catalog/friendbuy-legacy previous_names: - - Friendbuy (Cloud Destination) - website: http://www.segment.com + - FriendBuy + - Friendbuy + - Friendbuy (Legacy) + website: http://www.friendbuy.com status: PUBLIC categories: - Referrals logo: - url: https://cdn.filepicker.io/api/file/Lv1D71xoTOH6BxY6wcd4 + url: https://cdn.filepicker.io/api/file/ZkStZnT0qg7CyY2wiVgi mark: - url: https://cdn.filepicker.io/api/file/vVMZxAaTomw7iyVlgSo9 + url: https://cdn.filepicker.io/api/file/rRjOUuTtRePNf1AAgnkA + methods: + track: true + identify: true + group: false + alias: false + page: true + platforms: + browser: true + mobile: false + server: false + components: + - code: https://github.com/segment-integrations/analytics.js-integration-friendbuy + type: BROWSER + browserUnbundlingSupported: false + browserUnbundlingPublic: true + replay: false + connection_modes: + device: + web: true + mobile: false + server: false + cloud: + web: false + mobile: false + server: false + settings: + - name: siteId + type: string + defaultValue: '' + description: >- + This is your **Site ID**. It is used to identify your account in our + platform so we can properly attribute referral data. You can find your + Site ID in the in Friendbuy web application at **Settings > Integration + Code** + required: true + label: Site ID + - name: siteWideWidgets + type: mixed + defaultValue: [] + description: >- + By default, Friendbuy recommends you add a site wide overlay widget. You + can enter any of these site wide widgets here and we will load them any + time we receive a `.page()` call. *Note*: If you have custom widgets + mapped to named pages in the *Widgets* setting and you have provided a + site wide widget, we will load both. + required: false + label: Site Wide Widgets + - name: widgets + type: mixed + defaultValue: [] + description: Map your page calls to specific FriendBuy Widgets. + required: false + label: Page Widgets + actions: [] + presets: [] +- destination_id: 6170a348128093cd0245e0ea + display_name: Friendbuy (Web Destination) + name: Friendbuy (Web Destination) + slug: friendbuy-web-destination + hidden: false + regional: + - us-west + url: connections/destinations/catalog/friendbuy-web-destination + previous_names: + - Friendbuy (Actions) + - Friendbuy (Web Destinations) + - Friendbuy (Web Destination) + website: http://www.friendbuy.com + status: PUBLIC + categories: + - Referrals + logo: + url: https://cdn.filepicker.io/api/file/0OV3XmHVQi3n8PrFREPQ + mark: + url: https://cdn.filepicker.io/api/file/3BbFIi2bSsi08ig1RYgQ methods: track: true identify: true @@ -15186,7 +15232,7 @@ items: platforms: browser: true mobile: false - server: true + server: false components: [] browserUnbundlingSupported: false browserUnbundlingPublic: false @@ -15201,30 +15247,77 @@ items: mobile: false server: false settings: - - name: authKey + - name: merchantId type: string defaultValue: '' description: >- - Contact your Friendbuy account manager to generate your Friendbuy MAPI key - and secret. - required: true - label: Friendbuy MAPI Key - - name: authSecret - type: string - defaultValue: '' - description: See Friendbuy MAPI Key. + Find your Friendbuy Merchant ID by logging in to your [Friendbuy + account](https://retailer.friendbuy.io/) and going to Developer Center > + Friendbuy Code. required: true - label: Friendbuy MAPI Secret + label: Friendbuy Merchant ID actions: - - id: jGiVy4jyhXLyWfCbu4t9Rg + - id: fk2xKEXiXd9qEkQb24nzXh + name: Track Page + slug: trackPage + description: >- + Record when a customer visits a new page. Allow Friendbuy widget targeting + by Page Name instead of URL. + platform: WEB + hidden: false + defaultTrigger: type = "page" + fields: + - id: e49CUAczWNodafjNEkGVLa + sortOrder: 0 + fieldKey: name + label: Page Name + type: STRING + description: The page name. + placeholder: '' + defaultValue: + '@path': $.name + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: neQAzqaMjCLWQ1QAt82tDb + sortOrder: 1 + fieldKey: category + label: Page Category + type: STRING + description: The page category. + placeholder: '' + defaultValue: + '@path': $.category + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 49oECrHAo9dQiUp2cMY5cw + sortOrder: 2 + fieldKey: title + label: Page Title + type: STRING + description: The page title. + placeholder: '' + defaultValue: + '@path': $.properties.title + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: jK3iMvwwXbgAz1EBm9Akq6 name: Track Custom Event slug: trackCustomEvent description: Record when a customer completes any custom event that you define. - platform: CLOUD + platform: WEB hidden: false defaultTrigger: null fields: - - id: oowkcUpVHmzkBJrJFjy7Gx + - id: shTHGLkieU1eHuJcSdeLRB sortOrder: 0 fieldKey: eventType label: Event Type @@ -15238,7 +15331,7 @@ items: choices: null dynamic: false allowNull: false - - id: 5fE31vDVwcyJ7STwddGtoc + - id: 98zxb1CV5o2ke9JngvWEqY sortOrder: 1 fieldKey: eventProperties label: Event Properties @@ -15255,7 +15348,7 @@ items: choices: null dynamic: false allowNull: false - - id: vc2q1ZTU9LURMdNS5oZ5jj + - id: 43bqAQttGP3YDk6Apnn2Ht sortOrder: 2 fieldKey: deduplicationId label: Event ID @@ -15271,119 +15364,63 @@ items: choices: null dynamic: false allowNull: false - - id: 6KyKwR3v5R1stV8Ai1yWyL - sortOrder: 3 - fieldKey: customerId - label: Customer ID - type: STRING - description: The user's customer ID. - placeholder: '' - defaultValue: - '@if': - exists: - '@path': $.properties.customerId - then: - '@path': $.properties.customerId - else: - '@path': $.userId - required: true - multiple: false - choices: null - dynamic: false - allowNull: false - - id: nTza4zUtt7J9inTLaCGBHn - sortOrder: 4 - fieldKey: anonymousId - label: Anonymous ID - type: STRING - description: The user's anonymous id - placeholder: '' - defaultValue: - '@path': $.anonymousId - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: dnm8AgTE6jcgvXTJuVm5v2 - sortOrder: 5 - fieldKey: email - label: Email - type: STRING - description: The user's email address. - placeholder: '' - defaultValue: - '@path': $.properties.email - required: true - multiple: false - choices: null - dynamic: false - allowNull: false - - id: 8E22wrRB5nm2Bh5rVaqVvv - sortOrder: 6 - fieldKey: pageUrl - label: Page URL - type: STRING - description: The URL of the web page the event was generated on. - placeholder: '' - defaultValue: - '@path': $.context.page.url - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: JU9ksPnAeWWotgb7TtCWY - sortOrder: 7 - fieldKey: pageTitle - label: Page Title + - id: bh1Tzs9mGXTvuDGNC6hYHB + sortOrder: 3 + fieldKey: customerId + label: Customer ID type: STRING - description: The title of the web page the event was generated on. + description: The user's customer ID. placeholder: '' defaultValue: - '@path': $.context.page.title - required: false + '@if': + exists: + '@path': $.properties.customerId + then: + '@path': $.properties.customerId + else: + '@path': $.userId + required: true multiple: false choices: null dynamic: false allowNull: false - - id: wZNieDhsTwfjgsTYYuMJhj - sortOrder: 8 - fieldKey: userAgent - label: User Agent + - id: nk3aufvDqae12iG2gwC6VP + sortOrder: 4 + fieldKey: anonymousId + label: Anonymous ID type: STRING - description: The browser's User-Agent string. + description: The user's anonymous id placeholder: '' defaultValue: - '@path': $.context.userAgent + '@path': $.anonymousId required: false multiple: false choices: null dynamic: false allowNull: false - - id: g21v8UnT2NgMTqtXy6txS8 - sortOrder: 9 - fieldKey: ipAddress - label: IP Address + - id: vmZWyCzHXzKA4jxaHU5hwr + sortOrder: 5 + fieldKey: email + label: Email type: STRING - description: The users's IP address. + description: The user's email address. placeholder: '' defaultValue: - '@path': $.context.ip + '@path': $.properties.email required: false multiple: false choices: null dynamic: false allowNull: false - - id: mgg3vBV3yyXq7GxGdWpsPS + - id: otSYqZFafJi5aae1yTwynq name: Track Sign Up slug: trackSignUp description: Record when a customer signs up for a service. - platform: CLOUD + platform: WEB hidden: false - defaultTrigger: null + defaultTrigger: event = "Signed Up" fields: - - id: mVpzx1Nx2sFdX725PMNfwc + - id: 2gjjqzPLDWN9KLXbM3vu9F sortOrder: 0 fieldKey: customerId label: Customer ID @@ -15403,7 +15440,7 @@ items: choices: null dynamic: false allowNull: false - - id: iDeMAoiX8dBqvZfVCtRpGu + - id: di1f8nNefQ7nVLdzBPfqAQ sortOrder: 1 fieldKey: anonymousId label: Anonymous ID @@ -15417,7 +15454,7 @@ items: choices: null dynamic: false allowNull: false - - id: bb81Q5qU2wDxDHJNCftRHt + - id: 6MU84EwciUiTufPf97csEs sortOrder: 2 fieldKey: email label: Email @@ -15431,7 +15468,7 @@ items: choices: null dynamic: false allowNull: false - - id: p12B9pSzPXh7GiF7YT84t7 + - id: 64C5Xdb6PxU4D9pEav5QDU sortOrder: 3 fieldKey: isNewCustomer label: New Customer Flag @@ -15445,7 +15482,7 @@ items: choices: null dynamic: false allowNull: false - - id: nnRLte19g1zXhEnTVjMbmB + - id: uNAEn545vDrLmwEdGtKKzK sortOrder: 4 fieldKey: loyaltyStatus label: Loyalty Program Status @@ -15461,7 +15498,7 @@ items: choices: null dynamic: false allowNull: false - - id: uXezUiDYVX19rXwpkoPGqU + - id: kbmgdNcJwLGhfu1x5JDyNy sortOrder: 5 fieldKey: firstName label: First Name @@ -15475,7 +15512,7 @@ items: choices: null dynamic: false allowNull: false - - id: c5tDaGSBMCt8GcHeWc31Bf + - id: d8M4Wav1wd1kEgr5nz3djv sortOrder: 6 fieldKey: lastName label: Last Name @@ -15489,7 +15526,7 @@ items: choices: null dynamic: false allowNull: false - - id: ed6ZW4TgiebaxNnxLHyuyx + - id: kiNVPyiWJao7H7i2d5vd3P sortOrder: 7 fieldKey: name label: Name @@ -15503,7 +15540,7 @@ items: choices: null dynamic: false allowNull: false - - id: oox5BrvQnKTUwuouCnHCuW + - id: jAsUxchPn4dLrtJessdjvP sortOrder: 8 fieldKey: age label: Age @@ -15517,7 +15554,7 @@ items: choices: null dynamic: false allowNull: false - - id: 52RrowQ2EFo5i8dJtAjbg5 + - id: bBwvh1FU6hTx7sZAv9Z4SY sortOrder: 9 fieldKey: birthday label: Birthday @@ -15533,7 +15570,7 @@ items: choices: null dynamic: false allowNull: false - - id: v8Xt9wQFrXQsNeHmcCBY9P + - id: 4PjMfC53zf7q4Dweg3n8jQ sortOrder: 10 fieldKey: coupon label: Coupon Code @@ -15547,7 +15584,7 @@ items: choices: null dynamic: false allowNull: false - - id: g1Wn5fsKa3UKjo6KFXiS8a + - id: kvzmQoZeSmWcBsZBDcVdqH sortOrder: 11 fieldKey: attributionId label: Friendbuy Attribution ID @@ -15563,7 +15600,7 @@ items: choices: null dynamic: false allowNull: false - - id: t3fjGpemyUBqP6Hgdd7QdY + - id: 8drKi2r5mUiqpxy7uHo2bB sortOrder: 12 fieldKey: referralCode label: Friendbuy Referral ID @@ -15579,7 +15616,7 @@ items: choices: null dynamic: false allowNull: false - - id: mdxKmKcDYpwbhhG84qRvjV + - id: vBQ96ZiNZ2vejqxaxYdriJ sortOrder: 13 fieldKey: friendbuyAttributes label: Custom Attributes @@ -15596,650 +15633,538 @@ items: choices: null dynamic: false allowNull: false - - id: s6y497EuoSozVqCMzwYKDj - sortOrder: 14 - fieldKey: pageUrl - label: Page URL - type: STRING - description: The URL of the web page the event was generated on. - placeholder: '' - defaultValue: - '@path': $.context.page.url - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: 9MY994crHiwQBd2tZ6N1pL - sortOrder: 15 - fieldKey: pageTitle - label: Page Title - type: STRING - description: The title of the web page the event was generated on. - placeholder: '' - defaultValue: - '@path': $.context.page.title - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: 23oANDtBoWVKmwo7SMKBFL - sortOrder: 16 - fieldKey: userAgent - label: User Agent - type: STRING - description: The browser's User-Agent string. - placeholder: '' - defaultValue: - '@path': $.context.userAgent - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: jv4wtdTbrJj2WYZ1DymdiV - sortOrder: 17 - fieldKey: ipAddress - label: IP Address - type: STRING - description: The users's IP address. - placeholder: '' - defaultValue: - '@path': $.context.ip - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: qXnqSX3hkPFkzQRR8K5YJp - name: Track Customer - slug: trackCustomer - description: Create a new customer profile or update an existing customer profile. - platform: CLOUD + - id: vj1sYaj9saWmcRUVbFaPf5 + name: Track Purchase + slug: trackPurchase + description: Record when a customer makes a purchase. + platform: WEB hidden: false - defaultTrigger: null + defaultTrigger: event = "Order Completed" fields: - - id: hyufZTKzkhVVYrbFqzKApD + - id: jtDk7HdbW3h775XotYX7RW sortOrder: 0 - fieldKey: customerId - label: Customer ID + fieldKey: orderId + label: Order ID type: STRING - description: The user's customer ID. + description: The order ID. placeholder: '' defaultValue: - '@path': $.userId + '@path': $.properties.order_id required: true multiple: false choices: null dynamic: false allowNull: false - - id: tpxUYtNM6RgnvNZJfcC8DE + - id: seyRHj3Jhhsk7kTxXRSLoF sortOrder: 1 - fieldKey: anonymousId - label: Anonymous ID - type: STRING - description: The user's anonymous id. + fieldKey: amount + label: Amount Source + type: NUMBER + description: Purchase amount to be considered when evaluating reward rules. placeholder: '' defaultValue: - '@path': $.anonymousId - required: false + '@path': $.properties.total + required: true multiple: false choices: null dynamic: false allowNull: false - - id: im1MDJmjPihfzjXBiqTTAu + - id: erbhwHHEtPwPT7s9GDwC3H sortOrder: 2 - fieldKey: email - label: Email + fieldKey: currency + label: Currency type: STRING - description: The user's email address. + description: The currency of the purchase amount. placeholder: '' defaultValue: - '@path': $.traits.email + '@path': $.properties.currency required: true multiple: false choices: null dynamic: false allowNull: false - - id: ih1KaVRRyWrJjiVMpoBNBz + - id: apJrPW1frbeo6RF79E1eFs sortOrder: 3 - fieldKey: firstName - label: First Name + fieldKey: coupon + label: Coupon type: STRING - description: The user's given name. + description: The coupon code of any coupon redeemed with the order. placeholder: '' defaultValue: - '@path': $.traits.firstName + '@path': $.properties.coupon required: false multiple: false choices: null dynamic: false allowNull: false - - id: dGYeLsMuqPLsqViv6ozqWz + - id: nbSRtQ5F7vNxhtEuLymfW sortOrder: 4 - fieldKey: lastName - label: Last Name + fieldKey: attributionId + label: Friendbuy Attribution ID type: STRING - description: The user's surname. + description: >- + Friendbuy attribution ID that associates the purchase with the advocate + who referred the purchaser. placeholder: '' defaultValue: - '@path': $.traits.lastName + '@path': $.properties.attributionId required: false multiple: false choices: null dynamic: false allowNull: false - - id: 5or25ohrdDqT31ZrRDtocE + - id: x59iiXF7PXj4qX7Z1hXbva sortOrder: 5 - fieldKey: name - label: Name + fieldKey: referralCode + label: Friendbuy Referral ID type: STRING description: >- - 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. + Friendbuy referral code that associates the purchase with the advocate + who referred the purchaser. placeholder: '' defaultValue: - '@path': $.traits.name + '@path': $.properties.referralCode required: false multiple: false choices: null dynamic: false allowNull: false - - id: vFFWALL8gYvTQSVwQPTHsY + - id: heQRdcwstpsku192obDNRo sortOrder: 6 - fieldKey: age - label: Age - type: NUMBER - description: The user's age. + fieldKey: giftCardCodes + label: Gift Card Codes + type: STRING + description: An array of gift card codes applied to the order. placeholder: '' defaultValue: - '@path': $.traits.age + '@path': $.properties.giftCardCodes required: false - multiple: false + multiple: true choices: null dynamic: false allowNull: false - - id: oCLaaUerUXZVKRX2ZEQ4N4 + - id: jvZjKtMx75aR6DNQa817c sortOrder: 7 - fieldKey: birthday - label: Birthday - type: STRING - description: >- - The user's birthday in the format "YYYY-MM-DD", or "0000-MM-DD" to omit - the year. + fieldKey: products + label: Products + type: OBJECT + description: Products purchased. placeholder: '' defaultValue: - '@path': $.traits.birthday + '@path': $.properties.products required: false - multiple: false + multiple: true choices: null dynamic: false allowNull: false - - id: fm5y5BWYpHvgRLxk8QcyR7 + - id: e49BnvXt9CdvsHP3gUddny sortOrder: 8 - fieldKey: language - label: Language + fieldKey: customerId + label: Customer ID type: STRING - description: The user's language. + description: The user's customer ID. placeholder: '' defaultValue: - '@path': $.traits.language + '@if': + exists: + '@path': $.properties.customerId + then: + '@path': $.properties.customerId + else: + '@path': $.userId required: false multiple: false choices: null dynamic: false allowNull: false - - id: 7aEAcqmizMXvrrMPYaWPMD + - id: 7yu3J3PxaUyg3tuidJ7UaK sortOrder: 9 - fieldKey: addressCountry - label: Country + fieldKey: anonymousId + label: Anonymous ID type: STRING - description: The user's country. + description: The user's anonymous ID. placeholder: '' defaultValue: - '@path': $.traits.address.country + '@path': $.anonymousId required: false multiple: false choices: null dynamic: false allowNull: false - - id: kSfc4sggqPfW2LAoS86YpA + - id: pKJ7PkJzLJPmvHaa276pue sortOrder: 10 - fieldKey: addressState - label: State + fieldKey: email + label: Email type: STRING - description: The user's state. + description: The user's email address. placeholder: '' defaultValue: - '@path': $.traits.address.state + '@path': $.properties.email required: false multiple: false choices: null dynamic: false allowNull: false - - id: 5QT67XaNzBvD2bP5BWviGN + - id: cxk2hBGqKivvjVi9ppjibC sortOrder: 11 - fieldKey: addressCity - label: City - type: STRING - description: The user's city. + fieldKey: isNewCustomer + label: New Customer Flag + type: BOOLEAN + description: Flag to indicate whether the user is a new customer. placeholder: '' defaultValue: - '@path': $.traits.address.city + '@path': $.properties.isNewCustomer required: false multiple: false choices: null dynamic: false allowNull: false - - id: 7jvw8ogMPSYoUh7e2b5o8q + - id: aQMFpBXqLfA3PDzRuFtduM sortOrder: 12 - fieldKey: addressPostalCode - label: State + fieldKey: loyaltyStatus + label: Loyalty Program Status type: STRING - description: The user's postal code. + description: >- + The status of the user in your loyalty program. Valid values are "in", + "out", or "blocked". placeholder: '' defaultValue: - '@path': $.traits.address.postalCode + '@path': $.properties.loyaltyStatus required: false multiple: false choices: null dynamic: false allowNull: false - - id: nqCK3EhBEExK543hvjT1QW + - id: rrpKTJgzEBSzCPg2vyjG9D sortOrder: 13 - fieldKey: customerSince - label: Customer Since + fieldKey: firstName + label: First Name type: STRING - description: The date the user became a customer. + description: The user's given name. placeholder: '' defaultValue: - '@path': $.traits.customerSince + '@path': $.properties.firstName required: false multiple: false choices: null dynamic: false allowNull: false - - id: 7ck4mtXS7pM17qVJPXYbd1 + - id: 3GDjggth5iTiT2dqGK7zGP sortOrder: 14 - fieldKey: loyaltyStatus - label: Loyalty Status + fieldKey: lastName + label: Last Name type: STRING - description: >- - The status of the user in your loyalty program. Valid values are "in", - "out", or "blocked". + description: The user's surname. placeholder: '' defaultValue: - '@path': $.traits.loyaltyStatus + '@path': $.properties.lastName required: false multiple: false choices: null dynamic: false allowNull: false - - id: f882GLMrfrr4RCBGLvMT38 + - id: Xd4epHNN3sYt48neN9bN3 sortOrder: 15 - fieldKey: isNewCustomer - label: New Customer Flag - type: BOOLEAN - description: Flag to indicate whether the user is a new customer. + fieldKey: name + label: Name + type: STRING + description: The user's full name. placeholder: '' defaultValue: - '@path': $.traits.isNewCustomer + '@path': $.properties.name required: false multiple: false choices: null dynamic: false allowNull: false - - id: 4RKrCbou8QR7vWNU9QZNpq + - id: bSx5kxfkJoQ1vvcmXm6Ut2 sortOrder: 16 - fieldKey: friendbuyAttributes - label: Custom Attributes - type: OBJECT - description: >- - 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. + fieldKey: age + label: Age + type: NUMBER + description: The user's age. placeholder: '' defaultValue: - '@path': $.traits.friendbuyAttributes + '@path': $.properties.age required: false multiple: false choices: null dynamic: false allowNull: false - - id: bRraNNAivMUoy5xi1B7qcH + - id: hzg7x9k2QSCiBWzBxmwybk sortOrder: 17 - fieldKey: pageUrl - label: Page URL + fieldKey: birthday + label: Birthday type: STRING - description: The URL of the web page the event was generated on. + description: >- + The user's birthday in the format "YYYY-MM-DD", or "0000-MM-DD" to omit + the year. placeholder: '' defaultValue: - '@path': $.context.page.url + '@path': $.properties.birthday required: false multiple: false choices: null dynamic: false allowNull: false - - id: 98taXo3A2L7qBLp2n6vv3U + - id: uQbbmFxFGAQJFhBzcHesbB sortOrder: 18 - fieldKey: pageTitle - label: Page Title - type: STRING - description: The title of the web page the event was generated on. - placeholder: '' - defaultValue: - '@path': $.context.page.title - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: pHYgnkLb6aNpYeBUh86NaW - sortOrder: 19 - fieldKey: userAgent - label: User Agent - type: STRING - description: The browser's User-Agent string. - placeholder: '' - defaultValue: - '@path': $.context.userAgent - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: boje7ArY6dFCB4jc27VEin - sortOrder: 20 - fieldKey: ipAddress - label: IP Address - type: STRING - description: The users's IP address. + fieldKey: friendbuyAttributes + label: Custom Attributes + type: OBJECT + description: >- + 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. placeholder: '' defaultValue: - '@path': $.context.ip + '@path': $.properties.friendbuyAttributes required: false multiple: false choices: null dynamic: false allowNull: false - - id: rHduKcyr8ptDrQnFupicxd - name: Track Purchase - slug: trackPurchase - description: Record when a customer makes a purchase. - platform: CLOUD + - id: wTBkHZFw3Mh66G65UkMXBL + name: Track Customer + slug: trackCustomer + description: Create a new customer profile or update an existing customer profile. + platform: WEB hidden: false - defaultTrigger: null + defaultTrigger: type = "identify" fields: - - id: wqe6KdE5WKF22aUQ89YbBk + - id: AkJRqp7x2vwUdqe97reZD sortOrder: 0 - fieldKey: orderId - label: Order ID + fieldKey: customerId + label: Customer ID type: STRING - description: The order ID. + description: The user's customer ID. placeholder: '' defaultValue: - '@path': $.properties.order_id + '@path': $.userId required: true multiple: false choices: null dynamic: false allowNull: false - - id: qWq2mTDVazLgkUMyJgBoqG + - id: xuoGFMgo6dDoMgFiUiK8dy sortOrder: 1 - fieldKey: amount - label: Amount Source - type: NUMBER - description: Purchase amount to be considered when evaluating reward rules. + fieldKey: anonymousId + label: Anonymous ID + type: STRING + description: The user's anonymous id. placeholder: '' defaultValue: - '@path': $.properties.total - required: true + '@path': $.anonymousId + required: false multiple: false choices: null dynamic: false allowNull: false - - id: r3tCWiMg4TkJeVnumM61kR + - id: rQ91c85WpwF2cA4U8d59i sortOrder: 2 - fieldKey: currency - label: Currency + fieldKey: email + label: Email type: STRING - description: The currency of the purchase amount. + description: The user's email address. placeholder: '' defaultValue: - '@path': $.properties.currency + '@path': $.traits.email required: true multiple: false choices: null dynamic: false allowNull: false - - id: sUptyXAjZWNTpp3XRz4oFn + - id: dgVNf5a6rpAbzBgK6B4MWA sortOrder: 3 - fieldKey: coupon - label: Coupon + fieldKey: firstName + label: First Name type: STRING - description: The coupon code of any coupon redeemed with the order. + description: The user's given name. placeholder: '' defaultValue: - '@path': $.properties.coupon + '@path': $.traits.firstName required: false multiple: false choices: null dynamic: false allowNull: false - - id: 6G1UDvw4eSeH4PAKcDfKjg + - id: sQQ5Q5QFveS1sr6anuYpTV sortOrder: 4 - fieldKey: attributionId - label: Friendbuy Attribution ID + fieldKey: lastName + label: Last Name type: STRING - description: >- - Friendbuy attribution ID that associates the purchase with the advocate - who referred the purchaser. + description: The user's surname. placeholder: '' defaultValue: - '@path': $.properties.attributionId + '@path': $.traits.lastName required: false multiple: false choices: null dynamic: false allowNull: false - - id: wdVUENe5YATHcU9mRoVVXU + - id: miD4YPZSSJAvKashuwP9UK sortOrder: 5 - fieldKey: referralCode - label: Friendbuy Referral ID + fieldKey: name + label: Name type: STRING description: >- - Friendbuy referral code that associates the purchase with the advocate - who referred the purchaser. + 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. placeholder: '' defaultValue: - '@path': $.properties.referralCode + '@path': $.traits.name required: false multiple: false choices: null dynamic: false allowNull: false - - id: bhWQtNmRgCHKAoW74H8h2J + - id: 2PGj2M8YErv7Ssz7M9FdCW sortOrder: 6 - fieldKey: giftCardCodes - label: Gift Card Codes - type: STRING - description: An array of gift card codes applied to the order. + fieldKey: age + label: Age + type: NUMBER + description: The user's age. placeholder: '' defaultValue: - '@path': $.properties.giftCardCodes + '@path': $.traits.age required: false - multiple: true + multiple: false choices: null dynamic: false allowNull: false - - id: aYi9MVMXoRozMekSzXuPwb + - id: 9eutB7uWDAz8eucRfdqTGS sortOrder: 7 - fieldKey: products - label: Products - type: OBJECT - description: Products purchased. + fieldKey: birthday + label: Birthday + type: STRING + description: >- + The user's birthday in the format "YYYY-MM-DD", or "0000-MM-DD" to omit + the year. placeholder: '' defaultValue: - '@path': $.properties.products + '@path': $.traits.birthday required: false - multiple: true + multiple: false choices: null dynamic: false allowNull: false - - id: i76YK79Z6FdtNstg2wR1mP + - id: dLF9tZ39SShVVdoPzxV3Hv sortOrder: 8 - fieldKey: customerId - label: Customer ID + fieldKey: language + label: Language type: STRING - description: The user's customer ID. + description: The user's language. placeholder: '' defaultValue: - '@if': - exists: - '@path': $.properties.customerId - then: - '@path': $.properties.customerId - else: - '@path': $.userId + '@path': $.traits.language required: false multiple: false choices: null dynamic: false allowNull: false - - id: mT7Di85ZgXTMJi3n7RxG5X + - id: wQR61gJCRoK3TrcM5PdZZg sortOrder: 9 - fieldKey: anonymousId - label: Anonymous ID + fieldKey: addressCountry + label: Country type: STRING - description: The user's anonymous ID. + description: The user's country. placeholder: '' defaultValue: - '@path': $.anonymousId + '@path': $.traits.address.country required: false multiple: false choices: null dynamic: false allowNull: false - - id: bUYzGk6i1CVBZoB53TySfS + - id: t4kb37hYMbbNc4vCjGwKXn sortOrder: 10 - fieldKey: email - label: Email + fieldKey: addressState + label: State type: STRING - description: The user's email address. + description: The user's state. placeholder: '' defaultValue: - '@path': $.properties.email + '@path': $.traits.address.state required: false multiple: false choices: null dynamic: false allowNull: false - - id: imjDbTMEmYbpBT2TmX5FY8 + - id: nhW4J81o75BkVC5oHV5QeR sortOrder: 11 - fieldKey: isNewCustomer - label: New Customer Flag - type: BOOLEAN - description: Flag to indicate whether the user is a new customer. + fieldKey: addressCity + label: City + type: STRING + description: The user's city. placeholder: '' defaultValue: - '@path': $.properties.isNewCustomer + '@path': $.traits.address.city required: false multiple: false choices: null dynamic: false allowNull: false - - id: LrpY891pMfaoM3EZoCinc + - id: tN4BGwdF3QwVThS899pYKG sortOrder: 12 - fieldKey: loyaltyStatus - label: Loyalty Program Status + fieldKey: addressPostalCode + label: State type: STRING - description: >- - The status of the user in your loyalty program. Valid values are "in", - "out", or "blocked". + description: The user's postal code. placeholder: '' defaultValue: - '@path': $.properties.loyaltyStatus + '@path': $.traits.address.postalCode required: false multiple: false choices: null dynamic: false allowNull: false - - id: sNkavPa5RSnet4eWWbENQF + - id: 4j9sK8W15BqpywxbBKazQM sortOrder: 13 - fieldKey: firstName - label: First Name + fieldKey: customerSince + label: Customer Since type: STRING - description: The user's given name. + description: The date the user became a customer. placeholder: '' defaultValue: - '@path': $.properties.firstName + '@path': $.traits.customerSince required: false multiple: false choices: null dynamic: false allowNull: false - - id: v1SY9oFpwEPDkQEar37beY + - id: 4W9aSb3uMBiFo4wixQ1BR7 sortOrder: 14 - fieldKey: lastName - label: Last Name + fieldKey: loyaltyStatus + label: Loyalty Status type: STRING - description: The user's surname. + description: >- + The status of the user in your loyalty program. Valid values are "in", + "out", or "blocked". placeholder: '' defaultValue: - '@path': $.properties.lastName + '@path': $.traits.loyaltyStatus required: false multiple: false choices: null dynamic: false allowNull: false - - id: pWJgQR3w92hSvuAvPCift8 + - id: jVnqS7vnxv4BiVFRAgQ93P sortOrder: 15 - fieldKey: name - label: Name - type: STRING - description: The user's full name. + fieldKey: isNewCustomer + label: New Customer Flag + type: BOOLEAN + description: Flag to indicate whether the user is a new customer. placeholder: '' defaultValue: - '@path': $.properties.name + '@path': $.traits.isNewCustomer required: false multiple: false choices: null dynamic: false allowNull: false - - id: ua2vy95ckMFNXXEF2eDWqj + - id: po4r4NNZhHZkukEoqWZc1s sortOrder: 16 - fieldKey: age - label: Age - type: NUMBER - description: The user's age. - placeholder: '' - defaultValue: - '@path': $.properties.age - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: umTCW6h1TVzLBmr53N8Fgf - sortOrder: 17 - fieldKey: birthday - label: Birthday - type: STRING - description: >- - The user's birthday in the format "YYYY-MM-DD", or "0000-MM-DD" to omit - the year. - placeholder: '' - defaultValue: - '@path': $.properties.birthday - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: 3VYELbeHb2Y86LRQ9GRxJ2 - sortOrder: 18 fieldKey: friendbuyAttributes label: Custom Attributes type: OBJECT @@ -16249,69 +16174,147 @@ items: strings. Non-string-valued attributes will be dropped. placeholder: '' defaultValue: + '@path': $.traits.friendbuyAttributes + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + presets: + - actionId: vj1sYaj9saWmcRUVbFaPf5 + name: Track Purchase + fields: + orderId: + '@path': $.properties.order_id + amount: + '@path': $.properties.total + currency: + '@path': $.properties.currency + coupon: + '@path': $.properties.coupon + attributionId: + '@path': $.properties.attributionId + referralCode: + '@path': $.properties.referralCode + giftCardCodes: + '@path': $.properties.giftCardCodes + products: + '@path': $.properties.products + customerId: + '@if': + exists: + '@path': $.properties.customerId + then: + '@path': $.properties.customerId + else: + '@path': $.userId + anonymousId: + '@path': $.anonymousId + email: + '@path': $.properties.email + isNewCustomer: + '@path': $.properties.isNewCustomer + loyaltyStatus: + '@path': $.properties.loyaltyStatus + firstName: + '@path': $.properties.firstName + lastName: + '@path': $.properties.lastName + name: + '@path': $.properties.name + age: + '@path': $.properties.age + birthday: + '@path': $.properties.birthday + friendbuyAttributes: + '@path': $.properties.friendbuyAttributes + trigger: event = "Order Completed" + - actionId: wTBkHZFw3Mh66G65UkMXBL + name: Track Customer + fields: + customerId: + '@path': $.userId + anonymousId: + '@path': $.anonymousId + email: + '@path': $.traits.email + firstName: + '@path': $.traits.firstName + lastName: + '@path': $.traits.lastName + name: + '@path': $.traits.name + age: + '@path': $.traits.age + birthday: + '@path': $.traits.birthday + language: + '@path': $.traits.language + addressCountry: + '@path': $.traits.address.country + addressState: + '@path': $.traits.address.state + addressCity: + '@path': $.traits.address.city + addressPostalCode: + '@path': $.traits.address.postalCode + customerSince: + '@path': $.traits.customerSince + loyaltyStatus: + '@path': $.traits.loyaltyStatus + isNewCustomer: + '@path': $.traits.isNewCustomer + friendbuyAttributes: + '@path': $.traits.friendbuyAttributes + trigger: type = "identify" + - actionId: otSYqZFafJi5aae1yTwynq + name: Track Sign Up + fields: + customerId: + '@if': + exists: + '@path': $.properties.customerId + then: + '@path': $.properties.customerId + else: + '@path': $.userId + anonymousId: + '@path': $.anonymousId + email: + '@path': $.properties.email + isNewCustomer: + '@path': $.properties.isNewCustomer + loyaltyStatus: + '@path': $.properties.loyaltyStatus + firstName: + '@path': $.properties.firstName + lastName: + '@path': $.properties.lastName + name: + '@path': $.properties.name + age: + '@path': $.properties.age + birthday: + '@path': $.properties.birthday + coupon: + '@path': $.properties.coupon + attributionId: + '@path': $.properties.attributionId + referralCode: + '@path': $.properties.referralCode + friendbuyAttributes: '@path': $.properties.friendbuyAttributes - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: msLckf49ZEaf1KsPfQ4x91 - sortOrder: 19 - fieldKey: pageUrl - label: Page URL - type: STRING - description: The URL of the web page the event was generated on. - placeholder: '' - defaultValue: - '@path': $.context.page.url - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: hoZJWaYBJQ9YhvQSJRF66f - sortOrder: 20 - fieldKey: pageTitle - label: Page Title - type: STRING - description: The title of the web page the event was generated on. - placeholder: '' - defaultValue: - '@path': $.context.page.title - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: iVx6fQYSn1TNrdmteTBr5w - sortOrder: 21 - fieldKey: userAgent - label: User Agent - type: STRING - description: The browser's User-Agent string. - placeholder: '' - defaultValue: - '@path': $.context.userAgent - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: sXZcFy1ehAgpDEJe2eo3zN - sortOrder: 22 - fieldKey: ipAddress - label: IP Address - type: STRING - description: The users's IP address. - placeholder: '' - defaultValue: - '@path': $.context.ip - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - presets: [] + trigger: event = "Signed Up" + - actionId: fk2xKEXiXd9qEkQb24nzXh + name: Track Page + fields: + name: + '@path': $.name + category: + '@path': $.category + title: + '@path': $.properties.title + trigger: type = "page" - destination_id: 54521fd625e721e32a72eeb8 display_name: FullStory name: FullStory @@ -28258,7 +28261,7 @@ items: previous_names: - Refiner website: https://refiner.io - status: PUBLIC_BETA + status: PUBLIC categories: - Surveys - Enrichment @@ -31102,6 +31105,241 @@ items: label: API Key actions: [] presets: [] +- destination_id: 61d8c74d174a9acd0e138b31 + display_name: Sprig (Actions) + name: Sprig (Actions) + slug: sprig-web + hidden: false + regional: + - us-west + url: connections/destinations/catalog/sprig-web + previous_names: + - Sprig (Actions) + website: http://www.segment.com + status: PUBLIC + categories: [] + logo: + url: https://cdn.filepicker.io/api/file/ueZESNlpT4KuMqjhpz8j + mark: + url: https://cdn.filepicker.io/api/file/oKhe3lfbRGuJdK6E1UGb + methods: + track: true + identify: true + group: true + alias: true + page: true + platforms: + browser: true + mobile: false + server: false + components: [] + browserUnbundlingSupported: false + browserUnbundlingPublic: false + replay: false + connection_modes: + device: + web: false + mobile: false + server: false + cloud: + web: false + mobile: false + server: false + settings: + - name: debugMode + type: boolean + defaultValue: false + description: Enable debug mode for testing purposes. + required: true + label: Debug mode + - name: envId + type: string + defaultValue: '' + description: Your environment ID (production or development). + required: true + label: Environment ID + actions: + - id: 97HqiB5M476WiednY69xWk + name: Sign Out User + slug: signoutUser + description: >- + Clear stored user ID so that future events and traits are not associated + with this user. + platform: WEB + hidden: false + defaultTrigger: type = "track" and event = "Signed Out" + fields: [] + - id: ejUVPZC3Ry95eypqUbvsSf + name: Update User ID + slug: updateUserId + description: Set updated user ID. + platform: WEB + hidden: false + defaultTrigger: type = "alias" + fields: + - id: aBE76n9SuQFgDBGpbHmDtg + sortOrder: 0 + fieldKey: userId + label: User ID + type: STRING + description: New unique identifier for the user + placeholder: '' + defaultValue: + '@path': $.userId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: bpxrrjxSegRfbGmp5MBjDa + sortOrder: 1 + fieldKey: anonymousId + label: Anonymous ID + type: STRING + description: New anonymous identifier for the user + placeholder: '' + defaultValue: + '@path': $.anonymousId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: fM2KL8nJKHQPEVXdN9hxH5 + name: Track Event + slug: trackEvent + description: >- + Track event to potentially filter user studies (microsurveys) later, or + trigger a study now. + platform: WEB + hidden: false + defaultTrigger: type = "track" and event != "Signed Out" + fields: + - id: 7AyA2gRChRYdvwkbHmitHZ + sortOrder: 0 + fieldKey: name + label: Event name + type: STRING + description: The event name that will be shown on Sprig's dashboard + placeholder: '' + defaultValue: + '@path': $.event + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: v6Uihnc2ZbMt2uNWijAHiT + sortOrder: 1 + fieldKey: userId + label: User ID + type: STRING + description: Unique identifier for the user + placeholder: '' + defaultValue: + '@path': $.userId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: wuMfnNJJg2o5ReHKRu8owU + sortOrder: 2 + fieldKey: anonymousId + label: Anonymous ID + type: STRING + description: Anonymous identifier for the user + placeholder: '' + defaultValue: + '@path': $.anonymousId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: v824Xre4bGxg88RqE88iHQ + name: Identify User + slug: identifyUser + description: Set user ID and/or attributes. + platform: WEB + hidden: false + defaultTrigger: type = "identify" + fields: + - id: kyPWZ2gC45fxTKvMajQQVF + sortOrder: 0 + fieldKey: userId + label: User ID + type: STRING + description: Unique identifier for the user + placeholder: '' + defaultValue: + '@path': $.userId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 3GWX9a4CFagXhpgVaHAbaB + sortOrder: 1 + fieldKey: anonymousId + label: Anonymous ID + type: STRING + description: Anonymous identifier for the user + placeholder: '' + defaultValue: + '@path': $.anonymousId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: iVLqFVS8hNomPQDkJviCpJ + sortOrder: 2 + fieldKey: traits + label: User Attributes + type: OBJECT + description: The Segment user traits to be forwarded to Sprig and set as attributes + placeholder: '' + defaultValue: + '@path': $.traits + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + presets: + - actionId: v824Xre4bGxg88RqE88iHQ + name: Identify User + fields: + userId: + '@path': $.userId + anonymousId: + '@path': $.anonymousId + traits: + '@path': $.traits + trigger: type = "identify" + - actionId: ejUVPZC3Ry95eypqUbvsSf + name: Update User ID + fields: + userId: + '@path': $.userId + anonymousId: + '@path': $.anonymousId + trigger: type = "alias" + - actionId: 97HqiB5M476WiednY69xWk + name: Sign Out User + fields: {} + trigger: type = "track" and event = "Signed Out" + - actionId: fM2KL8nJKHQPEVXdN9hxH5 + name: Track Event + fields: + name: + '@path': $.event + userId: + '@path': $.userId + anonymousId: + '@path': $.anonymousId + trigger: type = "track" and event != "Signed Out" - destination_id: 5f2c35239094d175b6485eb1 display_name: Sprig Cloud name: Sprig Cloud diff --git a/src/_data/catalog/regional-supported.yml b/src/_data/catalog/regional-supported.yml index 0e4de476b6..90ba9989f9 100644 --- a/src/_data/catalog/regional-supported.yml +++ b/src/_data/catalog/regional-supported.yml @@ -1,5 +1,5 @@ # AUTOGENERATED LIST OF CONNECTIONS THAT SUPPORT REGIONAL -# Last updated 2022-02-01 +# Last updated 2022-02-07 warehouses: - id: WcjBCzUGff display_name: Azure SQL Data Warehouse @@ -51,7 +51,7 @@ warehouses: - us-west - eu-west # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT -# source cateogries last updated 2022-02-01 +# source cateogries last updated 2022-02-07 items: - display_name: A/B Testing slug: a-b-testing @@ -1259,24 +1259,24 @@ destinations: url: connections/destinations/catalog/freshsales regional: - us-west - - id: 59ce9468cf711e00014a9c12 - display_name: Friendbuy - slug: friendbuy - url: connections/destinations/catalog/friendbuy - regional: - - us-west - - id: 6170a348128093cd0245e0ea - display_name: Friendbuy (Actions) - slug: actions-friendbuy - url: connections/destinations/catalog/actions-friendbuy - regional: - - us-west - id: 61dde0dc77eb0db0392649d3 display_name: Friendbuy (Cloud Destination) slug: actions-friendbuy-cloud url: connections/destinations/catalog/actions-friendbuy-cloud regional: - us-west + - id: 59ce9468cf711e00014a9c12 + display_name: Friendbuy (Legacy) + slug: friendbuy-legacy + url: connections/destinations/catalog/friendbuy-legacy + regional: + - us-west + - id: 6170a348128093cd0245e0ea + display_name: Friendbuy (Web Destination) + slug: friendbuy-web-destination + url: connections/destinations/catalog/friendbuy-web-destination + regional: + - us-west - id: 54521fd625e721e32a72eeb8 display_name: FullStory slug: fullstory @@ -2292,6 +2292,12 @@ destinations: url: connections/destinations/catalog/split regional: - us-west + - id: 61d8c74d174a9acd0e138b31 + display_name: Sprig (Actions) + slug: sprig-web + url: connections/destinations/catalog/sprig-web + regional: + - us-west - id: 5f2c35239094d175b6485eb1 display_name: Sprig Cloud slug: sprig-cloud diff --git a/src/_data/catalog/source_categories.yml b/src/_data/catalog/source_categories.yml index 15dfd1a818..a2a263d9e6 100644 --- a/src/_data/catalog/source_categories.yml +++ b/src/_data/catalog/source_categories.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT -# source cateogries last updated 2022-02-01 +# source cateogries last updated 2022-02-07 items: - display_name: A/B Testing slug: a-b-testing diff --git a/src/_data/catalog/sources.yml b/src/_data/catalog/sources.yml index c3f13a19da..7f997382e2 100644 --- a/src/_data/catalog/sources.yml +++ b/src/_data/catalog/sources.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT -# sources last updated 2022-02-01 +# sources last updated 2022-02-07 items: - id: 8HWbgPTt3k display_name: .NET diff --git a/src/connections/destinations/catalog/actions-sprig-web/index.md b/src/connections/destinations/catalog/actions-sprig-web/index.md index 1fc5e3bb80..d9a1becde0 100644 --- a/src/connections/destinations/catalog/actions-sprig-web/index.md +++ b/src/connections/destinations/catalog/actions-sprig-web/index.md @@ -4,8 +4,6 @@ title: Sprig (Actions) Destination hide-boilerplate: true hide-dossier: true hidden: true -redirect_from: - - '/connections/destinations/catalog/sprig-web' --- @@ -44,28 +42,7 @@ Sprig (Actions) provides the following benefits over the classic Sprig destinati -## Pre-built subscriptions - -By default, a new Sprig (Actions) destination comes with the following subscriptions. - -Select these subscriptions by choosing **Quick Setup** when you first configure the destination. You can enable, edit, or disable them from the screen that appears. - -| Subscription Name | Default Trigger | Sprig Action | -| ------------------ | ----------------------------------------- | ------------------------- | -| Identify User | All events with type **Identify**. | Set User ID, email, and other traits. | -| Sign Out User | Events with name **Signed Out** and type **Track**. | Log out user on Sprig so that future actions are not associated with them. | -| Track Event | All events with type **Track**, except **Signed Out**. | Track this event name for this user, and potentially display a matching microsurvey. | -| Update User ID | All events with type **Alias**. | Update the User ID for the current user. | - -## Available Sprig actions - -Combine the supported [triggers](/docs/connections/destinations/actions/#components-of-a-destination-action) with the following Sprig-supported actions: - -- [Identify User](#identify-user) -- [Sign Out User](#sign-out-user) -- [Track Event](#track-event) -- [Update User ID](#update-user-id) - +{% include components/actions-fields.html %} ## Migration from the classic Sprig destination diff --git a/src/connections/destinations/catalog/sprig-web/index.md b/src/connections/destinations/catalog/sprig-web/index.md new file mode 100644 index 0000000000..8f5141feff --- /dev/null +++ b/src/connections/destinations/catalog/sprig-web/index.md @@ -0,0 +1,53 @@ +--- +title: 'Sprig (Actions) Destination' +hidden: false +hide-boilerplate: true +hide-dossier: true +redirect_from: + - '/connections/destinations/catalog/actions-sprig-web' +--- + + + +{% include content/plan-grid.md name="actions" %} + +[Sprig (formerly UserLeap)](https://sprig.com/?&utm_source=segmentio&utm_medium=docs_actions&utm_campaign=integration){:target="_blank"} is an in-context user research platform that makes it fast and effortless for product teams to learn from their actual customers in real-time, through microsurveys, concept tests, and video questions. + +Sprig maintains this destination. For any issues with the destination, consult [Sprig's documentation](https://docs.sprig.com/docs/segment-web) or contact [support@sprig.com](mailto:support@sprig.com). + + + + +> success "" +> **Good to know**: This page is about the [Actions-framework](/docs/connections/destinations/actions/) Sprig Segment destination. There's also a page about the [non-Actions Sprig Cloud (formerly UserLeap) destination](/docs/connections/destinations/catalog/userleap/). Both of these destinations receive data from Segment. + + + +## Benefits of Sprig (Actions) vs Sprig Classic + +Sprig (Actions) provides the following benefits over the classic Sprig destination: + +- **Trigger microsurveys**. Because Sprig (Actions) hooks into your browser-based, JavaScript Segment source, it can be used to trigger Sprig microsurveys. +- **Code-free Sprig installation**. The Sprig (Actions) destination can install the Sprig SDK onto your website, without you having to update any code. + + + +## Getting started + +1. From the Segment web app, click **Catalog**, then click **Destinations**. +2. Use the navigation on the left to locate and select Sprig (Actions). +3. Click **Configure Sprig (Actions)**. +4. Select an existing JavaScript website source to connect to Sprig (Actions). +5. Find your Environment ID on [Sprig Dashboard > Connect > JavaScript](https://app.sprig.com/connect){:target="_blank"}. Use the Development Environment ID for a testing environment, and the Production Environment ID for your live website environment. When you configure the destination, input the appropriate Environment ID. +6. Select **Quick Setup** to start with pre-populated subscriptions, or **Customized Setup** to configure each action from scratch. Click **Configure Actions** to complete setup. + + + +{% include components/actions-fields.html %} + + +## Migration from the classic Sprig destination + +To prevent duplicate events being created in Sprig, ensure that for each Segment source, this destination and the Sprig Cloud destination are not both enabled at the same time. + +