diff --git a/src/_data/catalog/destination_categories.yml b/src/_data/catalog/destination_categories.yml index 0735e55a5d..6969b60aed 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 2025-10-09 +# destination categories last updated 2025-10-16 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 2902261e3e..0f8740abb7 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 2025-10-09 +# destination data last updated 2025-10-16 items: - id: 637e8d185e2dec264895ea89 display_name: 1Flow @@ -7678,2302 +7678,6 @@ items: allowNull: false presets: [] partnerOwned: false -- id: 683ef14a3f9aac157e3a3446 - display_name: Amazon Conversions Api - name: Amazon Conversions Api - slug: amazon-conversions-api - hidden: false - endpoints: - - US - regions: - - us-west-2 - - eu-west-1 - url: connections/destinations/catalog/amazon-conversions-api - previous_names: - - Amazon Conversions Api - website: https://advertising.amazon.com/help/GEDE65PCE2CL5P63 - status: PUBLIC_BETA - categories: - - Advertising - - Attribution - logo: - url: https://cdn-devcenter.segment.com/a4e77672-0b0c-4c68-b522-bbd6f83d33b5.svg - mark: - url: https://cdn-devcenter.segment.com/51ad439c-55ca-4bc7-97f4-3cd896f24766.svg - methods: - track: true - identify: true - group: true - alias: true - screen: false - page: true - platforms: - browser: true - mobile: false - server: true - warehouse: true - cloudAppObject: false - linkedAudiences: true - components: [] - browserUnbundlingSupported: false - browserUnbundlingPublic: false - replay: false - connection_modes: - device: - web: false - mobile: false - server: false - cloud: - web: true - mobile: false - server: true - settings: - - name: advertiserId - type: string - defaultValue: '' - description: Your Amazon Advertiser Account ID. - required: true - label: Amazon Advertiser ID - - name: region - type: select - defaultValue: https://advertising-api.amazon.com - description: Region for API Endpoint, either NA, EU, FE. - required: true - label: Region - actions: - - id: 3PXoEXmHMzVcnY5RaMTcQp - name: Track Conversion - slug: trackConversion - description: Send conversion event data to Amazon Events API - platform: CLOUD - hidden: false - defaultTrigger: type = "track" - fields: - - id: qgPBt4VU1i9xAd7B9VeAtF - sortOrder: 0 - fieldKey: name - label: Event Name - type: STRING - description: The name of the imported event. - placeholder: '' - defaultValue: - '@path': $.event - required: true - multiple: false - choices: null - dynamic: false - allowNull: false - - id: hqKYNYP77wh4xNjxN2VzJa - sortOrder: 1 - fieldKey: eventType - label: Event Type - type: STRING - description: The standard Amazon event type. - placeholder: '' - required: true - multiple: false - choices: - - label: Add to Shopping Cart - value: ADD_TO_SHOPPING_CART - - label: Application - value: APPLICATION - - label: Checkout - value: CHECKOUT - - label: Contact - value: CONTACT - - label: Lead - value: LEAD - - label: Off Amazon Purchases - value: OFF_AMAZON_PURCHASES - - label: Mobile App First Start - value: MOBILE_APP_FIRST_START - - label: Page View - value: PAGE_VIEW - - label: Search - value: SEARCH - - label: Sign Up - value: SIGN_UP - - label: Subscribe - value: SUBSCRIBE - - label: Other - value: OTHER - dynamic: false - allowNull: false - - id: kWXzbjoTkpx4aWmfePffqR - sortOrder: 2 - fieldKey: eventActionSource - label: Event Action Source - type: STRING - description: >- - The platform from which the event was sourced. If no value is provided, - then website is used as default. - placeholder: '' - defaultValue: - '@if': - exists: - '@path': $.context.device.type - then: - '@path': $.context.device.type - else: website - required: true - multiple: false - choices: - - label: Android - value: android - - label: Fire TV - value: fire_tv - - label: iOS - value: ios - - label: Offline - value: offline - - label: Website - value: website - dynamic: false - allowNull: false - - id: 6ZXd93NwZbHq1HWx8Dy4R9 - sortOrder: 3 - fieldKey: countryCode - label: Country Code - type: STRING - description: >- - ISO 3166-1 alpha-2 country code. e.g., US, GB. Also accepts locale - codes. e.g en-US, en-GB. - placeholder: '' - defaultValue: - '@path': $.context.locale - required: true - multiple: false - choices: null - dynamic: false - allowNull: false - - id: qEbRQtxiwE6UXgVqgew7gu - sortOrder: 4 - fieldKey: timestamp - label: Event Timestamp - type: STRING - description: >- - The reported timestamp of when the event occurred in ISO format - (YYYY-MM-DDThh:mm:ssTZD). - placeholder: '' - defaultValue: - '@path': $.timestamp - required: true - multiple: false - choices: null - dynamic: false - allowNull: false - - id: rMe47AeWoAE33izcVbNMGX - sortOrder: 5 - fieldKey: value - label: Value - type: NUMBER - description: The value of the event. - placeholder: '' - defaultValue: - '@path': $.properties.value - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: pFA5UVqRSZ8MF6WTEcYsH2 - sortOrder: 6 - fieldKey: currencyCode - label: Currency Code - type: STRING - description: >- - The currencyCode associated with the 'value' of the event in ISO-4217 - format. Only applicable for OFF_AMAZON_PURCHASES event type. - placeholder: '' - defaultValue: - '@path': $.properties.currency - required: false - multiple: false - choices: - - label: AED - UAE Dirham - value: AED - - label: AUD - Australian Dollar - value: AUD - - label: BRL - Brazilian Real - value: BRL - - label: CAD - Canadian Dollar - value: CAD - - label: CNY - Chinese Yuan - value: CNY - - label: EUR - Euro - value: EUR - - label: GBP - British Pound - value: GBP - - label: INR - Indian Rupee - value: INR - - label: JPY - Japanese Yen - value: JPY - - label: MXN - Mexican Peso - value: MXN - - label: SAR - Saudi Riyal - value: SAR - - label: SEK - Swedish Krona - value: SEK - - label: SGD - Singapore Dollar - value: SGD - - label: TRY - Turkish Lira - value: TRY - - label: USD - US Dollar - value: USD - - label: DKK - Danish Krone - value: DKK - - label: NOK - Norwegian Krone - value: NOK - - label: NZD - New Zealand Dollar - value: NZD - dynamic: false - allowNull: false - - id: gPjsuc6hZv3Ao8BPPVF1HT - sortOrder: 7 - fieldKey: unitsSold - label: Units Sold - type: INTEGER - description: >- - The number of items purchased. Only applicable for OFF_AMAZON_PURCHASES - event type. If not provided on the event, a default of 1 will be - applied. - placeholder: '' - defaultValue: - '@path': $.properties.quantity - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: pKg4gSsqnBn9GX8PsEk5qv - sortOrder: 8 - fieldKey: clientDedupeId - label: Client Dedupe ID - type: STRING - description: >- - Amazon Conversions API uses the `clientDedupeId` field to prevent - duplicate events. By default, Segment maps the messageId to this field. - For events with the same clientDedupeId, only the latest event will be - processed. Please be advised that deduplication occurs across all event - types, rather than being limited to individual event types. - placeholder: '' - defaultValue: - '@path': $.messageId - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: rGnUAdVa6EL8GcZSw4T7Re - sortOrder: 9 - fieldKey: matchKeys - label: Match Keys - type: OBJECT - description: >- - Match keys are used to identify the customer associated with the event - for attribution. At least one match key must be provided. - placeholder: '' - defaultValue: - email: - '@if': - exists: - '@path': $.context.traits.email - then: - '@path': $.context.traits.email - else: - '@path': $.properties.email - phone: - '@if': - exists: - '@path': $.context.traits.phone - then: - '@path': $.context.traits.phone - else: - '@path': $.properties.phone - firstName: - '@if': - exists: - '@path': $.context.traits.firstName - then: - '@path': $.context.traits.firstName - else: - '@path': $.properties.firstName - lastName: - '@if': - exists: - '@path': $.context.traits.lastName - then: - '@path': $.context.traits.lastName - else: - '@path': $.properties.lastName - address: - '@if': - exists: - '@path': $.context.traits.street - then: - '@path': $.context.traits.street - else: - '@path': $.properties.street - city: - '@if': - exists: - '@path': $.context.traits.city - then: - '@path': $.context.traits.city - else: - '@path': $.properties.city - state: - '@if': - exists: - '@path': $.context.traits.state - then: - '@path': $.context.traits.state - else: - '@path': $.properties.state - postalCode: - '@if': - exists: - '@path': $.context.traits.postalCode - then: - '@path': $.context.traits.postalCode - else: - '@path': $.properties.postalCode - maid: - '@path': context.device.advertisingId - rampId: - '@if': - exists: - '@path': $.context.traits.rampId - then: - '@path': $.context.traits.rampId - else: - '@path': $.properties.rampId - matchId: - '@if': - exists: - '@path': $.context.traits.matchId - then: - '@path': $.context.traits.matchId - else: - '@path': $.properties.matchId - required: true - multiple: false - choices: null - dynamic: false - allowNull: false - - id: csMgVG3qpFU5cS3c4Gzf1k - sortOrder: 10 - fieldKey: dataProcessingOptions - label: Data Processing Options - type: STRING - description: >- - A list of flags for signaling how an event shall be processed. Events - marked for limited data use will not be processed. - placeholder: '' - defaultValue: - '@path': $.properties.dataProcessingOptions - required: false - multiple: true - choices: - - label: Limited Data Use - value: LIMITED_DATA_USE - dynamic: false - allowNull: false - - id: 7RekLhoew8JipZEbxxMJgb - sortOrder: 11 - fieldKey: consent - label: Consent - type: OBJECT - description: >- - Describes consent given by the user for advertising purposes. For EU - advertisers, it is required to provide one of Geo ipAddress, - amazonConsent, tcf, or gpp. - placeholder: '' - defaultValue: - ipAddress: - '@path': $.context.ip - amznAdStorage: - '@path': $.properties.amznAdStorage - amznUserData: - '@path': $.properties.amznUserData - tcf: - '@path': $.properties.tcf - gpp: - '@path': $.properties.gpp - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: 2xTkY2f7p33a19dTA8Ly8i - sortOrder: 12 - fieldKey: customAttributes - label: Custom Attributes - type: OBJECT - description: >- - Custom attributes associated with the event to provide additional - context. Note that only brand, category, productId and attr1 - attr10 - custom attributes are used for reporting. - placeholder: '' - defaultValue: - brand: - '@path': $.properties.brand - category: - '@path': $.properties.category - productId: - '@path': $.properties.productId - attr1: - '@path': $.properties.attr1 - attr2: - '@path': $.properties.attr2 - attr3: - '@path': $.properties.attr3 - attr4: - '@path': $.properties.attr4 - attr5: - '@path': $.properties.attr5 - attr6: - '@path': $.properties.attr6 - attr7: - '@path': $.properties.attr7 - attr8: - '@path': $.properties.attr8 - attr9: - '@path': $.properties.attr9 - attr10: - '@path': $.properties.attr10 - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: 29gVGBzJAjVHfNx6XYWAVY - sortOrder: 13 - fieldKey: enable_batching - label: Enable Batching - type: BOOLEAN - description: When enabled, Segment will send data in batching. - placeholder: '' - defaultValue: true - required: true - multiple: false - choices: null - dynamic: false - allowNull: false - presets: - - actionId: 3PXoEXmHMzVcnY5RaMTcQp - name: Sign Up - fields: - name: - '@path': $.event - eventActionSource: - '@if': - exists: - '@path': $.context.device.type - then: - '@path': $.context.device.type - else: website - countryCode: - '@path': $.context.locale - timestamp: - '@path': $.timestamp - value: - '@path': $.properties.value - currencyCode: - '@path': $.properties.currency - unitsSold: - '@path': $.properties.quantity - clientDedupeId: - '@path': $.messageId - matchKeys: - email: - '@if': - exists: - '@path': $.context.traits.email - then: - '@path': $.context.traits.email - else: - '@path': $.properties.email - phone: - '@if': - exists: - '@path': $.context.traits.phone - then: - '@path': $.context.traits.phone - else: - '@path': $.properties.phone - firstName: - '@if': - exists: - '@path': $.context.traits.firstName - then: - '@path': $.context.traits.firstName - else: - '@path': $.properties.firstName - lastName: - '@if': - exists: - '@path': $.context.traits.lastName - then: - '@path': $.context.traits.lastName - else: - '@path': $.properties.lastName - address: - '@if': - exists: - '@path': $.context.traits.street - then: - '@path': $.context.traits.street - else: - '@path': $.properties.street - city: - '@if': - exists: - '@path': $.context.traits.city - then: - '@path': $.context.traits.city - else: - '@path': $.properties.city - state: - '@if': - exists: - '@path': $.context.traits.state - then: - '@path': $.context.traits.state - else: - '@path': $.properties.state - postalCode: - '@if': - exists: - '@path': $.context.traits.postalCode - then: - '@path': $.context.traits.postalCode - else: - '@path': $.properties.postalCode - maid: - '@path': context.device.advertisingId - rampId: - '@if': - exists: - '@path': $.context.traits.rampId - then: - '@path': $.context.traits.rampId - else: - '@path': $.properties.rampId - matchId: - '@if': - exists: - '@path': $.context.traits.matchId - then: - '@path': $.context.traits.matchId - else: - '@path': $.properties.matchId - dataProcessingOptions: - '@path': $.properties.dataProcessingOptions - consent: - ipAddress: - '@path': $.context.ip - amznAdStorage: - '@path': $.properties.amznAdStorage - amznUserData: - '@path': $.properties.amznUserData - tcf: - '@path': $.properties.tcf - gpp: - '@path': $.properties.gpp - customAttributes: - brand: - '@path': $.properties.brand - category: - '@path': $.properties.category - productId: - '@path': $.properties.productId - attr1: - '@path': $.properties.attr1 - attr2: - '@path': $.properties.attr2 - attr3: - '@path': $.properties.attr3 - attr4: - '@path': $.properties.attr4 - attr5: - '@path': $.properties.attr5 - attr6: - '@path': $.properties.attr6 - attr7: - '@path': $.properties.attr7 - attr8: - '@path': $.properties.attr8 - attr9: - '@path': $.properties.attr9 - attr10: - '@path': $.properties.attr10 - enable_batching: true - batch_size: 500 - eventType: SIGN_UP - trigger: type = "track" AND event = "Signed Up" - - actionId: 3PXoEXmHMzVcnY5RaMTcQp - name: Subscribe - fields: - name: - '@path': $.event - eventActionSource: - '@if': - exists: - '@path': $.context.device.type - then: - '@path': $.context.device.type - else: website - countryCode: - '@path': $.context.locale - timestamp: - '@path': $.timestamp - value: - '@path': $.properties.value - currencyCode: - '@path': $.properties.currency - unitsSold: - '@path': $.properties.quantity - clientDedupeId: - '@path': $.messageId - matchKeys: - email: - '@if': - exists: - '@path': $.context.traits.email - then: - '@path': $.context.traits.email - else: - '@path': $.properties.email - phone: - '@if': - exists: - '@path': $.context.traits.phone - then: - '@path': $.context.traits.phone - else: - '@path': $.properties.phone - firstName: - '@if': - exists: - '@path': $.context.traits.firstName - then: - '@path': $.context.traits.firstName - else: - '@path': $.properties.firstName - lastName: - '@if': - exists: - '@path': $.context.traits.lastName - then: - '@path': $.context.traits.lastName - else: - '@path': $.properties.lastName - address: - '@if': - exists: - '@path': $.context.traits.street - then: - '@path': $.context.traits.street - else: - '@path': $.properties.street - city: - '@if': - exists: - '@path': $.context.traits.city - then: - '@path': $.context.traits.city - else: - '@path': $.properties.city - state: - '@if': - exists: - '@path': $.context.traits.state - then: - '@path': $.context.traits.state - else: - '@path': $.properties.state - postalCode: - '@if': - exists: - '@path': $.context.traits.postalCode - then: - '@path': $.context.traits.postalCode - else: - '@path': $.properties.postalCode - maid: - '@path': context.device.advertisingId - rampId: - '@if': - exists: - '@path': $.context.traits.rampId - then: - '@path': $.context.traits.rampId - else: - '@path': $.properties.rampId - matchId: - '@if': - exists: - '@path': $.context.traits.matchId - then: - '@path': $.context.traits.matchId - else: - '@path': $.properties.matchId - dataProcessingOptions: - '@path': $.properties.dataProcessingOptions - consent: - ipAddress: - '@path': $.context.ip - amznAdStorage: - '@path': $.properties.amznAdStorage - amznUserData: - '@path': $.properties.amznUserData - tcf: - '@path': $.properties.tcf - gpp: - '@path': $.properties.gpp - customAttributes: - brand: - '@path': $.properties.brand - category: - '@path': $.properties.category - productId: - '@path': $.properties.productId - attr1: - '@path': $.properties.attr1 - attr2: - '@path': $.properties.attr2 - attr3: - '@path': $.properties.attr3 - attr4: - '@path': $.properties.attr4 - attr5: - '@path': $.properties.attr5 - attr6: - '@path': $.properties.attr6 - attr7: - '@path': $.properties.attr7 - attr8: - '@path': $.properties.attr8 - attr9: - '@path': $.properties.attr9 - attr10: - '@path': $.properties.attr10 - enable_batching: true - batch_size: 500 - eventType: SUBSCRIBE - trigger: type = "track" AND event = "Subscription Created" - - actionId: 3PXoEXmHMzVcnY5RaMTcQp - name: Off Amazon Purchases - fields: - name: - '@path': $.event - eventActionSource: - '@if': - exists: - '@path': $.context.device.type - then: - '@path': $.context.device.type - else: website - countryCode: - '@path': $.context.locale - timestamp: - '@path': $.timestamp - value: - '@path': $.properties.value - currencyCode: - '@path': $.properties.currency - unitsSold: - '@path': $.properties.quantity - clientDedupeId: - '@path': $.messageId - matchKeys: - email: - '@if': - exists: - '@path': $.context.traits.email - then: - '@path': $.context.traits.email - else: - '@path': $.properties.email - phone: - '@if': - exists: - '@path': $.context.traits.phone - then: - '@path': $.context.traits.phone - else: - '@path': $.properties.phone - firstName: - '@if': - exists: - '@path': $.context.traits.firstName - then: - '@path': $.context.traits.firstName - else: - '@path': $.properties.firstName - lastName: - '@if': - exists: - '@path': $.context.traits.lastName - then: - '@path': $.context.traits.lastName - else: - '@path': $.properties.lastName - address: - '@if': - exists: - '@path': $.context.traits.street - then: - '@path': $.context.traits.street - else: - '@path': $.properties.street - city: - '@if': - exists: - '@path': $.context.traits.city - then: - '@path': $.context.traits.city - else: - '@path': $.properties.city - state: - '@if': - exists: - '@path': $.context.traits.state - then: - '@path': $.context.traits.state - else: - '@path': $.properties.state - postalCode: - '@if': - exists: - '@path': $.context.traits.postalCode - then: - '@path': $.context.traits.postalCode - else: - '@path': $.properties.postalCode - maid: - '@path': context.device.advertisingId - rampId: - '@if': - exists: - '@path': $.context.traits.rampId - then: - '@path': $.context.traits.rampId - else: - '@path': $.properties.rampId - matchId: - '@if': - exists: - '@path': $.context.traits.matchId - then: - '@path': $.context.traits.matchId - else: - '@path': $.properties.matchId - dataProcessingOptions: - '@path': $.properties.dataProcessingOptions - consent: - ipAddress: - '@path': $.context.ip - amznAdStorage: - '@path': $.properties.amznAdStorage - amznUserData: - '@path': $.properties.amznUserData - tcf: - '@path': $.properties.tcf - gpp: - '@path': $.properties.gpp - customAttributes: - brand: - '@path': $.properties.brand - category: - '@path': $.properties.category - productId: - '@path': $.properties.productId - attr1: - '@path': $.properties.attr1 - attr2: - '@path': $.properties.attr2 - attr3: - '@path': $.properties.attr3 - attr4: - '@path': $.properties.attr4 - attr5: - '@path': $.properties.attr5 - attr6: - '@path': $.properties.attr6 - attr7: - '@path': $.properties.attr7 - attr8: - '@path': $.properties.attr8 - attr9: - '@path': $.properties.attr9 - attr10: - '@path': $.properties.attr10 - enable_batching: true - batch_size: 500 - eventType: OFF_AMAZON_PURCHASES - trigger: type = "track" AND event = "Order Completed" - - actionId: 3PXoEXmHMzVcnY5RaMTcQp - name: Page View - fields: - name: - '@path': $.event - eventActionSource: - '@if': - exists: - '@path': $.context.device.type - then: - '@path': $.context.device.type - else: website - countryCode: - '@path': $.context.locale - timestamp: - '@path': $.timestamp - value: - '@path': $.properties.value - currencyCode: - '@path': $.properties.currency - unitsSold: - '@path': $.properties.quantity - clientDedupeId: - '@path': $.messageId - matchKeys: - email: - '@if': - exists: - '@path': $.context.traits.email - then: - '@path': $.context.traits.email - else: - '@path': $.properties.email - phone: - '@if': - exists: - '@path': $.context.traits.phone - then: - '@path': $.context.traits.phone - else: - '@path': $.properties.phone - firstName: - '@if': - exists: - '@path': $.context.traits.firstName - then: - '@path': $.context.traits.firstName - else: - '@path': $.properties.firstName - lastName: - '@if': - exists: - '@path': $.context.traits.lastName - then: - '@path': $.context.traits.lastName - else: - '@path': $.properties.lastName - address: - '@if': - exists: - '@path': $.context.traits.street - then: - '@path': $.context.traits.street - else: - '@path': $.properties.street - city: - '@if': - exists: - '@path': $.context.traits.city - then: - '@path': $.context.traits.city - else: - '@path': $.properties.city - state: - '@if': - exists: - '@path': $.context.traits.state - then: - '@path': $.context.traits.state - else: - '@path': $.properties.state - postalCode: - '@if': - exists: - '@path': $.context.traits.postalCode - then: - '@path': $.context.traits.postalCode - else: - '@path': $.properties.postalCode - maid: - '@path': context.device.advertisingId - rampId: - '@if': - exists: - '@path': $.context.traits.rampId - then: - '@path': $.context.traits.rampId - else: - '@path': $.properties.rampId - matchId: - '@if': - exists: - '@path': $.context.traits.matchId - then: - '@path': $.context.traits.matchId - else: - '@path': $.properties.matchId - dataProcessingOptions: - '@path': $.properties.dataProcessingOptions - consent: - ipAddress: - '@path': $.context.ip - amznAdStorage: - '@path': $.properties.amznAdStorage - amznUserData: - '@path': $.properties.amznUserData - tcf: - '@path': $.properties.tcf - gpp: - '@path': $.properties.gpp - customAttributes: - brand: - '@path': $.properties.brand - category: - '@path': $.properties.category - productId: - '@path': $.properties.productId - attr1: - '@path': $.properties.attr1 - attr2: - '@path': $.properties.attr2 - attr3: - '@path': $.properties.attr3 - attr4: - '@path': $.properties.attr4 - attr5: - '@path': $.properties.attr5 - attr6: - '@path': $.properties.attr6 - attr7: - '@path': $.properties.attr7 - attr8: - '@path': $.properties.attr8 - attr9: - '@path': $.properties.attr9 - attr10: - '@path': $.properties.attr10 - enable_batching: true - batch_size: 500 - eventType: PAGE_VIEW - trigger: type = "page" - - actionId: 3PXoEXmHMzVcnY5RaMTcQp - name: Other - fields: - name: - '@path': $.event - eventActionSource: - '@if': - exists: - '@path': $.context.device.type - then: - '@path': $.context.device.type - else: website - countryCode: - '@path': $.context.locale - timestamp: - '@path': $.timestamp - value: - '@path': $.properties.value - currencyCode: - '@path': $.properties.currency - unitsSold: - '@path': $.properties.quantity - clientDedupeId: - '@path': $.messageId - matchKeys: - email: - '@if': - exists: - '@path': $.context.traits.email - then: - '@path': $.context.traits.email - else: - '@path': $.properties.email - phone: - '@if': - exists: - '@path': $.context.traits.phone - then: - '@path': $.context.traits.phone - else: - '@path': $.properties.phone - firstName: - '@if': - exists: - '@path': $.context.traits.firstName - then: - '@path': $.context.traits.firstName - else: - '@path': $.properties.firstName - lastName: - '@if': - exists: - '@path': $.context.traits.lastName - then: - '@path': $.context.traits.lastName - else: - '@path': $.properties.lastName - address: - '@if': - exists: - '@path': $.context.traits.street - then: - '@path': $.context.traits.street - else: - '@path': $.properties.street - city: - '@if': - exists: - '@path': $.context.traits.city - then: - '@path': $.context.traits.city - else: - '@path': $.properties.city - state: - '@if': - exists: - '@path': $.context.traits.state - then: - '@path': $.context.traits.state - else: - '@path': $.properties.state - postalCode: - '@if': - exists: - '@path': $.context.traits.postalCode - then: - '@path': $.context.traits.postalCode - else: - '@path': $.properties.postalCode - maid: - '@path': context.device.advertisingId - rampId: - '@if': - exists: - '@path': $.context.traits.rampId - then: - '@path': $.context.traits.rampId - else: - '@path': $.properties.rampId - matchId: - '@if': - exists: - '@path': $.context.traits.matchId - then: - '@path': $.context.traits.matchId - else: - '@path': $.properties.matchId - dataProcessingOptions: - '@path': $.properties.dataProcessingOptions - consent: - ipAddress: - '@path': $.context.ip - amznAdStorage: - '@path': $.properties.amznAdStorage - amznUserData: - '@path': $.properties.amznUserData - tcf: - '@path': $.properties.tcf - gpp: - '@path': $.properties.gpp - customAttributes: - brand: - '@path': $.properties.brand - category: - '@path': $.properties.category - productId: - '@path': $.properties.productId - attr1: - '@path': $.properties.attr1 - attr2: - '@path': $.properties.attr2 - attr3: - '@path': $.properties.attr3 - attr4: - '@path': $.properties.attr4 - attr5: - '@path': $.properties.attr5 - attr6: - '@path': $.properties.attr6 - attr7: - '@path': $.properties.attr7 - attr8: - '@path': $.properties.attr8 - attr9: - '@path': $.properties.attr9 - attr10: - '@path': $.properties.attr10 - enable_batching: true - batch_size: 500 - eventType: OTHER - trigger: type = "track" AND event = "Other" - - actionId: 3PXoEXmHMzVcnY5RaMTcQp - name: Checkout - fields: - name: - '@path': $.event - eventActionSource: - '@if': - exists: - '@path': $.context.device.type - then: - '@path': $.context.device.type - else: website - countryCode: - '@path': $.context.locale - timestamp: - '@path': $.timestamp - value: - '@path': $.properties.value - currencyCode: - '@path': $.properties.currency - unitsSold: - '@path': $.properties.quantity - clientDedupeId: - '@path': $.messageId - matchKeys: - email: - '@if': - exists: - '@path': $.context.traits.email - then: - '@path': $.context.traits.email - else: - '@path': $.properties.email - phone: - '@if': - exists: - '@path': $.context.traits.phone - then: - '@path': $.context.traits.phone - else: - '@path': $.properties.phone - firstName: - '@if': - exists: - '@path': $.context.traits.firstName - then: - '@path': $.context.traits.firstName - else: - '@path': $.properties.firstName - lastName: - '@if': - exists: - '@path': $.context.traits.lastName - then: - '@path': $.context.traits.lastName - else: - '@path': $.properties.lastName - address: - '@if': - exists: - '@path': $.context.traits.street - then: - '@path': $.context.traits.street - else: - '@path': $.properties.street - city: - '@if': - exists: - '@path': $.context.traits.city - then: - '@path': $.context.traits.city - else: - '@path': $.properties.city - state: - '@if': - exists: - '@path': $.context.traits.state - then: - '@path': $.context.traits.state - else: - '@path': $.properties.state - postalCode: - '@if': - exists: - '@path': $.context.traits.postalCode - then: - '@path': $.context.traits.postalCode - else: - '@path': $.properties.postalCode - maid: - '@path': context.device.advertisingId - rampId: - '@if': - exists: - '@path': $.context.traits.rampId - then: - '@path': $.context.traits.rampId - else: - '@path': $.properties.rampId - matchId: - '@if': - exists: - '@path': $.context.traits.matchId - then: - '@path': $.context.traits.matchId - else: - '@path': $.properties.matchId - dataProcessingOptions: - '@path': $.properties.dataProcessingOptions - consent: - ipAddress: - '@path': $.context.ip - amznAdStorage: - '@path': $.properties.amznAdStorage - amznUserData: - '@path': $.properties.amznUserData - tcf: - '@path': $.properties.tcf - gpp: - '@path': $.properties.gpp - customAttributes: - brand: - '@path': $.properties.brand - category: - '@path': $.properties.category - productId: - '@path': $.properties.productId - attr1: - '@path': $.properties.attr1 - attr2: - '@path': $.properties.attr2 - attr3: - '@path': $.properties.attr3 - attr4: - '@path': $.properties.attr4 - attr5: - '@path': $.properties.attr5 - attr6: - '@path': $.properties.attr6 - attr7: - '@path': $.properties.attr7 - attr8: - '@path': $.properties.attr8 - attr9: - '@path': $.properties.attr9 - attr10: - '@path': $.properties.attr10 - enable_batching: true - batch_size: 500 - eventType: CHECKOUT - trigger: type = "track" AND event = "Checkout Started" - - actionId: 3PXoEXmHMzVcnY5RaMTcQp - name: Add to Shopping Cart - fields: - name: - '@path': $.event - eventActionSource: - '@if': - exists: - '@path': $.context.device.type - then: - '@path': $.context.device.type - else: website - countryCode: - '@path': $.context.locale - timestamp: - '@path': $.timestamp - value: - '@path': $.properties.value - currencyCode: - '@path': $.properties.currency - unitsSold: - '@path': $.properties.quantity - clientDedupeId: - '@path': $.messageId - matchKeys: - email: - '@if': - exists: - '@path': $.context.traits.email - then: - '@path': $.context.traits.email - else: - '@path': $.properties.email - phone: - '@if': - exists: - '@path': $.context.traits.phone - then: - '@path': $.context.traits.phone - else: - '@path': $.properties.phone - firstName: - '@if': - exists: - '@path': $.context.traits.firstName - then: - '@path': $.context.traits.firstName - else: - '@path': $.properties.firstName - lastName: - '@if': - exists: - '@path': $.context.traits.lastName - then: - '@path': $.context.traits.lastName - else: - '@path': $.properties.lastName - address: - '@if': - exists: - '@path': $.context.traits.street - then: - '@path': $.context.traits.street - else: - '@path': $.properties.street - city: - '@if': - exists: - '@path': $.context.traits.city - then: - '@path': $.context.traits.city - else: - '@path': $.properties.city - state: - '@if': - exists: - '@path': $.context.traits.state - then: - '@path': $.context.traits.state - else: - '@path': $.properties.state - postalCode: - '@if': - exists: - '@path': $.context.traits.postalCode - then: - '@path': $.context.traits.postalCode - else: - '@path': $.properties.postalCode - maid: - '@path': context.device.advertisingId - rampId: - '@if': - exists: - '@path': $.context.traits.rampId - then: - '@path': $.context.traits.rampId - else: - '@path': $.properties.rampId - matchId: - '@if': - exists: - '@path': $.context.traits.matchId - then: - '@path': $.context.traits.matchId - else: - '@path': $.properties.matchId - dataProcessingOptions: - '@path': $.properties.dataProcessingOptions - consent: - ipAddress: - '@path': $.context.ip - amznAdStorage: - '@path': $.properties.amznAdStorage - amznUserData: - '@path': $.properties.amznUserData - tcf: - '@path': $.properties.tcf - gpp: - '@path': $.properties.gpp - customAttributes: - brand: - '@path': $.properties.brand - category: - '@path': $.properties.category - productId: - '@path': $.properties.productId - attr1: - '@path': $.properties.attr1 - attr2: - '@path': $.properties.attr2 - attr3: - '@path': $.properties.attr3 - attr4: - '@path': $.properties.attr4 - attr5: - '@path': $.properties.attr5 - attr6: - '@path': $.properties.attr6 - attr7: - '@path': $.properties.attr7 - attr8: - '@path': $.properties.attr8 - attr9: - '@path': $.properties.attr9 - attr10: - '@path': $.properties.attr10 - enable_batching: true - batch_size: 500 - eventType: ADD_TO_SHOPPING_CART - trigger: type = "track" AND event = "Product Added" - - actionId: 3PXoEXmHMzVcnY5RaMTcQp - name: Mobile App First Start - fields: - name: - '@path': $.event - eventActionSource: - '@if': - exists: - '@path': $.context.device.type - then: - '@path': $.context.device.type - else: website - countryCode: - '@path': $.context.locale - timestamp: - '@path': $.timestamp - value: - '@path': $.properties.value - currencyCode: - '@path': $.properties.currency - unitsSold: - '@path': $.properties.quantity - clientDedupeId: - '@path': $.messageId - matchKeys: - email: - '@if': - exists: - '@path': $.context.traits.email - then: - '@path': $.context.traits.email - else: - '@path': $.properties.email - phone: - '@if': - exists: - '@path': $.context.traits.phone - then: - '@path': $.context.traits.phone - else: - '@path': $.properties.phone - firstName: - '@if': - exists: - '@path': $.context.traits.firstName - then: - '@path': $.context.traits.firstName - else: - '@path': $.properties.firstName - lastName: - '@if': - exists: - '@path': $.context.traits.lastName - then: - '@path': $.context.traits.lastName - else: - '@path': $.properties.lastName - address: - '@if': - exists: - '@path': $.context.traits.street - then: - '@path': $.context.traits.street - else: - '@path': $.properties.street - city: - '@if': - exists: - '@path': $.context.traits.city - then: - '@path': $.context.traits.city - else: - '@path': $.properties.city - state: - '@if': - exists: - '@path': $.context.traits.state - then: - '@path': $.context.traits.state - else: - '@path': $.properties.state - postalCode: - '@if': - exists: - '@path': $.context.traits.postalCode - then: - '@path': $.context.traits.postalCode - else: - '@path': $.properties.postalCode - maid: - '@path': context.device.advertisingId - rampId: - '@if': - exists: - '@path': $.context.traits.rampId - then: - '@path': $.context.traits.rampId - else: - '@path': $.properties.rampId - matchId: - '@if': - exists: - '@path': $.context.traits.matchId - then: - '@path': $.context.traits.matchId - else: - '@path': $.properties.matchId - dataProcessingOptions: - '@path': $.properties.dataProcessingOptions - consent: - ipAddress: - '@path': $.context.ip - amznAdStorage: - '@path': $.properties.amznAdStorage - amznUserData: - '@path': $.properties.amznUserData - tcf: - '@path': $.properties.tcf - gpp: - '@path': $.properties.gpp - customAttributes: - brand: - '@path': $.properties.brand - category: - '@path': $.properties.category - productId: - '@path': $.properties.productId - attr1: - '@path': $.properties.attr1 - attr2: - '@path': $.properties.attr2 - attr3: - '@path': $.properties.attr3 - attr4: - '@path': $.properties.attr4 - attr5: - '@path': $.properties.attr5 - attr6: - '@path': $.properties.attr6 - attr7: - '@path': $.properties.attr7 - attr8: - '@path': $.properties.attr8 - attr9: - '@path': $.properties.attr9 - attr10: - '@path': $.properties.attr10 - enable_batching: true - batch_size: 500 - eventType: MOBILE_APP_FIRST_START - trigger: type = "track" AND event = "Application Opened" - - actionId: 3PXoEXmHMzVcnY5RaMTcQp - name: Contact - fields: - name: - '@path': $.event - eventActionSource: - '@if': - exists: - '@path': $.context.device.type - then: - '@path': $.context.device.type - else: website - countryCode: - '@path': $.context.locale - timestamp: - '@path': $.timestamp - value: - '@path': $.properties.value - currencyCode: - '@path': $.properties.currency - unitsSold: - '@path': $.properties.quantity - clientDedupeId: - '@path': $.messageId - matchKeys: - email: - '@if': - exists: - '@path': $.context.traits.email - then: - '@path': $.context.traits.email - else: - '@path': $.properties.email - phone: - '@if': - exists: - '@path': $.context.traits.phone - then: - '@path': $.context.traits.phone - else: - '@path': $.properties.phone - firstName: - '@if': - exists: - '@path': $.context.traits.firstName - then: - '@path': $.context.traits.firstName - else: - '@path': $.properties.firstName - lastName: - '@if': - exists: - '@path': $.context.traits.lastName - then: - '@path': $.context.traits.lastName - else: - '@path': $.properties.lastName - address: - '@if': - exists: - '@path': $.context.traits.street - then: - '@path': $.context.traits.street - else: - '@path': $.properties.street - city: - '@if': - exists: - '@path': $.context.traits.city - then: - '@path': $.context.traits.city - else: - '@path': $.properties.city - state: - '@if': - exists: - '@path': $.context.traits.state - then: - '@path': $.context.traits.state - else: - '@path': $.properties.state - postalCode: - '@if': - exists: - '@path': $.context.traits.postalCode - then: - '@path': $.context.traits.postalCode - else: - '@path': $.properties.postalCode - maid: - '@path': context.device.advertisingId - rampId: - '@if': - exists: - '@path': $.context.traits.rampId - then: - '@path': $.context.traits.rampId - else: - '@path': $.properties.rampId - matchId: - '@if': - exists: - '@path': $.context.traits.matchId - then: - '@path': $.context.traits.matchId - else: - '@path': $.properties.matchId - dataProcessingOptions: - '@path': $.properties.dataProcessingOptions - consent: - ipAddress: - '@path': $.context.ip - amznAdStorage: - '@path': $.properties.amznAdStorage - amznUserData: - '@path': $.properties.amznUserData - tcf: - '@path': $.properties.tcf - gpp: - '@path': $.properties.gpp - customAttributes: - brand: - '@path': $.properties.brand - category: - '@path': $.properties.category - productId: - '@path': $.properties.productId - attr1: - '@path': $.properties.attr1 - attr2: - '@path': $.properties.attr2 - attr3: - '@path': $.properties.attr3 - attr4: - '@path': $.properties.attr4 - attr5: - '@path': $.properties.attr5 - attr6: - '@path': $.properties.attr6 - attr7: - '@path': $.properties.attr7 - attr8: - '@path': $.properties.attr8 - attr9: - '@path': $.properties.attr9 - attr10: - '@path': $.properties.attr10 - enable_batching: true - batch_size: 500 - eventType: CONTACT - trigger: type = "track" AND event = "Callback Started" - - actionId: 3PXoEXmHMzVcnY5RaMTcQp - name: Lead - fields: - name: - '@path': $.event - eventActionSource: - '@if': - exists: - '@path': $.context.device.type - then: - '@path': $.context.device.type - else: website - countryCode: - '@path': $.context.locale - timestamp: - '@path': $.timestamp - value: - '@path': $.properties.value - currencyCode: - '@path': $.properties.currency - unitsSold: - '@path': $.properties.quantity - clientDedupeId: - '@path': $.messageId - matchKeys: - email: - '@if': - exists: - '@path': $.context.traits.email - then: - '@path': $.context.traits.email - else: - '@path': $.properties.email - phone: - '@if': - exists: - '@path': $.context.traits.phone - then: - '@path': $.context.traits.phone - else: - '@path': $.properties.phone - firstName: - '@if': - exists: - '@path': $.context.traits.firstName - then: - '@path': $.context.traits.firstName - else: - '@path': $.properties.firstName - lastName: - '@if': - exists: - '@path': $.context.traits.lastName - then: - '@path': $.context.traits.lastName - else: - '@path': $.properties.lastName - address: - '@if': - exists: - '@path': $.context.traits.street - then: - '@path': $.context.traits.street - else: - '@path': $.properties.street - city: - '@if': - exists: - '@path': $.context.traits.city - then: - '@path': $.context.traits.city - else: - '@path': $.properties.city - state: - '@if': - exists: - '@path': $.context.traits.state - then: - '@path': $.context.traits.state - else: - '@path': $.properties.state - postalCode: - '@if': - exists: - '@path': $.context.traits.postalCode - then: - '@path': $.context.traits.postalCode - else: - '@path': $.properties.postalCode - maid: - '@path': context.device.advertisingId - rampId: - '@if': - exists: - '@path': $.context.traits.rampId - then: - '@path': $.context.traits.rampId - else: - '@path': $.properties.rampId - matchId: - '@if': - exists: - '@path': $.context.traits.matchId - then: - '@path': $.context.traits.matchId - else: - '@path': $.properties.matchId - dataProcessingOptions: - '@path': $.properties.dataProcessingOptions - consent: - ipAddress: - '@path': $.context.ip - amznAdStorage: - '@path': $.properties.amznAdStorage - amznUserData: - '@path': $.properties.amznUserData - tcf: - '@path': $.properties.tcf - gpp: - '@path': $.properties.gpp - customAttributes: - brand: - '@path': $.properties.brand - category: - '@path': $.properties.category - productId: - '@path': $.properties.productId - attr1: - '@path': $.properties.attr1 - attr2: - '@path': $.properties.attr2 - attr3: - '@path': $.properties.attr3 - attr4: - '@path': $.properties.attr4 - attr5: - '@path': $.properties.attr5 - attr6: - '@path': $.properties.attr6 - attr7: - '@path': $.properties.attr7 - attr8: - '@path': $.properties.attr8 - attr9: - '@path': $.properties.attr9 - attr10: - '@path': $.properties.attr10 - enable_batching: true - batch_size: 500 - eventType: LEAD - trigger: type = "track" AND event = "Lead Generated" - - actionId: 3PXoEXmHMzVcnY5RaMTcQp - name: Application - fields: - name: - '@path': $.event - eventActionSource: - '@if': - exists: - '@path': $.context.device.type - then: - '@path': $.context.device.type - else: website - countryCode: - '@path': $.context.locale - timestamp: - '@path': $.timestamp - value: - '@path': $.properties.value - currencyCode: - '@path': $.properties.currency - unitsSold: - '@path': $.properties.quantity - clientDedupeId: - '@path': $.messageId - matchKeys: - email: - '@if': - exists: - '@path': $.context.traits.email - then: - '@path': $.context.traits.email - else: - '@path': $.properties.email - phone: - '@if': - exists: - '@path': $.context.traits.phone - then: - '@path': $.context.traits.phone - else: - '@path': $.properties.phone - firstName: - '@if': - exists: - '@path': $.context.traits.firstName - then: - '@path': $.context.traits.firstName - else: - '@path': $.properties.firstName - lastName: - '@if': - exists: - '@path': $.context.traits.lastName - then: - '@path': $.context.traits.lastName - else: - '@path': $.properties.lastName - address: - '@if': - exists: - '@path': $.context.traits.street - then: - '@path': $.context.traits.street - else: - '@path': $.properties.street - city: - '@if': - exists: - '@path': $.context.traits.city - then: - '@path': $.context.traits.city - else: - '@path': $.properties.city - state: - '@if': - exists: - '@path': $.context.traits.state - then: - '@path': $.context.traits.state - else: - '@path': $.properties.state - postalCode: - '@if': - exists: - '@path': $.context.traits.postalCode - then: - '@path': $.context.traits.postalCode - else: - '@path': $.properties.postalCode - maid: - '@path': context.device.advertisingId - rampId: - '@if': - exists: - '@path': $.context.traits.rampId - then: - '@path': $.context.traits.rampId - else: - '@path': $.properties.rampId - matchId: - '@if': - exists: - '@path': $.context.traits.matchId - then: - '@path': $.context.traits.matchId - else: - '@path': $.properties.matchId - dataProcessingOptions: - '@path': $.properties.dataProcessingOptions - consent: - ipAddress: - '@path': $.context.ip - amznAdStorage: - '@path': $.properties.amznAdStorage - amznUserData: - '@path': $.properties.amznUserData - tcf: - '@path': $.properties.tcf - gpp: - '@path': $.properties.gpp - customAttributes: - brand: - '@path': $.properties.brand - category: - '@path': $.properties.category - productId: - '@path': $.properties.productId - attr1: - '@path': $.properties.attr1 - attr2: - '@path': $.properties.attr2 - attr3: - '@path': $.properties.attr3 - attr4: - '@path': $.properties.attr4 - attr5: - '@path': $.properties.attr5 - attr6: - '@path': $.properties.attr6 - attr7: - '@path': $.properties.attr7 - attr8: - '@path': $.properties.attr8 - attr9: - '@path': $.properties.attr9 - attr10: - '@path': $.properties.attr10 - enable_batching: true - batch_size: 500 - eventType: APPLICATION - trigger: type = "track" AND event = "Application Submitted" - - actionId: 3PXoEXmHMzVcnY5RaMTcQp - name: Search - fields: - name: - '@path': $.event - eventActionSource: - '@if': - exists: - '@path': $.context.device.type - then: - '@path': $.context.device.type - else: website - countryCode: - '@path': $.context.locale - timestamp: - '@path': $.timestamp - value: - '@path': $.properties.value - currencyCode: - '@path': $.properties.currency - unitsSold: - '@path': $.properties.quantity - clientDedupeId: - '@path': $.messageId - matchKeys: - email: - '@if': - exists: - '@path': $.context.traits.email - then: - '@path': $.context.traits.email - else: - '@path': $.properties.email - phone: - '@if': - exists: - '@path': $.context.traits.phone - then: - '@path': $.context.traits.phone - else: - '@path': $.properties.phone - firstName: - '@if': - exists: - '@path': $.context.traits.firstName - then: - '@path': $.context.traits.firstName - else: - '@path': $.properties.firstName - lastName: - '@if': - exists: - '@path': $.context.traits.lastName - then: - '@path': $.context.traits.lastName - else: - '@path': $.properties.lastName - address: - '@if': - exists: - '@path': $.context.traits.street - then: - '@path': $.context.traits.street - else: - '@path': $.properties.street - city: - '@if': - exists: - '@path': $.context.traits.city - then: - '@path': $.context.traits.city - else: - '@path': $.properties.city - state: - '@if': - exists: - '@path': $.context.traits.state - then: - '@path': $.context.traits.state - else: - '@path': $.properties.state - postalCode: - '@if': - exists: - '@path': $.context.traits.postalCode - then: - '@path': $.context.traits.postalCode - else: - '@path': $.properties.postalCode - maid: - '@path': context.device.advertisingId - rampId: - '@if': - exists: - '@path': $.context.traits.rampId - then: - '@path': $.context.traits.rampId - else: - '@path': $.properties.rampId - matchId: - '@if': - exists: - '@path': $.context.traits.matchId - then: - '@path': $.context.traits.matchId - else: - '@path': $.properties.matchId - dataProcessingOptions: - '@path': $.properties.dataProcessingOptions - consent: - ipAddress: - '@path': $.context.ip - amznAdStorage: - '@path': $.properties.amznAdStorage - amznUserData: - '@path': $.properties.amznUserData - tcf: - '@path': $.properties.tcf - gpp: - '@path': $.properties.gpp - customAttributes: - brand: - '@path': $.properties.brand - category: - '@path': $.properties.category - productId: - '@path': $.properties.productId - attr1: - '@path': $.properties.attr1 - attr2: - '@path': $.properties.attr2 - attr3: - '@path': $.properties.attr3 - attr4: - '@path': $.properties.attr4 - attr5: - '@path': $.properties.attr5 - attr6: - '@path': $.properties.attr6 - attr7: - '@path': $.properties.attr7 - attr8: - '@path': $.properties.attr8 - attr9: - '@path': $.properties.attr9 - attr10: - '@path': $.properties.attr10 - enable_batching: true - batch_size: 500 - eventType: SEARCH - trigger: type = "track" AND event = "Products Searched" - partnerOwned: true - id: 5d1994fb320116000112aa12 display_name: Amazon EventBridge name: Amazon EventBridge @@ -30815,7 +28519,7 @@ items: logo: url: https://cdn-devcenter.segment.com/9e709c23-539a-4c50-9a9a-3212e726baa1.svg mark: - url: https://cdn-devcenter.segment.com/887dae0e-f6a3-4f55-a5f1-157b65cccc20.svg + url: https://cdn-devcenter.segment.com/34845397-e130-4972-9990-29c37e66e48d.svg methods: track: true identify: true @@ -95208,6 +92912,406 @@ items: actions: [] presets: [] partnerOwned: false +- id: 66cc76e29693c9e5591bf029 + display_name: Nextdoor Conversions API + name: Nextdoor Conversions API + slug: nextdoor-conversions-api + hidden: false + endpoints: + - US + regions: + - us-west-2 + - eu-west-1 + url: connections/destinations/catalog/nextdoor-conversions-api + previous_names: + - Nextdoor Conversions API + website: https://nextdoor.com/ + status: PUBLIC_BETA + categories: + - Advertising + - Attribution + logo: + url: https://cdn-devcenter.segment.com/32c46ddc-fe44-4a08-b134-db4269ce8232.svg + mark: + url: https://cdn-devcenter.segment.com/58fca57c-8676-4e90-85b3-c0461a94a11d.svg + methods: + track: true + identify: true + group: true + alias: true + screen: false + page: true + platforms: + browser: true + mobile: false + server: true + warehouse: false + cloudAppObject: false + linkedAudiences: true + components: [] + browserUnbundlingSupported: false + browserUnbundlingPublic: false + replay: false + connection_modes: + device: + web: false + mobile: false + server: false + cloud: + web: true + mobile: false + server: true + settings: + - name: apiKey + type: password + defaultValue: '' + description: >- + The Embed API Key for your account. You can find this on your settings + pages. + required: true + label: API Key + - name: client_id + type: string + defaultValue: '' + description: >- + Your Nextdoor Advertiser ID for self serve clients can be found in your + NAM account for managed your support team can provide + required: true + label: Nextdoor Advertiser ID + - name: pixel_id + type: string + defaultValue: '' + description: >- + Nextdoor Pixel Id. Used for deduplication when events are sent via CAPI + and front end Pixel. + required: true + label: Nextdoor Pixel Id + actions: + - id: 7hSAaxpKp56cqggHVoM5Ss + name: Send Conversion + slug: sendConversion + description: Send Conversion Event to Nextdoor + platform: CLOUD + hidden: false + defaultTrigger: null + fields: + - id: rxBViDnV5Mfwn4CzwvyAnj + sortOrder: 0 + fieldKey: event_name + label: Event Name + type: STRING + description: The name of the event to track + placeholder: '' + required: true + multiple: false + choices: + - label: Custom Conversion 1 + value: custom_conversion_1 + - label: Custom Conversion 2 + value: custom_conversion_2 + - label: Custom Conversion 3 + value: custom_conversion_3 + - label: Custom Conversion 4 + value: custom_conversion_4 + - label: Custom Conversion 5 + value: custom_conversion_5 + - label: Custom Conversion 6 + value: custom_conversion_6 + - label: Custom Conversion 7 + value: custom_conversion_7 + - label: Custom Conversion 8 + value: custom_conversion_8 + - label: Custom Conversion 9 + value: custom_conversion_9 + - label: Custom Conversion 10 + value: custom_conversion_10 + - label: Lead + value: lead + - label: Purchase + value: purchase + - label: Sign Up + value: sign_up + dynamic: false + allowNull: false + - id: eVrZPMAQnZ8Lbya6kSTNVk + sortOrder: 1 + fieldKey: event_id + label: Event ID + type: STRING + description: >- + A unique ID for the event. This is used to deduplicate events sent by + the browser and server. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: rXdsHtC2NWyd6Nhi6JZCW2 + sortOrder: 2 + fieldKey: event_time + label: Event Time + type: STRING + description: UCT Timestamp with ISO 8601 format. For example, 2022-11-23T03:30:52Z + placeholder: '' + defaultValue: + '@path': $.timestamp + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: rdPZWzPhV8zfctkov5XQTQ + sortOrder: 3 + fieldKey: action_source + label: Action Source + type: STRING + description: Indicates the channel through which conversion happened. + placeholder: '' + required: true + multiple: false + choices: + - label: email + value: email + - label: website + value: website + - label: app + value: app + - label: phone_call + value: phone_call + - label: chat + value: chat + - label: physical_store + value: physical_store + - label: system_generated + value: system_generated + - label: other + value: custom_conversion_8 + dynamic: false + allowNull: false + - id: ruUz364dVbCBcc4r46vDe4 + sortOrder: 4 + fieldKey: action_source_url + label: Action Source url + type: STRING + description: The browser URL where the event happened (required for web events). + placeholder: '' + defaultValue: + '@path': $.context.page.url + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: iKZQkd6VPD14rqBswSKL6f + sortOrder: 5 + fieldKey: delivery_optimization + label: Delivery Optimization + type: BOOLEAN + description: >- + True indicates data can be used for optimization. False indicates the + data will only be used for attribution + placeholder: '' + defaultValue: true + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: kCdSdH9UFGrwLdW46xChKU + sortOrder: 6 + fieldKey: test_event + label: Test Event + type: BOOLEAN + description: Flag to indicate if this is a test event. + placeholder: '' + defaultValue: false + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: c83A1Cx6Dn5BMksz6gmTgJ + sortOrder: 8 + fieldKey: customer + label: Customer Data + type: OBJECT + description: >- + Customer profile data used to match with Nextdoor users. At least one of + the fields is required. + placeholder: '' + defaultValue: + email: + '@if': + exists: + '@path': $.context.traits.email + then: + '@path': $.context.traits.email + else: + '@path': $.properties.email + phone_number: + '@if': + exists: + '@path': $.context.traits.phone + then: + '@path': $.context.traits.phone + else: + '@path': $.properties.phone + first_name: + '@if': + exists: + '@path': $.context.traits.first_name + then: + '@path': $.context.traits.first_name + else: + '@path': $.properties.first_name + last_name: + '@if': + exists: + '@path': $.context.traits.last_name + then: + '@path': $.context.traits.last_name + else: + '@path': $.properties.last_name + date_of_birth: + '@if': + exists: + '@path': $.context.traits.birthday + then: + '@path': $.context.traits.birthday + else: + '@path': $.properties.birthday + street_address: + '@if': + exists: + '@path': $.context.traits.address.street + then: + '@path': $.context.traits.address.street + else: + '@path': $.properties.address.street + city: + '@if': + exists: + '@path': $.context.traits.address.city + then: + '@path': $.context.traits.address.city + else: + '@path': $.properties.address.city + state: + '@if': + exists: + '@path': $.context.traits.address.state + then: + '@path': $.context.traits.address.state + else: + '@path': $.properties.address.state + country: + '@if': + exists: + '@path': $.context.traits.address.country + then: + '@path': $.context.traits.address.country + else: + '@path': $.properties.address.country + zip_code: + '@if': + exists: + '@path': $.context.traits.address.postal_code + then: + '@path': $.context.traits.address.postal_code + else: + '@path': $.properties.address.postal_code + click_id: + '@if': + exists: + '@path': $.integrations.Nextdoor Conversions API.click_id + then: + '@path': $.integrations.Nextdoor Conversions API.click_id + else: + '@path': $.properties.click_id + client_ip_address: + '@path': $.context.ip + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: h1QHQSVAmbVv5xrjqnfwuk + sortOrder: 9 + fieldKey: custom + label: Custom Data + type: OBJECT + description: >- + Custom objects contains fields specific to advertisers that are not + already covered in standard fields. + placeholder: '' + defaultValue: + order_value: + '@path': $.properties.total + currency: + '@path': $.properties.currency + order_id: + '@path': $.properties.order_id + delivery_category: not_specified + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: f4v3otMMiJpX2iZbSDZzuv + sortOrder: 10 + fieldKey: product_context + label: Product Context + type: OBJECT + description: Product details associated with the event. + placeholder: '' + defaultValue: + '@arrayPath': + - $.properties.products + - id: + '@path': $.product_id + quantity: + '@path': $.quantity + item_price: + '@path': $.price + required: false + multiple: true + choices: null + dynamic: false + allowNull: false + - id: jeLFST56mmZui9Ugf1mjFR + sortOrder: 11 + fieldKey: app + label: Mobile App Event Parameters + type: OBJECT + description: Data about the source Mobile app. Required for app events + placeholder: '' + defaultValue: + app_id: + '@path': $.context.app.name + app_tracking_enabled: + '@path': $.context.device.adTrackingEnabled + platform: + '@path': $.context.app.type + app_version: + '@path': $.context.app.version + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: rP5JhLETdYbU4XkxmkeSFn + name: Nextdoor Browser Plugin + slug: nextdoorPlugin + description: Enriches Segment payloads the Nextdoor Click ID + platform: WEB + hidden: false + defaultTrigger: >- + type = "track" or type = "identify" or type = "page" or type = "group" or + type = "alias" + fields: [] + presets: [] + partnerOwned: true - id: 596f991a70a3e552b957f74e display_name: Nielsen DCR name: Nielsen DCR @@ -113651,7 +111755,7 @@ items: hidden: false defaultTrigger: type = "identify" fields: - - id: 7bcUDgjmbVCwE79YLWzN9Q + - id: 3gkmxjopNbdFJ37RDx6Q9S sortOrder: 0 fieldKey: contactKey label: Contact Key @@ -113677,7 +111781,7 @@ items: hidden: false defaultTrigger: null fields: - - id: wB4GwXmo6BVQAhRopCcyYZ + - id: uZyESXLqFiVf6j4WZUTjUX sortOrder: 0 fieldKey: eventDefinitionKey label: Event Definition Key @@ -113691,7 +111795,7 @@ items: choices: null dynamic: false allowNull: false - - id: 85Zaq8eDPfKZVkyPX8EdRp + - id: fGbwaydgYgqjXaZCoaNy6j sortOrder: 1 fieldKey: contactKey label: Contact Key @@ -113705,7 +111809,7 @@ items: choices: null dynamic: false allowNull: false - - id: rDwpaCDgtgAj9K9eTVu5KT + - id: wXGo2au4Tx7GGApGouTygk sortOrder: 2 fieldKey: data label: Event Data @@ -113732,7 +111836,7 @@ items: hidden: false defaultTrigger: null fields: - - id: rJ8t3SNQwreVFTqwmZRB2q + - id: mpdj371Zgcqj76u9Edov9U sortOrder: 0 fieldKey: key label: Data Extension Key @@ -113747,7 +111851,7 @@ items: choices: null dynamic: false allowNull: false - - id: pwTAP6HA2brVctvwzoCY9t + - id: 4ngH84j9pjvAH2BM7KMti6 sortOrder: 1 fieldKey: id label: Data Extension ID @@ -113762,7 +111866,7 @@ items: choices: null dynamic: false allowNull: false - - id: sg8cHv3HeuoMfxf1FUL7on + - id: pmd7jmGQmHH6ic2sRggK92 sortOrder: 2 fieldKey: keys label: Data Extension Primary Keys @@ -113779,7 +111883,7 @@ items: choices: null dynamic: false allowNull: false - - id: c4arDnmkkUgnAouYAGRJXq + - id: u71oGUVYTce2REQgbuTEXP sortOrder: 3 fieldKey: values label: Data Extension Fields @@ -113797,7 +111901,7 @@ items: choices: null dynamic: false allowNull: false - - id: fQX5mLRvmbcJWQkm6UgAfR + - id: eUUm8X98bw8GREcaG8xppf sortOrder: 4 fieldKey: enable_batching label: Batch data to SFMC @@ -113820,7 +111924,7 @@ items: hidden: false defaultTrigger: type = "identify" fields: - - id: cRB4mpG2673nwJkpsKKhud + - id: wCqc4wtYVL42f7EGxaHHgL sortOrder: 0 fieldKey: key label: Data Extension Key @@ -113835,7 +111939,7 @@ items: choices: null dynamic: false allowNull: false - - id: ahyjmWLu24HAekxwLKhYN4 + - id: 7nW4DRyH1pvp3MCuFGq8wo sortOrder: 1 fieldKey: id label: Data Extension ID @@ -113850,7 +111954,7 @@ items: choices: null dynamic: false allowNull: false - - id: 9LmLt2Dxduisbd9t8AdbhR + - id: o4kSusbWjwb1jKvy1HmKE5 sortOrder: 2 fieldKey: keys label: Data Extension Primary Keys @@ -113870,7 +111974,7 @@ items: choices: null dynamic: false allowNull: false - - id: xcAmN3NasKGtgMF5gN4ZM6 + - id: 8n8Ek8bFHKk6vTUGu8oQHc sortOrder: 3 fieldKey: values label: Contact Fields @@ -113887,7 +111991,7 @@ items: choices: null dynamic: false allowNull: false - - id: p9yt1KGUFEca1kF1a6jXH5 + - id: cEwnXVGNrL5yvazv2aWEPJ sortOrder: 4 fieldKey: enable_batching label: Batch data to SFMC @@ -113903,14 +112007,12 @@ items: - id: 2ZQ3y7DJqFGYwCxcpypA1P name: Send Event to Data Extension (V2) slug: dataExtensionV2 - description: >- - Upsert events as rows into an existing data extension in Salesforce - Marketing Cloud. + description: Upsert events as rows into a data extension in Salesforce Marketing Cloud. platform: CLOUD hidden: false defaultTrigger: null fields: - - id: rmgeYjf8zx8CxrPHi3Ng1Q + - id: oj2wfkcgfnRFBmuEwHwVMS sortOrder: 0 fieldKey: keys label: Data Extension Primary Keys @@ -113927,7 +112029,7 @@ items: choices: null dynamic: true allowNull: false - - id: 7RBWa4CrPJNyTYkfE1dLd2 + - id: tvm9KAKhF1Cwa7yiPWFExt sortOrder: 1 fieldKey: values label: Data Extension Fields @@ -113945,7 +112047,7 @@ items: choices: null dynamic: true allowNull: false - - id: 8BvhrUXiey5iutkfuKCxKk + - id: dnfe9ipyCBoCFjR6UomjbE sortOrder: 2 fieldKey: enable_batching label: Batch data to SFMC @@ -113958,7 +112060,7 @@ items: choices: null dynamic: false allowNull: false - - id: shtWQ25AGQcpE1tdmP1n9G + - id: tHc6YrCC2gB9oFSAo82br1 sortOrder: 4 fieldKey: operation label: Operation @@ -113976,7 +112078,7 @@ items: value: select dynamic: false allowNull: false - - id: 4DbMJDATSkDtK8LYRJR45B + - id: 2DjQNSqZ8JSDYgwmD8RE9v sortOrder: 5 fieldKey: dataExtensionId label: Data Extension ID @@ -113988,7 +112090,7 @@ items: choices: null dynamic: true allowNull: false - - id: 9HQGivpCgKw5pNcQvxMDa3 + - id: 6NANnvaB7bhXDXpiW6daCF sortOrder: 6 fieldKey: categoryId label: Category ID (Folder ID) @@ -114000,7 +112102,7 @@ items: choices: null dynamic: true allowNull: false - - id: suxU3f7Tpi5gs23Kqcg2w7 + - id: vFGTKYq9kqjPx5pbxULfNF sortOrder: 7 fieldKey: name label: Data Extension Name @@ -114012,7 +112114,7 @@ items: choices: null dynamic: false allowNull: false - - id: 26EAQuxkb5rdDL9CgUpuKG + - id: 22jBXDEQtNGAdz8sdHrrWV sortOrder: 8 fieldKey: description label: Data Extension Description @@ -114024,7 +112126,7 @@ items: choices: null dynamic: false allowNull: false - - id: tYQvYiMxZxDFCjhEu56PyL + - id: iAXj2yXiYfDaxf8TUetMEL sortOrder: 9 fieldKey: isSendable label: Is Sendable @@ -114038,7 +112140,7 @@ items: choices: null dynamic: false allowNull: false - - id: 2T5WVnJJBoBS71pXebXtuX + - id: rtrQ8xEkcNDYuWnQfYydkh sortOrder: 10 fieldKey: sendableCustomObjectField label: Sendable Custom Object Field @@ -114052,7 +112154,7 @@ items: choices: null dynamic: false allowNull: false - - id: b5CeLAQ6gs4WKyfVMeEgzS + - id: o9cx5WqfHMeGQzA6gqHGg3 sortOrder: 11 fieldKey: sendableSubscriberField label: Sendable Subscriber Field @@ -114070,7 +112172,7 @@ items: value: _SubscriberID dynamic: false allowNull: false - - id: 6YHFzPAwH7H8mwDTxtbhk + - id: fWEDwCQe7DE7bCmpmFKAcf sortOrder: 12 fieldKey: columns label: Data Extension Fields @@ -114082,7 +112184,7 @@ items: choices: null dynamic: false allowNull: false - - id: bTKKS7Lw93ETX8WvPokCsU + - id: bKJgWHTgGNGFpV7fxgUHqA sortOrder: 13 fieldKey: retlOnMappingSave label: Create or Select Data Extension @@ -114097,7 +112199,7 @@ items: dynamic: false allowNull: false hidden: false - - id: vk4qzR1jutUuga82iQFmcV + - id: qEJhRwvSPK672kUWhkDsXW sortOrder: 14 fieldKey: operation label: Operation @@ -114115,7 +112217,7 @@ items: value: select dynamic: false allowNull: false - - id: qbaCm2NMPzxZfEJCGfDMjt + - id: da2LtXBDvYK81mfsE2Tea2 sortOrder: 15 fieldKey: dataExtensionId label: Data Extension ID @@ -114127,7 +112229,7 @@ items: choices: null dynamic: true allowNull: false - - id: hff9VkRMW2TCC2yWPfD5Tb + - id: 2JBnXqT53MfHtBSeL5ddnC sortOrder: 16 fieldKey: categoryId label: Category ID (Folder ID) @@ -114139,7 +112241,7 @@ items: choices: null dynamic: true allowNull: false - - id: dAjP9ByPaFExBEUctT9nPq + - id: fAZG36Und1Afc9UkJPo1PP sortOrder: 17 fieldKey: name label: Data Extension Name @@ -114151,7 +112253,7 @@ items: choices: null dynamic: false allowNull: false - - id: qmdGzHA1NGusRFMd5uoFd5 + - id: 9r1CCd7MXi2ooLNJHAes9w sortOrder: 18 fieldKey: description label: Data Extension Description @@ -114163,7 +112265,7 @@ items: choices: null dynamic: false allowNull: false - - id: tMUcq99j4VdoFZnbX3w1RM + - id: qSqSrrGXdD5GTVKWscXtMt sortOrder: 19 fieldKey: isSendable label: Is Sendable @@ -114177,7 +112279,7 @@ items: choices: null dynamic: false allowNull: false - - id: ssrHTeEKAv269uxcdRaYMt + - id: jJQdAUUYwcV4R7K8K49Z6B sortOrder: 20 fieldKey: sendableCustomObjectField label: Sendable Custom Object Field @@ -114191,7 +112293,7 @@ items: choices: null dynamic: false allowNull: false - - id: qp6bPgwiB83vBHemFXBsJX + - id: 5bS5YHc1Y8Vw88ovx6MauY sortOrder: 21 fieldKey: sendableSubscriberField label: Sendable Subscriber Field @@ -114209,7 +112311,7 @@ items: value: _SubscriberID dynamic: false allowNull: false - - id: 4jgm72jg3sXSV6bpWS5j23 + - id: 6vp9uFecd7qJzKUvcb7nMD sortOrder: 22 fieldKey: columns label: Data Extension Fields @@ -114221,7 +112323,7 @@ items: choices: null dynamic: false allowNull: false - - id: mt6hTj8jiUs3Jk4ZF5pWRj + - id: 2igVMoW4iyhTqy6g6WcYLs sortOrder: 23 fieldKey: onMappingSave label: Create or Select Data Extension @@ -114240,13 +112342,13 @@ items: name: Send Contact to Data Extension (V2) slug: contactDataExtensionV2 description: >- - Upsert contact data as rows into an existing data extension in Salesforce - Marketing Cloud. + Upsert contact data as rows into a data extension in Salesforce Marketing + Cloud. platform: CLOUD hidden: false defaultTrigger: type = "identify" fields: - - id: nHJELWgpAfybPmzdkiBzhD + - id: oGg6NmbtphpMxQv5PjTpMs sortOrder: 0 fieldKey: keys label: Data Extension Primary Keys @@ -114266,7 +112368,7 @@ items: choices: null dynamic: true allowNull: false - - id: c5sL6KM65fucNpcWfXYurR + - id: vjK9uNwKDwiMPCK2FBrB4Y sortOrder: 1 fieldKey: values label: Contact Fields @@ -114283,7 +112385,7 @@ items: choices: null dynamic: true allowNull: false - - id: 844ctQZXVLtWJ26Fx8TPNK + - id: usb8siC5pM4GTa9nwMQVvw sortOrder: 2 fieldKey: enable_batching label: Batch data to SFMC @@ -114296,7 +112398,7 @@ items: choices: null dynamic: false allowNull: false - - id: sB8Dvkoio4a4AG2rkGcg6B + - id: syXExevLc4sPhV88BaBzbE sortOrder: 4 fieldKey: operation label: Operation @@ -114314,7 +112416,7 @@ items: value: select dynamic: false allowNull: false - - id: JfbT7D7L7YYAESN3AL6zA + - id: fgqqsPnVwffdVgqcjahaov sortOrder: 5 fieldKey: dataExtensionId label: Data Extension ID @@ -114326,7 +112428,7 @@ items: choices: null dynamic: true allowNull: false - - id: dHLENaRwJiwaarUCvPpahi + - id: rx2LGZMTsamr4yr4QeWTAC sortOrder: 6 fieldKey: categoryId label: Category ID (Folder ID) @@ -114338,7 +112440,7 @@ items: choices: null dynamic: true allowNull: false - - id: kdGyRB8vLpTr1UaoathKFt + - id: 2vsMbgLkFPKNQG72SNXawx sortOrder: 7 fieldKey: name label: Data Extension Name @@ -114350,7 +112452,7 @@ items: choices: null dynamic: false allowNull: false - - id: n1bg8W6QDZFbqwBM69d9y3 + - id: 8nZkmagoADrZf9eAgdhkXG sortOrder: 8 fieldKey: description label: Data Extension Description @@ -114362,7 +112464,7 @@ items: choices: null dynamic: false allowNull: false - - id: eBPeJJJeoDe7rztA8nMPfJ + - id: 3q3dUbzAzeNJ8P3FHtNst3 sortOrder: 9 fieldKey: isSendable label: Is Sendable @@ -114376,7 +112478,7 @@ items: choices: null dynamic: false allowNull: false - - id: hd5Zykihm9PTmiXjfMHT75 + - id: 244UMuNhjXmmUR8vZ7wWns sortOrder: 10 fieldKey: sendableCustomObjectField label: Sendable Custom Object Field @@ -114390,7 +112492,7 @@ items: choices: null dynamic: false allowNull: false - - id: iTxYgoESWBjr98ZT7Cqv6t + - id: 8V71EugQ8FNphY9mkAKJPS sortOrder: 11 fieldKey: sendableSubscriberField label: Sendable Subscriber Field @@ -114408,7 +112510,7 @@ items: value: _SubscriberID dynamic: false allowNull: false - - id: pxx9XUV664rTK51ZMWoxs7 + - id: 7kYwwjZt7nLMRyrmQSYPtt sortOrder: 12 fieldKey: columns label: Data Extension Fields @@ -114420,7 +112522,7 @@ items: choices: null dynamic: false allowNull: false - - id: eycpCdFAVUbFRjx69Y5swJ + - id: dSXUQaQvicuGufbE8mdneC sortOrder: 13 fieldKey: retlOnMappingSave label: Create or Select Data Extension @@ -114435,7 +112537,7 @@ items: dynamic: false allowNull: false hidden: false - - id: vEMuUkY8WJgwmaRpx451k5 + - id: rshvzy6XhkkemFew96g57Z sortOrder: 14 fieldKey: operation label: Operation @@ -114453,7 +112555,7 @@ items: value: select dynamic: false allowNull: false - - id: cEaf3ptqCuU2739uoHSMAe + - id: vHpFEhsAXm7jq14h45TnxQ sortOrder: 15 fieldKey: dataExtensionId label: Data Extension ID @@ -114465,7 +112567,7 @@ items: choices: null dynamic: true allowNull: false - - id: 2XMuaNAMaGRii6Hq5K6UzV + - id: q4eLMyg6qM47cWoQUDsT9a sortOrder: 16 fieldKey: categoryId label: Category ID (Folder ID) @@ -114477,7 +112579,7 @@ items: choices: null dynamic: true allowNull: false - - id: sUxep19wmuPGp6QZkE2TnS + - id: j26vBUpwarvj3fHTvApmdr sortOrder: 17 fieldKey: name label: Data Extension Name @@ -114489,7 +112591,7 @@ items: choices: null dynamic: false allowNull: false - - id: fKmViPQn4eQLX5aqgMPeLW + - id: 2jFY3tfRyk3rdhHnVBXqcr sortOrder: 18 fieldKey: description label: Data Extension Description @@ -114501,7 +112603,7 @@ items: choices: null dynamic: false allowNull: false - - id: kjJL4n4WhgB1ygCWJWfaTy + - id: sVrb95f51HdUAv2iNAdV9B sortOrder: 19 fieldKey: isSendable label: Is Sendable @@ -114515,7 +112617,7 @@ items: choices: null dynamic: false allowNull: false - - id: cJmx59Qi6hUq7eqkfoA74t + - id: fKkdRGdoft6EFZQr6678nE sortOrder: 20 fieldKey: sendableCustomObjectField label: Sendable Custom Object Field @@ -114529,7 +112631,7 @@ items: choices: null dynamic: false allowNull: false - - id: 9rLexRWHxFyZDfdtpFhVpD + - id: sED5QGkZxgapA218u9mdPG sortOrder: 21 fieldKey: sendableSubscriberField label: Sendable Subscriber Field @@ -114547,7 +112649,7 @@ items: value: _SubscriberID dynamic: false allowNull: false - - id: h1PuRt8zm8pLEzTZq7TuQn + - id: euRpi66XwsHp9mSibrsgH9 sortOrder: 22 fieldKey: columns label: Data Extension Fields @@ -114559,7 +112661,7 @@ items: choices: null dynamic: false allowNull: false - - id: kzQErgZKER7tbhSwf1cgrX + - id: tCDx8Q2oCXU2prUcapbr33 sortOrder: 23 fieldKey: onMappingSave label: Create or Select Data Extension @@ -125351,7 +123453,7 @@ items: - Surveys - Analytics logo: - url: https://cdn-devcenter.segment.com/026a2792-a26a-4dd3-b834-151d73246b90.svg + url: https://cdn-devcenter.segment.com/c5999c7c-27c9-4c92-90b9-a043814cfaf9.svg mark: url: https://cdn-devcenter.segment.com/a1dc2f9b-a359-41b9-a6fb-c9d147b79227.svg methods: @@ -125421,7 +123523,7 @@ items: - Surveys - Analytics logo: - url: https://cdn-devcenter.segment.com/33840a5c-ebcd-4e5a-a2da-3bbff3f69425.svg + url: https://cdn-devcenter.segment.com/b36a6bfa-51a0-4cee-9ce5-a8c1310b7e66.svg mark: url: https://cdn-devcenter.segment.com/6f44d6d0-edd6-4667-a42c-e84402fddc1a.svg methods: @@ -137811,6 +135913,14 @@ items: description: Created under Settings > API Integration in the Topsort Manager Platform. required: true label: API Key + - name: skipZeroPricePurchases + type: boolean + defaultValue: false + description: >- + When enabled, purchase events with items that have zero or missing unit + price will be filtered out. + required: false + label: Skip Zero Price Purchases actions: - id: 6hi4YVo8BFtB3xqeESgvPK name: Purchase @@ -137820,7 +135930,7 @@ items: hidden: false defaultTrigger: type = "track" and event = "Order Completed" fields: - - id: 9Mip7RXK19Na9ThBW8fVMx + - id: wNdkQq6KisvamidmgFbGqa sortOrder: 0 fieldKey: id label: Event ID @@ -137836,7 +135946,7 @@ items: choices: null dynamic: false allowNull: false - - id: 6dT8g3W5tZsZPjcBkfooXf + - id: aL45KCMrqonrfT4kK1ny4p sortOrder: 1 fieldKey: occurredAt label: Occurred At @@ -137850,7 +135960,7 @@ items: choices: null dynamic: false allowNull: false - - id: aSRSpnEgdk9RfA5Wp6agWz + - id: 36rpatKNiBfDqsfRwMDApa sortOrder: 2 fieldKey: opaqueUserId label: Opaque User ID @@ -137866,7 +135976,7 @@ items: choices: null dynamic: false allowNull: false - - id: h7xm3WFmRe9Lc5kwf4jdjc + - id: 4uq9Xg6nyERPwAY5EHiRDo sortOrder: 3 fieldKey: items label: Items @@ -137903,7 +136013,7 @@ items: hidden: false defaultTrigger: type = "track" and event = "Product Clicked" fields: - - id: sZMs8z8aZBKiKPqyLqBH7U + - id: 7GBd8L28VfTAvLQJm6Gib8 sortOrder: 0 fieldKey: id label: Event ID @@ -137919,7 +136029,7 @@ items: choices: null dynamic: false allowNull: false - - id: bZk3VFRfjeu8CyjZTV7bnW + - id: u2rXPnd22h6Xxqi54oRdrN sortOrder: 1 fieldKey: occurredAt label: Occurred At @@ -137933,7 +136043,7 @@ items: choices: null dynamic: false allowNull: false - - id: irgTfafpV9pWEBGzPaV8s9 + - id: sGKZzi7z4DjXWdV5EwJsA7 sortOrder: 2 fieldKey: opaqueUserId label: Opaque User ID @@ -137949,7 +136059,7 @@ items: choices: null dynamic: false allowNull: false - - id: uJXo7pnnSYvzDMSGbgLJAM + - id: wd3ZERovpo79cNknr2ruvz sortOrder: 3 fieldKey: resolvedBidId label: Resolved Bid ID @@ -137965,7 +136075,7 @@ items: choices: null dynamic: false allowNull: false - - id: uexA8viyACctUNLV1QWxW5 + - id: 3WMwxaJgagbKpqJtc7QyX8 sortOrder: 4 fieldKey: additionalAttribution label: Additional Attribution @@ -137987,7 +136097,7 @@ items: hidden: false defaultTrigger: type = "track" and event = "Product Viewed" fields: - - id: 48ZRK4fsba1yWWkU4a8Zzv + - id: rj277JN5qcZhsTJADphUoD sortOrder: 0 fieldKey: id label: Event ID @@ -138003,7 +136113,7 @@ items: choices: null dynamic: false allowNull: false - - id: bsG4sbuRKbYys1z69SAR9w + - id: b4HeMMWPkTqRmFpXc9H6X9 sortOrder: 1 fieldKey: occurredAt label: Occurred At @@ -138017,7 +136127,7 @@ items: choices: null dynamic: false allowNull: false - - id: aYDDEk9htRnP1gzK3AGHi8 + - id: t1ATmVuby8Prw5tL7fziSv sortOrder: 2 fieldKey: opaqueUserId label: Opaque User ID @@ -138033,7 +136143,7 @@ items: choices: null dynamic: false allowNull: false - - id: id8Ty6Ry4WMhGsMaLMjAt4 + - id: qvcGUSZ2Lk5Num5oXfdA6f sortOrder: 3 fieldKey: resolvedBidId label: Resolved Bid ID @@ -138049,7 +136159,7 @@ items: choices: null dynamic: false allowNull: false - - id: fnfKhgEywRhVBP54BxBaPj + - id: 4ykPKZvug5h262Qrz7qgCh sortOrder: 4 fieldKey: additionalAttribution label: Additional Attribution @@ -138073,7 +136183,7 @@ items: hidden: false defaultTrigger: type = "track" and event = "Product List Viewed" fields: - - id: tMfVUhNWNZ7zag1EDf7af8 + - id: hLaArG9xGbZdKYKGbxUAoP sortOrder: 0 fieldKey: id label: Event ID @@ -138089,7 +136199,7 @@ items: choices: null dynamic: false allowNull: false - - id: iAN1vvGMHYaF6NmRCCKDZ3 + - id: wVdm2ecwCKhKD3oReiqe7C sortOrder: 1 fieldKey: occurredAt label: Occurred At @@ -138103,7 +136213,7 @@ items: choices: null dynamic: false allowNull: false - - id: mNFzKRLzCX3GtxvUV9E4qL + - id: 3AqeWf87bUpxGVn7mrK5bm sortOrder: 2 fieldKey: opaqueUserId label: Opaque User ID @@ -138119,7 +136229,7 @@ items: choices: null dynamic: false allowNull: false - - id: dyNpukrBLg9yGFn4hbXigH + - id: kngzk2ZfouoNWxoHRET5M7 sortOrder: 3 fieldKey: products label: Products @@ -138156,8 +136266,35 @@ items: additionalAttribution: '@path': additionalAttribution trigger: type = "track" and event = "Product List Viewed" - - actionId: haYWUuXp1KDvb8u6uLj9h4 - name: Banner Impression + - actionId: 6hi4YVo8BFtB3xqeESgvPK + name: Purchase + fields: + id: + '@path': $.messageId + occurredAt: + '@path': $.timestamp + opaqueUserId: + '@path': $.anonymousId + items: + '@arrayPath': + - $.properties.products + - productId: + '@path': $.product_id + unitPrice: + '@path': $.price + quantity: + '@path': $.quantity + vendorId: + '@if': + exists: + '@path': $.vendorId + then: + '@path': $.vendorId + else: + '@path': $.brand + trigger: type = "track" and event = "Order Completed" + - actionId: bB6C4ayDhAhkCaRq83iJVw + name: Banner Click fields: id: '@path': $.messageId @@ -138169,7 +136306,7 @@ items: '@path': $.properties.resolvedBidId additionalAttribution: '@path': $.properties.additionalAttribution - trigger: type = "track" and event = "Banner Impression" + trigger: type = "track" and event = "Banner Click" - actionId: haYWUuXp1KDvb8u6uLj9h4 name: Impression fields: @@ -138184,8 +136321,8 @@ items: additionalAttribution: '@path': $.properties.additionalAttribution trigger: type = "track" and event = "Product Viewed" - - actionId: bB6C4ayDhAhkCaRq83iJVw - name: Banner Click + - actionId: haYWUuXp1KDvb8u6uLj9h4 + name: Banner Impression fields: id: '@path': $.messageId @@ -138197,7 +136334,7 @@ items: '@path': $.properties.resolvedBidId additionalAttribution: '@path': $.properties.additionalAttribution - trigger: type = "track" and event = "Banner Click" + trigger: type = "track" and event = "Banner Impression" - actionId: bB6C4ayDhAhkCaRq83iJVw name: Click fields: @@ -138212,33 +136349,6 @@ items: additionalAttribution: '@path': $.properties.additionalAttribution trigger: type = "track" and event = "Product Clicked" - - actionId: 6hi4YVo8BFtB3xqeESgvPK - name: Purchase - fields: - id: - '@path': $.messageId - occurredAt: - '@path': $.timestamp - opaqueUserId: - '@path': $.anonymousId - items: - '@arrayPath': - - $.properties.products - - productId: - '@path': $.product_id - unitPrice: - '@path': $.price - quantity: - '@path': $.quantity - vendorId: - '@if': - exists: - '@path': $.vendorId - then: - '@path': $.vendorId - else: - '@path': $.brand - trigger: type = "track" and event = "Order Completed" partnerOwned: true - id: 54521fdb25e721e32a72eefa display_name: Totango diff --git a/src/_data/catalog/destinations_private.yml b/src/_data/catalog/destinations_private.yml index 6d7114d4e7..19610d2bf2 100644 --- a/src/_data/catalog/destinations_private.yml +++ b/src/_data/catalog/destinations_private.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT -# destination data last updated 2025-10-09 +# destination data last updated 2025-10-16 items: - id: 54521fd925e721e32a72eee1 display_name: Pardot diff --git a/src/_data/catalog/kotlin_resources.yml b/src/_data/catalog/kotlin_resources.yml index 6492eb6b51..41c7c7542a 100644 --- a/src/_data/catalog/kotlin_resources.yml +++ b/src/_data/catalog/kotlin_resources.yml @@ -16,7 +16,7 @@ items: categories: - app - name: Android AdvertisingId Plugin - url: https://github.com/segmentio/analytics-kotlin/blob/main/samples/kotlin-android-app/src/main/java/com/segment/analytics/next/plugins/AndroidAdvertisingIdPlugin.kt + url: https://github.com/segmentio/analytics-kotlin/blob/1ef79eaf035549d08f91bac4e0a1de8ca6793e7b/samples/kotlin-android-app/src/main/java/com/segment/analytics/next/plugins/AndroidAdvertisingIdPlugin.kt categories: - plugin - name: Screen Recording Plugin diff --git a/src/_data/catalog/source_categories.yml b/src/_data/catalog/source_categories.yml index 2aea807994..132bce3a08 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 categories last updated 2025-10-09 +# source categories last updated 2025-10-16 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 765122ec11..48c3d5217f 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 2025-10-09 +# sources last updated 2025-10-16 items: - id: 8HWbgPTt3k display_name: .NET diff --git a/src/connections/auto-instrumentation/configuration.md b/src/connections/auto-instrumentation/configuration.md index e1976a2e27..20e6d57d7f 100644 --- a/src/connections/auto-instrumentation/configuration.md +++ b/src/connections/auto-instrumentation/configuration.md @@ -13,10 +13,21 @@ This guide assumes that you've already added the Signals SDK to your application > info "Auto-Instrumentation in public beta" > Auto-Instrumentation is in public beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available. +> info "Regional availability" +> Auto-Instrumentation isn't supported in EU workspaces. + ## Converting signals to events After you set up the Signals SDK to capture the signals you want to target, you can create rules in your Segment workspace to translate the captured signals into traditional Segment analytics events. These rules are deployed in your application the next time a user launches your app. +The process works like this: + +1. The SDK sends raw signals from your app or website to Segment. +2. You build event rules in your workspace that define how those signals should become analytics events. +3. You publish the event rules. + +After publishing, Segment analyzes user interactions in your app or website against these rules and automatically generates analytics events when matching interactions occur. + ### Getting started with rule creation 1. Ensure you have the `Workspace Owner` or `Source Admin` role in Segment. If your source is connected to a tracking plan, you will also need, at a minimum, the `Tracking Plan Read-only` role. To view the content in the Event Builder tab, you will need, at a minimum, the `Source Read-only` role. @@ -47,13 +58,11 @@ You can enrich your events by adding properties based on signal metadata. For ex These properties are sent alongside your event, giving your team deeper insights without requiring any manual instrumentation. + -- - - ## Identify diff --git a/src/connections/destinations/catalog/kable/index.md b/src/connections/destinations/catalog/kable/index.md index 378f2de825..6f14286318 100644 --- a/src/connections/destinations/catalog/kable/index.md +++ b/src/connections/destinations/catalog/kable/index.md @@ -55,7 +55,7 @@ analytics.track({ The Segment Track event above would be transformed and transmitted to Kable as: -```curl +```bash curl --request POST \ --url https://live.kable.io/api/v1/events/create \ --header 'Accept: application/json' \ diff --git a/src/connections/destinations/catalog/keen/index.md b/src/connections/destinations/catalog/keen/index.md index 57b9507edc..b0b9e97d3e 100644 --- a/src/connections/destinations/catalog/keen/index.md +++ b/src/connections/destinations/catalog/keen/index.md @@ -9,7 +9,6 @@ When you enable Keen in the Segment web app, your changes appear in the Segment Keen is supported on the client side and server side. -- - - ## Identify diff --git a/src/connections/destinations/catalog/leanplum/index.md b/src/connections/destinations/catalog/leanplum/index.md index 9634a70c30..72cabd7a45 100644 --- a/src/connections/destinations/catalog/leanplum/index.md +++ b/src/connections/destinations/catalog/leanplum/index.md @@ -187,7 +187,7 @@ As every analytics provider deals with push notifications and in-app messaging d 5. In Keychain, select the new certificates, expand them to view the private key, and then right click to export them as .p12 files. You must enter a password. -6. In Leanplum, go to your app's Keys & Settings (App Settings > {Your app} > Keys & Settings). Under Push Notifications, upload your .p12 files to Leanplum and enter your passphrase from step 5 above. +6. In Leanplum, go to your app's Keys & Settings (App Settings > \{Your app} > Keys & Settings). Under Push Notifications, upload your .p12 files to Leanplum and enter your passphrase from step 5 above. 7. Configure your app to use push notifications in your app delegate's `applicationDidFinishLaunching` method (you may choose any combination of formats. diff --git a/src/connections/destinations/catalog/librato/index.md b/src/connections/destinations/catalog/librato/index.md index 0c10df41a1..940024517e 100644 --- a/src/connections/destinations/catalog/librato/index.md +++ b/src/connections/destinations/catalog/librato/index.md @@ -9,7 +9,6 @@ When you enable Librato in the Segment web app, your changes appear in the Segme Librato supports the Segment `track` method for both client-side and server-side. -- - - ## Track diff --git a/src/connections/destinations/catalog/livechat/index.md b/src/connections/destinations/catalog/livechat/index.md index 748df4af30..97db17014a 100644 --- a/src/connections/destinations/catalog/livechat/index.md +++ b/src/connections/destinations/catalog/livechat/index.md @@ -9,7 +9,6 @@ When you enable LiveChat in the Segment web app, your changes appear in the Segm LiveChat is only supported on the client-side. -- - - ## Identify diff --git a/src/connections/destinations/catalog/localytics/index.md b/src/connections/destinations/catalog/localytics/index.md index b47fd6e190..8fc041f3ca 100644 --- a/src/connections/destinations/catalog/localytics/index.md +++ b/src/connections/destinations/catalog/localytics/index.md @@ -43,8 +43,6 @@ Whenever you call [`track`](/docs/connections/spec/track/), we'll log an event w Localytics. [`track`](/docs/connections/spec/track/) takes the name of the event and any optional properties you want to associate with the event. -- - - - ## Push Notifications Push notifications on Android require a bit of extra work to setup. diff --git a/src/connections/destinations/catalog/lytics/index.md b/src/connections/destinations/catalog/lytics/index.md index acdb17d7e7..6e0a080bc3 100644 --- a/src/connections/destinations/catalog/lytics/index.md +++ b/src/connections/destinations/catalog/lytics/index.md @@ -7,7 +7,7 @@ id: 54521fd925e721e32a72eed2 1. Lytics uses Segment's JavaScript library so make sure to [go through our quickstart guide to get set up on that first](/docs/connections/sources/catalog/libraries/website/javascript/quickstart/). -2) Once you're recording data enable Lytics on your destination page using your Customer ID number, which can be found in the admin section of your Lytics account: **Account** -> **Manage Accounts**. +2. Once you're recording data enable Lytics on your destination page using your Customer ID number, which can be found in the admin section of your Lytics account: **Account** -> **Manage Accounts**. ![cid](https://lyticspublic.s3.amazonaws.com/images/Segment.io/segment_cid.png) diff --git a/src/connections/destinations/catalog/mailchimp/index.md b/src/connections/destinations/catalog/mailchimp/index.md index 71c51bc974..d520ec9cc6 100644 --- a/src/connections/destinations/catalog/mailchimp/index.md +++ b/src/connections/destinations/catalog/mailchimp/index.md @@ -134,7 +134,7 @@ Again, this will **NOT** work for new users. New users will always have their su Mailchimp doesn't support arrays as traits values. This can cause calls to not show up. #### Why am I seeing a `400 Bad Request` error? -A **400 Bad Request** error can occur if the email address contains a misspelled domain name. For example, Mailchimp might reject`"joe@gmil.com"` because "gmail" is misspelled. +A **400 Bad Request** error can occur if the email address contains a misspelled domain name. For example, Mailchimp might reject `"joe@gmil.com"` because "gmail" is misspelled. #### Why am I seeing frequent `404 Bad Request` errors from Identify events with no error message? diff --git a/src/connections/destinations/catalog/marketo-v2/index.md b/src/connections/destinations/catalog/marketo-v2/index.md index 635c934faa..a0f00ff605 100644 --- a/src/connections/destinations/catalog/marketo-v2/index.md +++ b/src/connections/destinations/catalog/marketo-v2/index.md @@ -1,81 +1,75 @@ --- -title: Marketo V2 Destination +title: Marketo v2 Destination strat: adobe id: 58f8f55a70a3e552b955a444 --- -## Getting Started +## Getting started To start sending data to Marketo, there are two things you must do. **Both of these steps require that you to log in with the Admin Marketo Account.** -### Enter your Marketo Credentials into your Destination settings -We'll need your Munchkin Account ID, Client Secret, and Client ID. - -To get your Munchkin Account ID [login to your Marketo account](https://login.marketo.com/){:target="_blank"}, click Admin in the top right corner, then click Munchkin on the left side bar. +### 1. Enter your Marketo Credentials into your Destination settings +You need to enter your Munchkin Account ID, Client Secret, and Client ID. +To get your Munchkin Account ID, [login to your Marketo account](https://login.marketo.com/){:target="_blank"}, click **Admin**, then **Munchkin** in the side bar. ![A screenshot of a Marketo account.](images/iL42ERv0g5X+.png) - To get your Client Secret and Client ID, you must create a role that has full API access, an API only user, and then create a Service in Marketo. To create a role with full API access: -1. Click **Admin** in the top right corner. -2. Click **Users & Roles** on the left side bar. +1. Click **Admin**. +2. Click **Users & Roles** in the side bar. 3. Click on the **Roles** tab. -4. Click **New Role**. Name your role and check the API Access box to assign the user full API access. Click Create. -![A screenshot of the Create New Role popup in Marketo.](images/cV2x9pHb44g+.png) - +4. Click **New Role**. Name your role and check the API Access box to assign the user full API access. Click **Create**. +![A screenshot of the Create New Role popup in Marketo.](images/cv2x9pHb44g+.png) -Now that you've created an API role, you have to assign that role to an API only user. +Once you've created an API role, you have to assign that role to an API only user. -1. Click the Users tab. -2. Click Invite New User and fill out the necessary information in Step 1. -3. Assign the new role you created to this user in Step 2 and check the API Only box. Click next then Send. +1. Click the **Users** tab. +2. Click **Invite New User** and fill out the necessary information in Step 1. +3. Assign the new role you created to this user in Step 2 and check the API Only box. Click **Next**, then **Send**. ![A screenshot of the Invite New User popup in Marketo.](images/cJkQ9XD6FsE+.png) - Next, create a Service and get Client Secret and Client ID from that Service. -1. Click LaunchPoint on the left side bar. -2. Click New and then New Service from the drop down. -3. Select Custom for the Service from the drop down. -4. Select the new API Only user you invited. This User must be an API Only user **and** be assigned a role that has full API access. +1. Click **LaunchPoint** in the side bar. +2. Click **New > New Service**. +3. Select **Custom for the Service**. +4. Select the new API-Only user you invited. This user must be an API_Only user **and** be assigned a role that has full API access. ![A screenshot of the New Service popup in Marketo.](images/cWwQBeVFto0+.png) -1. Click View Details on the new service that you've created and a small window will display with your Client Secret and Client ID. Copy and paste them into your Destination's Settings. +1. Click **View Details** on the new service that you've created. Your Client Secret and Client ID are displayed in a small window. Copy and paste them into your destination's settings. ![A screenshot of the Marketo Installed Services tab.](images/c3s0qJ-dDSO+.png) +### 2. Create a User ID and an Anonymous ID field in Marketo -### Create a User ID and an Anonymous ID field in Marketo - -1. Click Admin in the top right corner. -2. Click Field Management on the left side bar. -3. Click New Custom Field. -4. Select String as the type. +1. Click **Admin**. +2. Click **Field Management** in the side bar. +3. Click **New Custom Field**. +4. Select **String** as the type. 5. Name the field whatever you'd like. -6. Set the API name to `userId` for the user ID field and then `anonymousId` for the anonymous ID field. **Important:** The API names for the user ID and anonymous ID fields must be `userId` and `anonymousId` exactly. If anything in the API name is different, the destination will not work. +6. Set the API name to `userId` for the user ID field and then `anonymousId` for the anonymous ID field. **Note**: The API names for the user ID and anonymous ID fields must be `userId` and `anonymousId` exactly. If anything in the API name is different, the destination won't work. ![An animation showing someone do the above steps to create User ID and Anonymous ID fields.](images/kzayYEY2JL.gif) ----------- ## Identify ### Cloud-mode -When you call [`Identify`](/docs/connections/spec/identify/) in Cloud-mode, Segment uses [Marketo's REST API](http://developers.marketo.com/rest-api/lead-database/leads/#create_and_update){:target="_blank"} to create and update leads server-side. +When you call [Identify](/docs/connections/spec/identify/) in Cloud-mode, Segment uses [Marketo's REST API](http://developers.marketo.com/rest-api/lead-database/leads/#create_and_update){:target="_blank"} to create and update leads server-side. ### Device-mode -When you call [`Identify`](/docs/connections/spec/identify/) in Device-mode, Segment uses [Marketo's Background Form Submission](https://developers.marketo.com/blog/make-a-marketo-form-submission-in-the-background/){:target="_blank"} to create and update leads client-side. +When you call [Identify](/docs/connections/spec/identify/) in Device-mode, Segment uses [Marketo's Background Form Submission](https://developers.marketo.com/blog/make-a-marketo-form-submission-in-the-background/){:target="_blank"} to create and update leads client-side. -There are additional steps you must take to send `.identify()` calls in Device-mode. +There are additional steps you must take to send Identify calls in Device-mode. 1. Create an empty form in Marketo. This form will always be hidden and can remain empty as long as the traits you need downstream are mapped in the **Marketo Custom Fields** Destination setting. -2. Input the associated **Marketo Form ID** and **Marketo Form URL** in your Marketo V2 Destination settings. This information can be found in Form Actions > Embed Code in the Marketo Design Studio: +2. Input the associated **Marketo Form ID** and **Marketo Form URL** in your Marketo v2 Destination settings. This information can be found in **Form Actions > Embed Code** in the Marketo Design Studio: ![A screenshot of the Embed Code popup in Marketo.](images/form-info.png) > info "" -> **Marketo Form ID** and **Marketo Form URL** are **required** fields for the Marketo SDK to initialize on your site. If these fields are left blank, the SDK will not initialize and data will not be sent downstream. +> **Marketo Form ID** and **Marketo Form URL** are **required** fields for the Marketo SDK to initialize on your site. If these fields are left blank, the SDK won't initialize and data won't be sent downstream. ### Traits -Regardless of connection mode, we'll map the following spec'd Segment traits to Marketo's standard fields: +Regardless of connection mode, following spec'd Segment traits are mapped to Marketo's standard fields: | **Segment Traits** | **Marketo Standard Fields** | | --------------------- | --------------------------- | @@ -112,22 +106,22 @@ analytics.identify('1234', { }); ``` -If you'd like any other traits from your `.identify()` call to update a field in Marketo, you must create custom fields in Marketo and map them in the **Marketo Custom Fields** Destination setting. +If you'd like any other traits from your Identify call to update a field in Marketo, you must create custom fields in Marketo and map them in the **Marketo Custom Fields** Destination setting. ![A screenshot of the Marketo Settings page in Segment.](images/c1X7nf6wDIX+.png) -- **Segment Trait**. The name of the trait sent in your `.identify()` call. -- **Marketo Field Name**. The Marketo REST API name for the field. To get the REST API name for your fields in Marketo, click Field Management, then Export Field Names. A spreadsheet will download and the first column is the REST API name for your Marketo fields. **Make sure to copy and paste the REST API name exactly. This is case sensitive.** -- **Marketo Field Type**. When you are in Field Management, click on the field name in the bar on the right and you'll see the field type. +- **Segment trait**: The name of the trait sent in your Identify call. +- **Marketo field name**: The Marketo REST API name for the field. To get the REST API name for your fields in Marketo, click **Field Management**, then **Export Field Names**. A spreadsheet downloads and the first column is the REST API name for your Marketo fields. **Make sure to copy and paste the REST API name exactly. This is case sensitive.** +- **Marketo field type**: When you are in Field Management, click on the field name to see the field type. ![A screenshot of the Marketo Field Management tab.](images/cubJQKkGLfF+.png) -**Note:** Custom `address` traits must go in the top level `traits` object, not in the `address` object. +**Note**: Custom `address` traits must go in the top level `traits` object, not in the `address` object. ## Track -When you call [`Track`](/docs/connections/spec/track/), Segment maps the event to a pre-defined [Marketo Custom Activity](http://docs.marketo.com/display/public/DOCS/Understanding+Custom+Activities){:target="_blank"}. There are two important things to note when sending `.track()` calls to Marketo: +When you call [Track](/docs/connections/spec/track/), Segment maps the event to a pre-defined [Marketo Custom Activity](http://docs.marketo.com/display/public/DOCS/Understanding+Custom+Activities){:target="_blank"}. There are two important things to note when sending Track calls to Marketo: -1. You **must** map them to your Marketo Custom Activities in your Destination Settings. If you do not map a track call to a Custom Activity in your Destination Settings, we will not send the event to Marketo to help limit the amount of API calls made to Marketo. +1. You **must** map them to your Marketo Custom Activities in your Destination Settings. If you don't map a track call to a Custom Activity in your destination settings, the event won't be sent to Marketo to help limit the amount of API calls made to Marketo. 2. You must either: @@ -135,7 +129,7 @@ When you call [`Track`](/docs/connections/spec/track/), Segment maps the event t - Enable [Device-mode](/docs/connections/destinations/catalog/marketo-v2/#supported-sources-and-connection-modes) and enable the [Send Track Events Server Side](/docs/connections/destinations/catalog/marketo-v2/#send-track-events-server-side) setting - Send track events from one of our [server side libraries](/docs/connections/sources/#server) -Here is a sample Ruby `.track()` event: +Here is a sample Ruby Track event: ```js Analytics.track( @@ -148,30 +142,30 @@ Analytics.track( ![A screenshot of the Destination Settings page in Segment for the Marketo v2 Destination.](images/c2l53wGTCVP+.png) -- **Segment Event Name**. Your Segment Event name. -- **Marketo Activity ID**. When you are in [Marketo Custom Activities](http://docs.marketo.com/display/public/DOCS/Understanding+Custom+Activities){:target="_blank"}, click on the Marketo Activity in the right side bar that you'd like to map your Segment Track event to. Copy and paste the ID into your Destination Settings. +- **Segment event name**: Your Segment Event name. +- **Marketo activity ID**: When you are in [Marketo Custom Activities](http://docs.marketo.com/display/public/DOCS/Understanding+Custom+Activities){:target="_blank"}, click on the Marketo Activity in the right side bar that you'd like to map your Segment Track event to. Copy and paste the ID into your Destination Settings. ![A screenshot of the Marketo Custom Activities page.](images/cwZqHwQfs3M+.png) -- **Segment Property Name**. The name of the property in your `.track()` call. This is case sensitive so make sure the name matches exactly how you are passing it in your `.track()` call. -- **Marketo Field Name**. The name of the Marketo Attribute for your Custom Activity. The Attribute names for a given Custom Activity can be found in the Fields tab of Marketo Custom Attributes. Click on the Custom Activity in the right side bar and a list of your Attributes for that Custom Activity will appear. **Make sure to copy and paste the API Name for your field exactly as it appears in Marketo. This is case sensitive.** +- **Segment property name**: The name of the property in your Track call. This is case sensitive so make sure the name matches exactly how you are passing it in your Track call. +- **Marketo field name**: The name of the Marketo attribute for your Custom Activity. The attribute names for a given Custom Activity can be found in the **Fields** tab of **Marketo Custom Attributes**. Click on **Custom Activity** to see a list of your attributes for that Custom Activity. **Make sure to copy and paste the API Name for your field exactly as it appears in Marketo. This is case sensitive.** ![A screenshot of the Fields tab inside of the Marketo Custom Activities page.](images/cNSP-7ryT72+.png) -- **Marketo Field Type**. The type of the Marketo Attribute. The Attribute type can be found in the Fields tab of Marketo Custom Attributes. Click on the Custom Activity in the right side bar and a list of your Attributes for that Custom Activity will appear. +- **Marketo field type**: The type of the Marketo attribute. The attribute type can be found in the **Fields** tab of **Marketo Custom Attributes**. Click on **Custom Activity** to see a list of your attributes for that Custom Activity. ![A screenshot of the Fields tab inside of the Marketo Custom Activities page.](images/cIBsfYeh2B8+.png) -- **Primary Field**. When creating a Custom Activity in Marketo, you have to set a Primary Field. If you are unsure which field was set as the primary field, when you are looking at the list of fields for your Custom Activity in Marketo, there will be a red star next to your Primary Field. +- **Primary field**. When creating a Custom Activity in Marketo, you have to set a Primary Field. If you are unsure which field was set as the primary field, when you are looking at the list of fields for your Custom Activity in Marketo, primary fields are denoted by a red star. ![A screenshot of the Fields tab inside of the Marketo Custom Activities page.](images/cZuvsHeaepX+.png) > info "" -> You can't map fields nested in objects as Marketo Custom Activity property names. You must flatten any objects you may need to access data from either before you send it to Segment, or while using an [Insert Function](/docs/connections/functions/insert-functions/). +> You can't map fields nested in objects as Marketo Custom Activity property names. You must flatten any objects you may need to access data from either before you send it to Segment, or while using an [Insert function](/docs/connections/functions/insert-functions/). ## Page -When you call [`Page`](/docs/connections/spec/page/), Segment uses [Marketo's Munchkin.js `visitWebPage` method](http://developers.marketo.com/javascript-api/lead-tracking/api-reference/#munchkin_visitwebpage){:target="_blank"}. The URL is built from your `.page()` event and properties object into the form Marketo expects, so no need to worry about doing that yourself. +When you call [Page](/docs/connections/spec/page/), Segment uses [Marketo's Munchkin.js `visitWebPage` method](http://developers.marketo.com/javascript-api/lead-tracking/api-reference/#munchkin_visitwebpage){:target="_blank"}. The URL is built from your Page event and properties object into the form Marketo expects, so no need to worry about doing that yourself. -Marketo's `visitWebPage` method requires a URL and a user agent. Any calls that are missing either of these fields will not be sent to Marketo. User agent is automatically collected Client-side but if you are sending `.page()` calls from the server, make sure to set the user agent. +Marketo's `visitWebPage` method requires a URL and a user agent. Any calls that are missing either of these fields aren't sent to Marketo. User agent is automatically collected client-side but if you are sending Page calls from the server, make sure to set the user agent. -Here is a sample Node `.page()` event: +Here is a sample Node Page event: ```js analytics.page({ @@ -191,20 +185,25 @@ Here is a sample Node `.page()` event: ``` -## Tracking Anonymous Activity in Marketo +## Tracking anonymous activity in Marketo -If you would only like to track known users in Marketo, set your Track Anonymous Activity setting to false. There are a couple things to note when this setting is false: +If you'd only like to track known users in Marketo, set your Track Anonymous Activity setting to `false`. There are some things to note when this setting is false: -1. Any call without a User ID will be rejected. -2. No anonymous activity will be sent to Marketo. Even after the user becomes known, none of their previous anonymous activity will be sent to Marketo. +1. Calls without a User ID are rejected. +2. No anonymous activity is sent to Marketo. Even after the user becomes known, none of their previous anonymous activity will be sent to Marketo. -If you'd like to track anonymous activity but don't want to have to parse through or view unknown leads, Marketo lets you create Smart Lists that will filter your leads (i.e. if you'd only like to view leads that have a user ID or an email). To do this, when you are in your Lead Database, click All Leads, then New. From the drop down, click New Smart List. Select the folder you'd like the Smart List to live in. After you've created the Smart List, select what field you'd like to filter by on the right side bar, drag it to the filters and then select what you'd specifically like to filter by for that field. +If you'd like to track anonymous activity but don't want to have to parse through or view unknown leads, Marketo lets you create Smart Lists that filter your leads. For example, you can filter to only view leads that have a user ID or an email. To do this, when you are in your Lead Database: + +1. Click **All Leads**, then **New**. +2. From the drop down, click **New Smart List**. +3. Select the folder you'd like the Smart List to live in. +4. After you've created the Smart List, select what field you'd like to filter by, drag it to the filters and then select what you'd specifically like to filter by for that field. ![An animation showing a Smart List being created.](images/5bxmcClCgU.gif) -## Marketo API Limits +## Marketo API limits -We do our best to limit the amount of API calls that we are making to Marketo but if you are hitting your 50k/day limit, we'd recommend only sending events to Marketo that you need. To prevent an event from being sent to Marketo, you can select destinations by doing the following: +Segment tries to limit the amount of API calls being made to Marketo but if you are hitting the 50 k/day limit, Segment recommends only sending events to Marketo that you need. To prevent an event from being sent to Marketo, you can select destinations by doing the following: ```js analytics.identify({ @@ -213,68 +212,74 @@ We do our best to limit the amount of API calls that we are making to Marketo bu firstName: 'Alex' }, integrations: { - 'Marketo V2': false, + 'Marketo v2': false, 'Google Analytics': true } }) ``` -## Hybrid Device/Cloud-mode -Another option is to use Marketo in [Device-mode](/docs/connections/destinations/catalog/marketo-v2/#supported-sources-and-connection-modes) (assuming you are tracking events from a Website). Marketo does not limit API calls that originate from their Web SDK but it also only supports capturing Identify and Page events. If you would also like to capture Track events, you can choose to have these be routed through our server-side integration. +## Hybrid device or cloud-mode +Another option is to use Marketo in [device-mode](/docs/connections/destinations/catalog/marketo-v2/#supported-sources-and-connection-modes) (assuming you are tracking events from a website). Marketo does not limit API calls that originate from its web SDK, but it only supports capturing Identify and Page events. If you'd also like to capture Track events, you can choose to have these be routed through Segment's server-side integration. -To enable this "Hybrid" mode, select the [Send Track Events Server Side](/docs/connections/destinations/catalog/marketo-v2/#send-track-events-server-side) setting and follow the instructions for mapping [Track](/docs/connections/destinations/catalog/marketo-v2/#track) events defined above. +To enable this "Hybrid" mode, select the **[Send Track Events Server Side](/docs/connections/destinations/catalog/marketo-v2/#send-track-events-server-side)** setting and follow the instructions for mapping [Track](/docs/connections/destinations/catalog/marketo-v2/#track) events. ## Preventing Duplicate Leads -Marketo allows you to upsert leads based on any field. We use email and userId as well as anonymousId if you are tracking anonymous activity. We will first use email since that is the field Marketo recommends is unique for your leads. However, many `.track()` and `.page()` calls don't include an email address so then we will use the `userId` or `anonymousId` passed in your `.track()` and `.page()` calls to associate these events to leads in Marketo. +Marketo allows you to upsert leads based on any field. Segment uses `email` and `userId`, as well as `anonymousId` if you are tracking anonymous activity. `email` is used first since that is the field Marketo recommends is unique for your leads. However, many Track and Page calls don't include an email address. In that case, Segment uses the `userId` or `anonymousId` passed in your Track and Page calls to associate these events to leads in Marketo. You can do one of the following to prevent duplicate leads: +**Recommended: Upload a CSV adding your userId to all your leads in Marketo _before_ enabling the destination**. -1. **Recommended:** Upload a CSV adding your userId to all your leads in Marketo **before** enabling the destination. After you [create the userId field](/docs/connections/destinations/catalog/marketo-v2/#2-you-must-create-a-user-id-and-an-anonymous-id-field-in-marketo) in Marketo, you can upload a list of all your users with an email column and a userId column. Your CSV should look like this: +After you [create the `userId` field](/docs/connections/destinations/catalog/marketo-v2/#2-you-must-create-a-user-id-and-an-anonymous-id-field-in-marketo) in Marketo, you can upload a list of all your users with an email column and a userId column. Your CSV should look like this: | **email** | **userId** | | ----------------- | ---------- | | alex@email.com | ABC1234 | | natasha@email.com | XYZ9876 | -To upload a list to Marketo, when you are in Lead Database, click All Leads. Then click "New", then "Import List" from the drop down. Select your CSV, then click "Next". Make sure "Email Address" and "userId" are the Marketo Fields selected then click "Next". Name your list or select a pre-existing list. Select "None" for Acquisition Program. Then Click "Import". - -2. Manually merge leads in Marketo. Follow [these instructions to merge](http://docs.marketo.com/display/public/DOCS/Find+and+Merge+Duplicate+People){:target="_blank"} any duplicate leads found in Marketo after enabling the destination. -3. Make sure to call identify first. This is already a recommended best practice as [part of our spec](/docs/connections/spec/identify/). -4. Pass an email in your `.track()` and `.page()` calls. +To upload a list to Marketo, when you are in Lead Database: -## Migrating from Marketo to Marketo V2 +1. Click **All Leads**. +2. Then click **New**, then **Import List**. +3. Select your CSV, then click **Next**. Make sure `Email Address` and `userId` are the Marketo Fields selected then click **Next"**. +4. Name your list or select a pre-existing list. Select **None** for Acquisition Program. Then click **Import**. -There are a few necessary steps that have to be taken to migrate from Segment's legacy Marketo v1 destinations, to Marketo V2. +**Manually merge leads in Marketo**. -**Important: Make sure you disable Marketo once you are done getting set up with Marketo V2. If you leave both enabled, there will likely be duplicate data in your Marketo account.** +Follow [Marketo's instructions to merge](http://docs.marketo.com/display/public/DOCS/Find+and+Merge+Duplicate+People){:target="_blank"} any duplicate leads found in Marketo after enabling the destination. +1. Make sure to call Identify first. This is already a recommended best practice as [part of the Segment spec](/docs/connections/spec/identify/). +2. Pass an email in your Track and Page calls. -1. Your Marketo credentials in your Segment Destination settings need to be updated. Our Marketo Destination used Marketo's SOAP API and Marketo V2 uses Marketo's REST API which requires different credentials. Check out the [Getting Started](/docs/connections/destinations/catalog/marketo-v2/#getting-started) guide for what credentials you'll need. -2. Two custom fields must be created in Marketo: userId and anonymousId. Check out [Getting Started](/docs/connections/destinations/catalog/marketo-v2/#2-you-must-create-a-user-id-and-an-anonymous-id-field-in-marketo) for exact details on how to create these custom fields in Marketo. -3. `Track` calls must be mapped in your Destination settings. Our Marketo Destination sent `track` calls as a Munchkin Visit WebPage event in Marketo. In Marketo V2, we'll send your track calls to your Marketo Custom Activities. Detailed instructions [in the Track section of this page](/docs/connections/destinations/catalog/marketo-v2/#track). -4. If there are any custom Lead fields that you'd like sent to Marketo in your `Identify` calls, you must create custom fields in Marketo and add them in your Destination settings. In addition, if you are connecting Marketo V2 in Device-mode, an empty form must be created in Marketo to create and update leads. Detailed instructions [in the Identify section of this page](/docs/connections/destinations/catalog/marketo-v2/#identify). -5. Update anything in Marketo that rely on the way V1 sends `.track()` events to be triggered by your custom activities. For example, our V1 Marketo destination sent track events as a "Visit Web Page" event with `/event/`. So if you a workflow that is triggered by a "Visit Web Page" event where the web page contains `/event/`, you'll have to swap out the "Visit Web Page" event trigger you have with your Custom Attribute Trigger. In the right side bar, click the "Custom" folder under "Triggers" and select the trigger that you set for your custom activity: - ![A screenshot of the Smart List tab in Marketo.](images/cPD4kP65buG+.png) +## Migrating from Marketo to Marketo v2 +There are a few necessary steps that have to be taken to migrate from Segment's legacy Marketo v1 destinations, to Marketo v2. - To figure out what the trigger name for that Custom Activity is, navigate to the admin section of Marketo > Marketo Custom Activities > Click on your activity from the side bar and you'll see the trigger name: +> warning "" +> Make sure you disable Marketo once you set up with Marketo v2. If you leave both enabled, there might be duplicate data in your Marketo account. +1. Your Marketo credentials in your Segment Destination settings need to be updated. The Marketo destination used Marketo's SOAP API and Marketo v2 uses Marketo's REST API which requires different credentials. Check out the [getting started in Marketo v2](/docs/connections/destinations/catalog/marketo-v2/#getting-started) guide for the credentials you need. +2. Two custom fields must be created in Marketo: `userId` and `anonymousId`. Check out [getting started in Marketo v2](/docs/connections/destinations/catalog/marketo-v2/#2-you-must-create-a-user-id-and-an-anonymous-id-field-in-marketo) for exact details on how to create these custom fields in Marketo. +3. Track calls must be mapped in your destination settings. The Marketo Destination sent Track calls as a Munchkin Visit WebPage event in Marketo. In Marketo v2, your track calls are sent to your Marketo Custom Activities. See the instructions [in the Track section](/docs/connections/destinations/catalog/marketo-v2/#track) for more detail. +4. If there are any custom lead fields that you'd like sent to Marketo in your Identify calls, you must create custom fields in Marketo and add them in your destination settings. In addition, if you are connecting Marketo v2 in device-mode, an empty form must be created in Marketo to create and update leads. See the instructions [in the Identify section](/docs/connections/destinations/catalog/marketo-v2/#identify) for more detail. +5. Update anything in Marketo that rely on the way v1 sends Track events to be triggered by your custom activities. For example, the v1 Marketo destination sent track events as a "Visit Web Page" event with `/event/`. So if you have a workflow that is triggered by a "Visit Web Page" event where the web page contains `/event/`, you need to swap out the "Visit Web Page" event trigger with your Custom Attribute Trigger. Click the **Custom** folder under **Triggers** and select the trigger that you set for your custom activity: + ![A screenshot of the Smart List tab in Marketo.](images/cPD4kP65buG+.png) + > To figure out what the trigger name for that Custom Activity is, navigate to the **Admin** section of **Marketo > Marketo Custom Activities**, then click on your activity to see the trigger name: ![A screenshot of the Marketo Custom Activities field.](images/cg6YhDEPWXv+.png) +6. When enabling Marketo v2, because of the way Marketo's API works, there is potential to create duplicate leads, especially when the first enabling the destination. For ways to prevent this, check out the [Preventing Duplicate Leads](https://nation.marketo.com/t5/knowledgebase/working-with-duplicate-leads/ta-p/248189){:target="_blank"}. -6. When enabling Marketo V2, because of the way Marketo's API works, there is potential to create duplicate leads, especially when the first enabling the destination. For ways to prevent this, check out the Preventing Duplicate Leads. +## Send a single source's data to multiple Marketo v2 workspaces -## Send a single source's data to multiple Marketo V2 workspaces +Segment doesn't support multiple instances of Marketo v2 for any source in Segment (for both Device-Mode and Cloud-Mode). If you need a single source's data sent to multiple Marketo v2 workspaces, follow the instructions on configuring a [Repeater destination](/docs/connections/destinations/catalog/repeater/) to route your source's data through the Repeater destination into a new source and new Marketo v2 destination instance. -Segment doesn't support multiple instances of Marketo V2 for any source in Segment (for both Device-Mode and Cloud-Mode). If you need a single source's data sent to multiple Marketo V2 workspaces, follow the instructions on configuring a [Repeater destination](/docs/connections/destinations/catalog/repeater/) to route your source's data through the Repeater destination into a new source and new Marketo V2 destination instance. -To create a Repeater destination, new source, and second Marketo V2 destination: +To create a Repeater destination, new source, and second Marketo v2 destination: 1. Create and connect a new [Repeater destination](https://app.segment.com/goto-my-workspace/destinations/catalog/repeater) to your source and select the intended source. -2. Click **Add destination**, name the destination, and select Fill in settings manually. -4. Create a new source, then navigate to **Settings > API Keys** and copy the **Write Key** value. -- From the Repeater destination's **Settings** page, you'll find **Write Keys** in the **Connection Settings**. This is where your second source's write key from step 4 will go. +2. Click **Add destination**, name the destination, and select **Fill in settings manually**. +3. Create a new source, then navigate to **Settings > API Keys** and copy the **Write Key** value. + > From the Repeater destination's **Settings** page, find **Write Keys** in the **Connection Settings**. This is where your second source's write key from step 4 will go. 5. Navigate back to your Repeater destination and paste in the source's `writeKey` into the write key setting. -6. Add a Marketo V2 destination to your new source with the desired configuration settings. -7. Enable the Repeater destination, new source, new Marketo V2 destination. -8. You'll begin seeing data transmitted from your originating source to the Repeater Destination (Event Delivery), then to the new source (Debugger), and finally to the Marketo V2 destination (Event Delivery). +6. Add a Marketo v2 destination to your new source with the desired configuration settings. +7. Enable the Repeater destination, new source, new Marketo v2 destination. +8. Data is now transmitted from your originating source to the Repeater Destination (Event Delivery), then to the new source (Debugger), and finally to the Marketo v2 destination (Event Delivery). diff --git a/src/connections/destinations/catalog/marketo/index.md b/src/connections/destinations/catalog/marketo/index.md index 0012bc552e..deda0dc315 100644 --- a/src/connections/destinations/catalog/marketo/index.md +++ b/src/connections/destinations/catalog/marketo/index.md @@ -3,27 +3,27 @@ title: Marketo Destination strat: adobe --- -## Getting Started +## Getting started When you enable Marketo in the Segment web app, your changes appear in the Segment CDN in about 45 minutes, and then Analytics.js starts asynchronously loading Marketo's Munchkin onto your page. This means you should remove Marketo's snippet from your page. -+ Marketo starts automatically recording visitor information. -### Important Note: -Our client-side and server-side destinations each require **different** credentials for authentication. Read through the information below on `identify` calls for further information. +> info "" +> Marketo starts automatically recording visitor information. -- - - +> warning "" +> Client-side and server-side destinations each require **different** credentials for authentication. Read through [Identify](#identify) for further information. ## Page and Track -For [`Page`](/docs/connections/spec/page/) or [`Track`](/docs/connections/spec/track/) methods, Segment uses [Marketo's Munchkin.js `visitWebPage` method](http://developers.marketo.com/javascript-api/lead-tracking/api-reference/#munchkin_visitwebpage){:target="_blank"}. The URL is built from the Segment event and properties object into the form Marketo expects, so no need to worry about doing that yourself. +For [Page](/docs/connections/spec/page/) or [Track](/docs/connections/spec/track/) methods, Segment uses [Marketo's Munchkin.js `visitWebPage` method](http://developers.marketo.com/javascript-api/lead-tracking/api-reference/#munchkin_visitwebpage){:target="_blank"}. The URL is built from the Segment event and properties object into the form Marketo expects, so no need to worry about doing that yourself. -To associate Track events to a particular Lead in Marketo from a server side library, you will need to pass the Munchkin.js cookie with your track calls. +To associate Track events to a particular Lead in Marketo from a server side library, you need to pass the Munchkin.js cookie with your track calls. ## Identify ### Client-side -When you call [`identify`](/docs/connections/spec/identify/) on Analytics.js, we call Marketo's [`associateLead`](http://developers.marketo.com/documentation/websites/lead-tracking-munchkin-js/){:target="_blank"}. Marketo **requires an email address** for this function, so if the `traits` object you include in [`identify`](/docs/connections/spec/identify/) doesn't have an email, the request won't go through. Marketo's client-side library, [Munchkin](http://developers.marketo.com/documentation/websites/lead-tracking-munchkin-js/){:target="_blank"}, **requires your API private key** for authentication along with your email, so make sure that you have provided it in your Segment settings. We will not change the casing of traits on client-side identify calls. +When you call [Identify](/docs/connections/spec/identify/) on Analytics.js, Segment calls Marketo's [`associateLead`](http://developers.marketo.com/documentation/websites/lead-tracking-munchkin-js/){:target="_blank"}. Marketo **requires an email address** for this function, so if the `traits` object you include in [Identify](/docs/connections/spec/identify/) doesn't have an email, the request won't go through. Marketo's client-side library, [Munchkin](http://developers.marketo.com/documentation/websites/lead-tracking-munchkin-js/){:target="_blank"}, **requires your API private key** for authentication along with your email, so make sure that you have provided it in your Segment settings. Segment doesn't change the casing of traits on client-side identify calls. ```javascript analytics.identify('1234', { @@ -34,21 +34,21 @@ analytics.identify('1234', { }); ``` -In order to properly sign the `associateLead` request while keeping your account and data secure, we make a request to our API that calculates the appropriate SHA1 security hash for the user you're identifying. We use this hash to sign the `associateLead` request to Marketo. +In order to properly sign the `associateLead` request while keeping your account and data secure, Segment makes a request to our API that calculates the appropriate SHA1 security hash for the user you're identifying. This hash is used to sign the `associateLead` request to Marketo. -Note that we will automatically send `userId` as a trait. Normally, the `userId` was sent as an `id` inside the traits but Marketo silently ignores that field as they use it for their own purposes. So if you create a custom field inside Marketo for `userId`, your leads will automatically have that field populated. +Note that Segment automatically sends `userId` as a trait. Normally, the `userId` was sent as an `id` inside the traits but Marketo silently ignores that field as they use it for their own purposes. So if you create a custom field inside Marketo for `userId`, your leads automatically have that field populated. ### Server Side -When you can [`identify`](/docs/connections/spec/identify/) with a `traits` object on any of the server-side languages, we make a call to Marketo's `syncLead` SOAP API action. This call either creates or a updates `traits` on a lead based on the email address either in `userId` or `traits.email`. +When you call [Identify](/docs/connections/spec/identify/) with a `traits` object on any of the server-side languages, Segment makes a call to Marketo's `syncLead` SOAP API action. This call either creates or a updates `traits` on a lead based on the email address either in `userId` or `traits.email`. -We will attempt to PascalCase server-side traits. So if you send `secondFavoriteColor` as a trait, we will convert that to `SecondFavoriteColor`, so you should set the trait **API name** in Marketo to `SecondFavoriteColor`. If you send the trait as `second_favorite_color`, we will convert that to `Second_favorite_color`, so you should set the API name to be `Second_favorite_color` (this is less than ideal; however, we plan to update this behavior in v2 of our Marketo destination, so stay tuned!). +Segment attempts to PascalCase server-side traits. So if you send `secondFavoriteColor` as a trait it's converted to `SecondFavoriteColor`, so you should set the trait **API name** in Marketo to `SecondFavoriteColor`. If you send the trait as `second_favorite_color` it's converted to `Second_favorite_color`, so you should set the API name to be `Second_favorite_color`. -Note that leads can only be synced every 30 seconds using the SOAP API. If you exceed the allowed request amount, you will see `Exceeded lock attempts` errors in your debugger. +Note that leads can only be synced every 30 seconds using the SOAP API. If you exceed the allowed request amount, the `Exceeded lock attempts` errors appear in your debugger. -Our server side destination with Marketo **requires your encryption key** along with your email for authentication, make sure you have provided it in your Segment settings. +The server-side destination with Marketo **requires your encryption key** along with your email for authentication, make sure you have provided it in your Segment settings. -Remember to provide an email with every call as either the `userId` or as a trait labeled "email". Here's a java example of that: +Remember to provide an email with every call as either the `userId` or as a trait labeled "email". Here's a Java example of that: ```java Analytics.identify("hj2kf92ds212", @@ -59,13 +59,13 @@ Analytics.identify("hj2kf92ds212", Marketo uses cookies to keep track of visitors and their sessions while visiting your website. The cookie data is stored in the visitor's browser, and is sent along to Marketo every time a new event occurs. This allows them to show a single unique lead between multiple page reloads. -Your servers also have access to this cookie, so they can re-use it when you send server-side events to Segment. If you don't use the existing cookie Segment will use either the userId or sessionId to make the server-side request to Marketo. When we create a new cookie, the client-side and server-side events from the same user will look like two distinct leads when viewed in Marketo. The cookieId takes precedence over all other keys, so if you send both the cookieId and the userId - the cookieId will match first and the userId for that lead will be updated. +Your servers also have access to this cookie, so they can re-use it when you send server-side events to Segment. If you don't use the existing cookie, Segment uses either the `userId` or `sessionId` to make the server-side request to Marketo. When a new cookie is created, the client-side and server-side events from the same user look like two distinct leads when viewed in Marketo. The `cookieId` takes precedence over all other keys, so if you send both the `cookieId` and the `userId` - the `cookieId` matches first and the `userId` for that lead is updated. To associate leads in server-side Marketo, there are currently three options with Segment: 1. Pass your Marketo cookies to Segment. -2. Use the userId or sessionId when associating leads in Marketo. -3. Ignore the additional visitors generated by passing different types of ids for each call (i.e. cookieId once, then the userId for the same user the second time). +2. Use the `userId` or `sessionId` when associating leads in Marketo. +3. Ignore the additional visitors generated by passing different types of IDs for each call - `cookieId` once, then the `userId` for the same user the second time. If you choose to pass the cookie with your calls, it will look like this: @@ -73,7 +73,7 @@ If you choose to pass the cookie with your calls, it will look like this: id:561-HYG-937&token:_mch-marketo.com-1374552656411-90718 ``` -If you want our server-side destination to use your user's Marketo Cookie, pass it to us in the `context['Marketo'].marketoCookie` object. +If you want our server-side destination to use your user's Marketo Cookie, pass it to Segment in the `context['Marketo'].marketoCookie` object. Here's a Ruby example: @@ -93,9 +93,9 @@ Analytics.identify( ) ``` -**Note:** If you choose to use the cookie approach, make sure to send the cookie along in your `track` calls as well, as Marketo will need it on subsequent calls to tie activity to that user. +**Note:** If you choose to use the cookie approach, make sure to send the cookie along in your Track calls as well. Marketo needs it on subsequent calls to tie activity to that user. -A `track` call might look like this: +A Track call might look like this: ```ruby Analytics.track( @@ -114,10 +114,10 @@ Analytics.track( ) ``` -For more information about syncronising your Marketo leads, [visit their documentation](http://developers.marketo.com/documentation/soap/synclead/){:target="_blank"}. +For more information about syncronising your Marketo leads, [visit the Marketo documentation](http://developers.marketo.com/documentation/soap/synclead/){:target="_blank"}. -### Custom Fields +### Custom fields -To create a custom field in Marketo, follow Marketo's [documentation for creating a custom field](http://docs.marketo.com/display/public/DOCS/Create+a+Custom+Field+in+Marketo){:target="_blank"}. Be sure that the **API Name** is `PascalCase`'d, as our destination will account for Marketo's Pascal trait standards. +To create a custom field in Marketo, follow Marketo's [documentation for creating a custom field](http://docs.marketo.com/display/public/DOCS/Create+a+Custom+Field+in+Marketo){:target="_blank"}. Be sure that the **API Name** is `PascalCase`'d, as the destination accounts for Marketo's Pascal trait standards. -For instance, if you configure `SomeTrait` in the **API Name** field (the **Name** value does not matter), you can pass in this field as `someTrait`, and we will convert this to `SomeTrait` when sending into Marketo. Note that if you configured **API Name** to be `someTrait`, and passed it in as `someTrait` in your call, this would fail to send. +For instance, if you configure `SomeTrait` in the **API Name** field (the **Name** value does not matter), you can pass in this field as `someTrait`. Segment converts this to `SomeTrait` when sending into Marketo. Note that if you configured **API Name** to be `someTrait` and passed it in as `someTrait` in your call, this would fail to send. diff --git a/src/connections/destinations/catalog/matomo/index.md b/src/connections/destinations/catalog/matomo/index.md index 05fd9b04a1..9435ea6470 100644 --- a/src/connections/destinations/catalog/matomo/index.md +++ b/src/connections/destinations/catalog/matomo/index.md @@ -7,17 +7,15 @@ id: 54521fda25e721e32a72eee7 [Matomo](https://matomo.org/){:target="_blank"}, formerly Piwik, is the leading open source web analytics platform that gives you valuable insights into your website's visitors, your marketing campaigns and much more, so you can optimize your strategy and online experience of your visitors. Segment’s Matomo destination code is open-source and can be viewed on GitHub: -- [Javascript](https://github.com/segmentio/analytics.js-integrations/blob/master/integrations/piwik/lib/index.js){:target="_blank"} - -## Getting Started - +- [Javascript](https://github.com/segmentio/analytics.js-integrations/blob/master/integrations/piwik/lib/index.js){:target="_blank"}. +## Getting started 1. From the Segment web app, click **Catalog**. -2. Search for "Matomo" in the Catalog, select it, and choose which of your sources to connect the destination to. Note the source must be sending events using our JavaScript library Analytics.js. +2. Search for "Matomo" in the Catalog, select it, and choose which of your sources to connect the destination to. Note the source must be sending events using the Segment JavaScript library Analytics.js. 3. In the destination settings, enter your Site ID. You can find your Site ID in your Matomo snippet. -4. In the destination settings, enter your Server URL. You can find your Server URL in your snippet, we will append /matomo.php to the URL automatically. - 5. When you enable Matomo in your Segment settings, Segment's CDN is updated within 45 minutes. Once that happens, Segment asynchronously loads `matomo.js` on your page whenever it is loaded. This means you should remove Matomo's snippet from your page. +4. In the destination settings, enter your Server URL. You can find your Server URL in your snippet. Segment automatically appends /matomo.php to the URL. +5. When you enable Matomo in your Segment settings, Segment's CDN is updated within 45 minutes. Once that happens, Segment asynchronously loads `matomo.js` on your page whenever it is loaded. This means you should remove Matomo's snippet from your page. ## Page If you're not familiar with the Segment Specs, take a look to understand what the [Page method](/docs/connections/spec/page/) does. An example call would look like: @@ -25,8 +23,7 @@ If you're not familiar with the Segment Specs, take a look to understand what th ```js analytics.page(); ``` - -Our Page method triggers a call to Matomo's `trackPageView` method. +The Page method triggers a call to Matomo's `trackPageView` method. ## Identify If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](/docs/connections/spec/identify/) does. An example call would look like: @@ -34,7 +31,7 @@ If you're not familiar with the Segment Specs, take a look to understand what th ```js analytics.identify('97980cfea0068'); ``` -Our Identify method triggers a call to Matomo's `setUserId` method and will send the `userId` to Matomo. +The Identify method triggers a call to Matomo's `setUserId` method and will send the `userId` to Matomo. ## Track If you're not familiar with the Segment Specs, take a look to understand what the [Track method](/docs/connections/spec/track/) does. An example call would look like: @@ -43,9 +40,9 @@ If you're not familiar with the Segment Specs, take a look to understand what th analytics.track('Logged In'); ``` -We'll record a Matomo event whenever you make a `track` call. +Segement records a Matomo event whenever you make a `track` call. -For the example above, these event attributes are sent to Matomo: +In the example, these event attributes are sent to Matomo: @@ -58,7 +55,7 @@ For the example above, these event attributes are sent to Matomo:
-Find below another Track example, this time with all the available Matomo event parameters: +See the following Track example, this time with all the available Matomo event parameters: ```js analytics.track('Created Account', { @@ -68,7 +65,7 @@ analytics.track('Created Account', { }) ``` -That call will create a Matomo Event with these attributes: +That call creates a Matomo Event with these attributes: @@ -89,17 +86,18 @@ That call will create a Matomo Event with these attributes:
-For **Event Value** you can name the event property `value` or `revenue`. We'll look for `value` first, then fall back to `revenue`. +For **Event Value**, you can name the event property `value` or `revenue`. Segment looks for `value` first, then fall back to `revenue`. -## Best Pratices +## Best practices -Matomo allows you to set [custom variables](http://matomo.org/docs/custom-variables/){:target="_blank"} with your pageviews and events. With Segment, you can set page-scoped custom variables with any `track` call you make with analytics.js. +Matomo lets you set [custom variables](http://matomo.org/docs/custom-variables/){:target="_blank"} with your pageviews and events. With Segment, you can set page-scoped custom variables with any Track call you make with analytics.js. -Since these custom variables must be mapped to an index you define, which can change from call to call, the only way we can support these custom variables with full flexibility is to allow you to pass your map in the `context.Matomo.customVars` dictionary of each call. +Since these custom variables must be mapped to an index you define, which can change from call to call, the only way that Segment can support these custom variables with full flexibility is to allow you to pass your map in the `context.Matomo.customVars` dictionary of each call. -To take advantage of this feature, your `track` calls should look like this: +To take advantage of this feature, your Track calls should look like this: -> **Note** The destination's name is still "piwik" in the JSON for these calls. +> info "" +> The destination's name is still "piwik" in the JSON for these calls. ```js analytics.track('event', { @@ -117,6 +115,6 @@ analytics.track('event', { ``` ### Goals -If you want to flag specific events as Matomo Goals you can do so by mapping those events in your Segment Source Destinations page under Matomo Settings. +If you want to flag specific events as Matomo Goals, you can do so by mapping those events in your Segment Source Destinations page under Matomo Settings. -Fill in the event on the left and the Goal ID from Matomo on the right. Then every time the event happens we'll fire Matomo's `trackGoal` method. +Fill in the event on the left and the Goal ID from Matomo on the right. Then every time the event happens Segment fires Matomo's `trackGoal` method. diff --git a/src/connections/destinations/catalog/mixpanel/index.md b/src/connections/destinations/catalog/mixpanel/index.md index 05fe21e16c..2ec9b89a3b 100644 --- a/src/connections/destinations/catalog/mixpanel/index.md +++ b/src/connections/destinations/catalog/mixpanel/index.md @@ -337,7 +337,6 @@ analytics.track({ Segment doesn't map `$library_version` since that is reserved for Mixpanel's library version, not Segment's. Segment doesn't map to `$brand`. -- - - ## Features diff --git a/src/connections/destinations/catalog/moengage/index.md b/src/connections/destinations/catalog/moengage/index.md index a999d033f4..4ef7a54b7c 100644 --- a/src/connections/destinations/catalog/moengage/index.md +++ b/src/connections/destinations/catalog/moengage/index.md @@ -5,12 +5,11 @@ id: 55b280290a20f4e22f0fb3d6 hide-personas-partial: true --- -[MoEngage](https://www.moengage.com/){:target="_blank"} is an Intelligent Customer Engagement Platform. MoEngage allows brands to personalize every customer interaction and drive better engagement, retention, loyalty and lifetime value. +[MoEngage](https://www.moengage.com/){:target="_blank"} is an intelligent customer engagement platform. MoEngage allows brands to personalize every customer interaction and drive better engagement, retention, loyalty and lifetime value. -The MoEngage and Segment integration allows you to send -the users you have tracked on Segment, along with their route data, to MoEngage for further targeting and campaigning. This Destination enables you to: +The MoEngage and Segment integration allows you to send the users you have tracked on Segment, along with their route data, to MoEngage for further targeting and campaigning. This destination enables you to: -- **Import data from Segment to MoEngage**: Moengage offers a side-by-side (device mode) SDK integration for your Android, iOS, and web applications and a server-to-server integration for your backend services. +- **Import data from Segment to MoEngage**: Moengage offers a side-by-side (device-mode) SDK integration for your Android, iOS, and web applications and a server-to-server integration for your backend services. - **Sync [Twilio Engage](https://segment.com/product/twilio-engage){:target="_blank"} (cohorts)**: Send Segment Cohorts to MoEngage for use in MoEngage Segments and campaigns. The MoEngage Destination source code is open-sourced and freely available on GitHub for anyone to view: @@ -21,33 +20,31 @@ Connection Mode | Maintained by | GitHub Link Android | MoEngage | [moengage-segment-integration](https://github.com/moengage/moengage-segment-integration){:target="_blank"} Web | Segment | [analytics.js-integrations](https://github.com/segmentio/analytics.js-integrations/tree/master/integrations/moengage){:target="_blank"} -## Getting Started +## Getting started -Once you add the Segment-MoEngage library to your app, you can enable MoEngage from the Segment App. These new settings can take up to an hour to propagate to your existing users. For new users, it'll be instantaneous! +Once you add the Segment-MoEngage library to your app, you can enable MoEngage from the Segment App. These new settings can take up to an hour to propagate to your existing users. For new users, the settings are propagated instantly. The Segment-MoEngage Integration is a bundled integration, meaning it requires that you add a client-side integration to your app. -## Setup MoEngage in your Segment Workspace +## Setup MoEngage in your Segment workspace To setup MoEngage do the following : - 1. First get your key(AppID) from the MoEngage dashboard. Navigate to `Dashboard --> Settings --> App --> General`. - 2. Go to your **Segment workspace**, go to **Destinations** and select **MoEngage**. + 1. First get your key(AppID) from the MoEngage dashboard. Navigate to **Dashboard > Settings > App > General**. + 2. In your Segment workspace, go to **Destinations** and select **MoEngage**. 3. Enable the MoEngage Destination. - 4. Go to the MoEngage Settings and enter the MoEngage AppID, obtained in **Step1**. + 4. Go to the MoEngage Settings and enter the MoEngage AppID, obtained in Step 1. 5. Save the changes. - 6. Make sure you set the **Connection Mode** to `Device Mode`. MoEngage requires this setting to use - of features like push notifications and any in-app features of the MoEngage SDK. + 6. Make sure you set the **Connection Mode** to `Device Mode`. MoEngage requires this setting to use of features like push notifications and any in-app features of the MoEngage SDK. -These new settings will take up to an hour to propagate to your existing users. For new -users it'll be instantaneous! Segment-MoEngage Integration is a bundled integration, requires client side integration. +Segment-MoEngage Integration is a bundled integration and requires client-side integration. -![segment_settings.png](images/segment_settings.png) + ![Screenshot of MoEngage Settings page](images/segment_settings.png) ## Identify Use [Identify](/docs/connections/sources/catalog/libraries/mobile/android/#identify) to track user-specific attributes. This is the same as tracking [user attributes](https://help.moengage.com/hc/en-us/articles/360044285511-User-Profile){:target="_blank"} on MoEngage. MoEngage supports traits supported by Segment as well as custom traits. If you set `traits.id`, MoEngage sets that as the Unique ID for that user. > info "" -> MoEngage supports anonymous identifiers in Device-mode only. If you use the MoEngage destination in Cloud-mode, use a known user identifier. +> MoEngage supports anonymous identifiers in device-mode only. If you use the MoEngage destination in cloud-mode, use a known user identifier. The Identify method follows the format below: @@ -59,7 +56,7 @@ analytics.identify('12090000-00001992', { ``` ## Track -Use [track](/docs/connections/sources/catalog/libraries/mobile/android/#track) to track events and user behavior in your app. +Use [Track](/docs/connections/sources/catalog/libraries/mobile/android/#track) to track events and user behavior in your app. ```javascript analytics.track('Article Completed', { @@ -68,30 +65,30 @@ analytics.track('Article Completed', { }); ``` -This will send the event to MoEngage with the associated properties. Tracking events is essential and will help you create segments for engaging users. +This sends the event to MoEngage with the associated properties. Tracking events is essential and helps you create segments for engaging users. ## Reset -If your app or website supports the ability for a user to logout and login with a new identity, then you'll need to call [reset](/docs/sources/website/analytics.js/#reset-logout) method in `analytics.js`. +If your app or website supports the ability for a user to logout and login with a new identity, then you need to call the [Reset](/docs/sources/website/analytics.js/#reset-logout) method in `analytics.js`. ```javascript analytics.reset(); ``` ## iOS - To get started with MoEngage on iOS, first integrate your app with the [MoEngage-Segment-Swift](https://github.com/moengage/MoEngage-Segment-Swift){:target="_blank"} library. You can integrate MoEngage and Segment with Swift Package Manager. > info "" -> **Note:** This document covers the integration with [analytics-swift](https://github.com/segmentio/analytics-swift){:target="_blank"}, if you have integrated with [analytics-ios](https://github.com/segmentio/analytics-ios){:target="_blank"} refer [this documentation](https://partners.moengage.com/hc/en-us/articles/4409143473172-iOS-device-mode-){:target="_blank"} for details on how to integrate. +> This document covers the integration with [analytics-swift](https://github.com/segmentio/analytics-swift){:target="_blank"}. If you've integrated with [analytics-ios](https://github.com/segmentio/analytics-ios){:target="_blank"} refer [MoEngage's documentation](https://partners.moengage.com/hc/en-us/articles/4409143473172-iOS-device-mode-){:target="_blank"} for details on how to integrate. - To install with SPM use the [MoEngage-Segment-Swift](https://github.com/moengage/MoEngage-Segment-Swift.git){:target="_blank"} library and set the branch as master or version as 1.0.0 and above. +To install with SPM use the [MoEngage-Segment-Swift](https://github.com/moengage/MoEngage-Segment-Swift.git){:target="_blank"} library and set the branch as master or version as 1.0.0 and above. ### Configure the Segment SDK: -Now head to the App Delegate file, and setup the Segment SDK by +Head to the App Delegate file, and setup the Segment SDK by: + 1. Importing `Segment`, `Segment_MoEngage` and `MoEngageSDK`. 2. Initialize `MoEngageSDKConfig` object and call `initializeDefaultInstance` method of `MoEngageInitializer`. -3. Initialize `MoEngageDestination` as shown below: +3. Initialize `MoEngageDestination`: Under your Analytics-Swift library setup, add the MoEngage plugin using the `analytics.add(plugin: ...)` method. The MoEngage dashboard now tracks all of your events. @@ -116,43 +113,42 @@ analytics.add(plugin: MoEngageDestination()) } ``` -### Tracking User Attribute +### Tracking user attribute -[User attributes](https://developers.moengage.com/hc/en-us/articles/4403905883796-Tracking-user-attributes){:target="_blank"} are specific traits of a user, like email, username, mobile, gender etc. **identify** lets you tie a user to their actions and record traits about them. It includes a unique User ID and any optional traits you know about them. +[User attributes](https://developers.moengage.com/hc/en-us/articles/4403905883796-Tracking-user-attributes){:target="_blank"} are specific traits of a user, like email, username, mobile, gender, and more. Identify lets you tie a user to their actions and record traits about them. It includes a unique User ID and any optional traits you know about them. ```swift Analytics.main.identify("a user's id", traits: @["email":"a user's email address"]) ``` -Read more about [identify calls](/docs/connections/sources/catalog/libraries/mobile/ios/#identify). +Read more about [Identify calls](/docs/connections/sources/catalog/libraries/mobile/ios/#identify) for further detail. -### Tracking Events +### Tracking events -Segment uses event tracking to track user behavior in an app. `track` calls let you record the actions your users perform. Every action triggers an "event", which can also have associated attributes. +Segment uses event tracking to track user behavior in an app. Track calls let you record the actions your users perform. Every action triggers an "event", which can also have associated attributes. ```swift Analytics.main.track("Item Purchased", properties: @["item":"Sword of Heracles"]) ``` -Read more about [track calls](/docs/connections/sources/catalog/libraries/mobile/ios/#track). - +Read more about [Track calls](/docs/connections/sources/catalog/libraries/mobile/ios/#track) for further detail. -### Reset Users +### Reset users -The `reset` method clears the SDK's internal stores for the current user. This is useful for apps where users can log in and out with different identities over time. +The Reset method clears the SDK's internal stores for the current user. This is useful for apps where users can log in and out with different identities over time. ```swift Analytics.main.reset() ``` -Read more about the [reset method](/docs/connections/sources/catalog/libraries/mobile/ios/#reset). +Read more about the [Reset method](/docs/connections/sources/catalog/libraries/mobile/ios/#reset) for further detail. -### Install / Update Differentiation +### Install or update differentiation Since your app might already be on the App Store, you must specify whether your app update would be an `UPDATE` or an `INSTALL`. -To differentiate between those, use one of the method below: +To differentiate between those, use one of the following methods: ```swift //For new Install call following @@ -162,20 +158,20 @@ To differentiate between those, use one of the method below: MoEngageSDKAnalytics.sharedInstance.appStatus(.update) ``` -Read more on [install/update differentiation](https://developers.moengage.com/hc/en-us/articles/4403910297620){:target="_blank"}. +Read more on [Install/Update differentiation](https://developers.moengage.com/hc/en-us/articles/4403910297620){:target="_blank"} on MoEngage website. ### Set the data center -By default, the data center setting in the SDK is set to `data_center_01`. Follow the steps in the [MoEngage - Data Center](https://developers.moengage.com/hc/en-us/articles/4403910162452-Data-Center){:target="_blank"} to update the data center value. If not set correctly, several features of the MoEngage SDK will not function. +By default, the data center setting in the SDK is set to `data_center_01`. Follow the steps in the [MoEngage - Data Center](https://developers.moengage.com/hc/en-us/articles/4403910162452-Data-Center){:target="_blank"} to update the data center value. If not set correctly, several features of the MoEngage SDK won't function. -## MoEngage iOS SDK Features +## MoEngage iOS SDK features Along with tracking your user's activities, you can use the MoEngage iOS SDK for more effective user engagement: -### Push Notifications: -Push Notifications are a great way to keep your users engaged and informed about your app. You have following options while implementing push notifications in your app: +### Push notifications: +Push notifications are a useful way to keep your users engaged and informed about your app. You have following options while implementing push notifications in your app: -**Segment Push Implementation:** +**Segment push implementation:** 1. In your application's application:didRegisterForRemoteNotificationsWithDeviceToken: method, add the following: ```swift @@ -197,24 +193,21 @@ Push Notifications are a great way to keep your users engaged and informed about Analytics.main.handleAction(identifier: identifier, userInfo: userInfo) ``` -**MoEngage Push Implementation:** +**MoEngage push implementation:** For information about the MoEngage push implementation, see [**Push Notifications**](https://developers.moengage.com/hc/en-us/articles/4403943988756){:target="_blank"} in the MoEngage documentation. ### In-app messaging -In-App Messages are custom views which you can send to a set of users to show custom messages, give new offers, or direct to a specific page. For more information about In-app messaging, see [MoEngage - In-App NATIV](https://developers.moengage.com/hc/en-us/articles/4404155127828-In-App-Nativ){:target="_blank"}. - +In-app messages are custom views which you can send to a set of users to show custom messages, give new offers, or direct to a specific page. For more information about in-app messaging, see [MoEngage - In-App NATIV](https://developers.moengage.com/hc/en-us/articles/4404155127828-In-App-Nativ){:target="_blank"}. ### Cards Create targeted or automated App Inbox/NewsFeed messages that can be grouped into various categories, and target your users with different updates or offers that can stay in the Inbox/Feed over a designated period of time. For more information about cards, see [MoEngage - Cards](https://developers.moengage.com/hc/en-us/articles/4404058438676-Cards-in-iOS){:target="_blank"}. - ### Compliance -To make the App compliant with policies (such as GDPR) while using MoEngage's SDK, follow the instructions in this [doc](https://developers.moengage.com/hc/en-us/articles/4403905438228-SDK-initialisation){:target="_blank"}. - -### Segment Docs -For more info on using **Segment for iOS** refer to [**Developer Docs**](/docs/connections/sources/catalog/libraries/mobile/ios/) provided by Segment. +To make the app compliant with policies (such as GDPR) while using MoEngage's SDK, follow the instructions in [MoEngage's documentation](https://developers.moengage.com/hc/en-us/articles/4403905438228-SDK-initialisation){:target="_blank"}. +### Segment for iOS +For more info on using Segment for iOS, refer to the [Developer docs](/docs/connections/sources/catalog/libraries/mobile/ios/) provided by Segment. ## Android @@ -222,14 +215,14 @@ To use MoEngage in an Android app, you must perform the following steps to set u ![MavenBadge](https://maven-badges.herokuapp.com/maven-central/com.moengage/moengage-segment-kotlin-destination/badge.svg) -To enable the full functionality of MoEngage (like Push Notifications, InApp Messaging), complete the following steps in your Android app. +To enable the full functionality of MoEngage (like push notifications, in-app messaging), complete the following steps in your Android app. > info "" -> **Note:** This document covers the integration with [analytics-kotlin](https://github.com/segmentio/analytics-kotlin){:target="_blank"}, if you have integrated with [analytics-android](https://github.com/segmentio/analytics-android){:target="_blank"} refer [this documentation](https://partners.moengage.com/hc/en-us/articles/4409143473172-iOS-device-mode-){:target="_blank"} for details on how to integrate. +> This document covers the integration with [analytics-kotlin](https://github.com/segmentio/analytics-kotlin){:target="_blank"}. If you have integrated with [analytics-android](https://github.com/segmentio/analytics-android){:target="_blank"} refer [MoEngage's documentation](https://partners.moengage.com/hc/en-us/articles/4409143473172-iOS-device-mode-){:target="_blank"} for details on how to integrate. -### Adding the MoEngage Dependency +### Adding the MoEngage dependency -Along with the Segment dependency, add the below dependency in your `build.gradle` file. +Along with the Segment dependency, add the following dependency in your `build.gradle` file. ```groovy implementation("com.moengage:moengage-segment-kotlin-destination:$sdkVersion") { @@ -238,20 +231,18 @@ implementation("com.moengage:moengage-segment-kotlin-destination:$sdkVersion") { ``` with `$sdkVersion` replaced by the latest version of the MoEngage SDK. -The MoEngage SDK depends on the below Jetpack libraries provided by Google for its functioning, make you add them if not - done already. +The MoEngage SDK depends on the following Jetpack libraries provided by Google for its functioning, make sure you add them if not done already. ```groovy implementation("androidx.core:core:1.6.0") implementation("androidx.appcompat:appcompat:1.3.1") implementation("androidx.lifecycle:lifecycle-process:2.4.0") ``` -Refer to the [SDK Configuration](https://developers.moengage.com/hc/en-us/articles/4401984733972-Android-SDK-Configuration){:target="_blank"} documentation to know more about the build config and other libraries used by the SDK. +Refer to the [SDK Configuration](https://developers.moengage.com/hc/en-us/articles/4401984733972-Android-SDK-Configuration){:target="_blank"} documentation to learn more about the build config and other libraries used by the SDK. ### Register MoEngage with Segment SDK -After adding the dependency, you must register the integration with Segment SDK. To do this, import the MoEngage - integration: +After adding the dependency, you must register the integration with Segment SDK. To do this, import the MoEngage integration: ```kotlin import com.segment.analytics.kotlin.destinations.moengage.MoEngageDestination @@ -264,37 +255,36 @@ Analytics("", context) .add(MoEngageDestination(application)) ``` - ### Initialize the MoEngage SDK -Copy the APP ID from the Settings Page `Dashboard --> Settings --> App --> General` and initialize the MoEngage SDK in the onCreate method of the `Application` class +Copy the APP ID from the Settings page **Dashboard > Settings > App > General** and initialize the MoEngage SDK in the onCreate method of the `Application` class > info "" -> **Note:** MoEngage recommend that you initialize the SDK on the main thread inside `onCreate()` and not create a worker thread and initialize the SDK on that thread. +> MoEngage recommends that you initialize the SDK on the main thread inside `onCreate()` and not create a worker thread and initialize the SDK on that thread. ```kotlin -// this is the instance of the application class and "YOUR_APP_ID" is the APP ID from the dashboard. +// This is the instance of the application class and "YOUR_APP_ID" is the APP ID from the dashboard. val moEngage = MoEngage.Builder(this, "YOUR_APP_ID") .enablePartnerIntegration(IntegrationPartner.SEGMENT) .build() MoEngage.initialiseDefaultInstance(moEngage) ``` -### Exclude MoEngage Storage File from Auto-Backup -Auto backup service of Android periodically backs up the Shared Preference file, Database files, and so on. +### Exclude MoEngage storage file from auto-backup + +The auto-backup service of Android periodically backs up the Shared Preference file, Database files, and so on. -For more information, refer to [Auto Backup](https://developer.android.com/guide/topics/data/autobackup){:target="_blank"}. +For more information, refer to the [Auto-Backup](https://developer.android.com/guide/topics/data/autobackup){:target="_blank"} documentation. -As a result of the backup, MoEngage SDK identifiers are backed up and restored after re-install. -The restoration of the identifier results in your data being corrupted and the user not being reachable using push notifications. +As a result of the backup, MoEngage SDK identifiers are backed up and restored after re-install. The restoration of the identifier results in your data being corrupted and the user not being reachable using push notifications. To ensure data isn't corrupted after a backup is restored, opt-out of MoEngage SDK storage files. -Refer to the [documentation](https://developers.moengage.com/hc/en-us/articles/4401999257236-Exclude-MoEngage-Storage-File-from-Auto-Backup){:target="_blank"} for further details. +Refer to the [MoEngage documentation](https://developers.moengage.com/hc/en-us/articles/4401999257236-Exclude-MoEngage-Storage-File-from-Auto-Backup){:target="_blank"} for further details. ### Install or update differentiation This is required for migrations to the MoEngage Platform so the SDK can determine whether the user is a new user on your app, or an existing user who updated to the latest version. -If the user was already using your application and has just updated to a new version which has the MoEngage SDK, below is an example call: +If the user was already using your application and has just updated to a new version which has the MoEngage SDK. An example call: ```kotlin MoEAnalyticsHelper.setAppStatus(context, AppStatus.UPDATE) @@ -306,23 +296,19 @@ If this is a fresh install: MoEAnalyticsHelper.setAppStatus(context, AppStatus.INSTALL) ``` -## MoEngage Android SDK Features -### Configure Push Notifications +## MoEngage Android SDK features +### Configure push notifications -Copy the Server Key from the FCM console and add it to the MoEngage Dashboard. To upload it, go to the Settings Page `Dashboard --> Settings --> Channel --> Push --> Mobile Push --> Android` and add the Server Key and package name. -**Please make sure you add the keys both in Test and Live environment.** +Copy the Server Key from the FCM console and add it to the MoEngage Dashboard. To upload it, go to the Settings page, **Dashboard > Settings > Channel > Push > Mobile Push > Android** and add the Server Key and package name. Ensure that you add the keys both in Test and Live environment. #### Add meta information for push notification To display push notifications, some metadata regarding the notification is required. For example, the small icon and large icon drawables are mandatory. - Refer to the [MoEngage - NotificationConfig](https://moengage.github.io/android-api-reference-v11/core/com.moengage.core.config/-notification-config/index.html){:target="_blank"} API reference for all the possible options. - Use the `configureNotificationMetaData()` to pass on the configuration to the SDK. - ```kotlin val moEngage = MoEngage.Builder(this, "YOUR_APP_ID") .enablePartnerIntegration(IntegrationPartner.SEGMENT) @@ -334,9 +320,9 @@ Use the `configureNotificationMetaData()` to pass on the configuration to the SD MoEngage.initialiseDefaultInstance(moEngage) ``` -#### Configuring Firebase Cloud Messaging +#### Configuring Firebase cloud messaging -For showing Push notifications there are 2 important steps: +To show push notifications there are two important steps: 1. Registration for Push, for example generating push token. 2. Receiving the Push payload from Firebase Cloud Messaging(FCM) service and showing the notification on the device. @@ -345,7 +331,7 @@ For showing Push notifications there are 2 important steps: ###### Opt-out of MoEngage registration -To opt-out of MoEngage token registration mechanism disable token registration while configuring FCM in the `MoEngage.Builder` as shown below +To opt-out of MoEngage token registration mechanism disable token registration while configuring FCM in the `MoEngage.Builder`: ```kotlin val moEngage = MoEngage.Builder(this, "YOUR_APP_ID") @@ -361,19 +347,18 @@ To opt-out of MoEngage token registration mechanism disable token registration w ###### Pass the push token to the MoEngage SDK -The Application must pass the Push Token received from FCM to the MoEngage SDK for the MoEngage platform to send out push notifications to the device. -Use the below API to pass the push token to the MoEngage SDK. +The application must pass the Push Token received from FCM to the MoEngage SDK for the MoEngage platform to send out push notifications to the device. +Use the following API to pass the push token to the MoEngage SDK. ```kotlin MoEFireBaseHelper.getInstance().passPushToken(applicationContext,token) ``` -Please make sure token is passed to MoEngage SDK whenever push token is refreshed and on application update. Passing token on application update is important for migration to the MoEngage Platform. +Ensure that the token is passed to MoEngage SDK whenever push token is refreshed and on application update. Passing token on application update is important for migration to the MoEngage Platform. -###### Passing the Push payload to the MoEngage SDK +###### Passing the push payload to the MoEngage SDK -To pass the push payload to the MoEngage SDK call the MoEngage API from the `onMessageReceived()` from the Firebase receiver. -Before passing the payload to the MoEngage SDK you should check if the payload is from the MoEngage platform using the helper API provided by the SDK. +To pass the push payload to the MoEngage SDK call the MoEngage API from the `onMessageReceived()` from the Firebase receiver. Before passing the payload to the MoEngage SDK, check if the payload is from the MoEngage platform using the helper API provided by the SDK. ```kotlin if (MoEPushHelper.getInstance().isFromMoEngagePlatform(remoteMessage.data)) { @@ -383,9 +368,9 @@ if (MoEPushHelper.getInstance().isFromMoEngagePlatform(remoteMessage.data)) { } ``` -##### Push Registration and Receiving handled by SDK +##### Push registration and receiving handled by SDK -Add the below code in your manifest file. +Add the following code in your manifest file: ```xml @@ -397,7 +382,7 @@ Add the below code in your manifest file. When the MoEngage SDK handles push registration, it optionally provides a callback to the Application whenever a new token is registered or the token is refreshed. -An application can get this callback by implementing `FirebaseEventListener` and registering for a callback in the Application class `onCreate()` using `MoEFireBaseHelper.getInstance().addEventListener()` +An application can get this callback by implementing `FirebaseEventListener` and registering for a callback in the Application class `onCreate()` using `MoEFireBaseHelper.getInstance().addEventListener()`. Refer to the [MoEngage - API reference](https://moengage.github.io/android-api-reference-v11/moe-push-firebase/com.moengage.firebase.listener/-firebase-event-listener/index.html?query=open%20class%20FirebaseEventListener){:target="_blank"} for more details on the listener. @@ -405,22 +390,21 @@ Refer to the [MoEngage - API reference](https://moengage.github.io/android-api-r ##### Callbacks -Segment recommends that you add the callbacks in the onCreate() of the Application class since these callbacks can be triggered even when the application is in the background. +Segment recommends that you add the callbacks in the `onCreate()` of the application class since these callbacks can be triggered even when the application is in the background. -###### Token Callback +###### Token callback When MoEngage SDK handles push registration, it optionally provides a callback to the application whenever a new token is registered or the token is refreshed. To get the token callback implement the [TokenAvailableListener](https://moengage.github.io/android-api-reference/pushbase/com.moengage.pushbase.listener/-token-available-listener/index.html){:target="_blank"} and register for the callback using [MoEFireBaseHelper.getInstance().addTokenListener()](https://moengage.github.io/android-api-reference/moe-push-firebase/com.moengage.firebase/-mo-e-fire-base-helper/add-token-listener.html){:target="_blank"}. -###### Non-MoEngage Payload +###### Non-MoEngage payload If you're using the receiver provided by the SDK in your application's manifest file, SDK provides a callback in case a push payload is received for any other server apart from MoEngage Platform. To get a callback implement the [NonMoEngagePushListener](https://moengage.github.io/android-api-reference/moe-push-firebase/com.moengage.firebase.listener/-non-mo-engage-push-listener/index.html){:target="_blank"} and register for the callback using [MoEFireBaseHelper.getInstance().addNonMoEngagePushListener()](https://moengage.github.io/android-api-reference/moe-push-firebase/com.moengage.firebase/-mo-e-fire-base-helper/add-non-mo-engage-push-listener.html){:target="_blank"}. - -#### Declare and configure Rich Landing Activity: +#### Declare and configure rich landing activity: A rich landing page can be used to open a web URL inside the app through a push campaign. -The configuration below is only required if you want to add a parent activity to the Rich landing page. If not, you can move to the next section. +The following configuration is only required if you want to add a parent activity to the Rich landing page. If not, you can move to the next section. To use a rich landing page you need to add the below code in the AndroidManifest.xml Add the following snippet and replace `[PARENT_ACTIVITY_NAME]` with the name of the parent @@ -451,47 +435,45 @@ You are now all set up to receive push notifications from MoEngage. For more inf * [Release Notes](https://developers.moengage.com/hc/en-us/articles/4403896795540-Changelog){:target="_blank"} ### Identify -Use [Identify](/docs/connections/sources/catalog/libraries/mobile/android/#identify) to track user-specific attributes. This is the same as tracking [user attributes](https://developers.moengage.com/hc/en-us/articles/4402050979860-Track-User-Attributes){:target="_blank"} on MoEngage. MoEngage supports traits supported by Segment as well as custom traits. If you set traits.id, MoEngage sets that as the Unique ID for that user. +Use [Identify](/docs/connections/sources/catalog/libraries/mobile/android/#identify) to track user-specific attributes. This is the same as tracking [user attributes](https://developers.moengage.com/hc/en-us/articles/4402050979860-Track-User-Attributes){:target="_blank"} on MoEngage. MoEngage supports traits supported by Segment as well as custom traits. If you set `traits.id`, MoEngage sets that as the Unique ID for that user. > info "" > MoEngage supports anonymous identifiers in Device-mode only. If you use the MoEngage destination in Cloud-mode, use a known user identifier. ### Track -Use [track](/docs/connections/sources/catalog/libraries/mobile/android/#track) to track events and user behavior in your app. -This will send the event to MoEngage with the associated properties. Tracking events is essential and will help you create segments for engaging users. +Use [Track](/docs/connections/sources/catalog/libraries/mobile/android/#track) to track events and user behavior in your app. This sends the event to MoEngage with the associated properties. Tracking events is essential and helps you create segments for engaging users. ### Reset -If your app supports the ability for a user to logout and login with a new identity, then you'll need to call reset for the Analytics client. +If your app supports the ability for a user to logout and login with a new identity, then you need to call reset for the Analytics client. ### Sample Implementation -Refer to [this](https://github.com/moengage/moengage-segment-integration){:target="_blank"} GitHub repository for sample implementation +Refer to [MoEngage's](https://github.com/moengage/moengage-segment-integration){:target="_blank"} GitHub repository for sample implementation. ## Web The MoEngage WebSDK offers the ability to send push notifications to Google Chrome, Opera and Firefox browsers. Complete the following steps after you've configured Segment's `analytics.js.` - ### Integration #### 1. Setup your MoEngage Web SDK settings at MoEngage Dashboard -Configure the [web settings](https://help.moengage.com/hc/en-us/articles/210224063){:target="_blank"} on the MoEngage dashboard to start using MoEngage <> Segment integration. +Configure the [web settings](https://help.moengage.com/hc/en-us/articles/210224063){:target="_blank"} on the MoEngage dashboard to start using MoEngage \<> Segment integration. If you have selected `HTTPS` mode of integration in the settings, complete the following steps: #### 2 Set up for HTTPS websites #### 2.a Download the required files (HTTPS) -For HTTPS Web Push to work, you need to host two files in the `root` directory of your web server. These two files will be available for you to download at the [web settings page](https://app.moengage.com/v3/#/settings/push/web){:target="_blank"}. +For HTTPS Web Push to work, you need to host two files in the `root` directory of your web server. These two files are available for you to download at the [web settings page](https://app.moengage.com/v3/#/settings/push/web){:target="_blank"}. * `manifest.json` * `serviceworker.js` > info "Serviceworker file naming convention" -> The name of the serviceworker file must be `serviceworker.js`. Please contact MoEngage support at support@moengage.com if you want to give your serviceworker file a different name. +> The name of the serviceworker file must be `serviceworker.js`. Please contact [MoEngage support](mailto:support@moengage.com){:target="_blank"} if you want to give your serviceworker file a different name. #### 2.b Add link to manifest in HTML (HTTPS) -Add the following line in the tag of your page. +Add the following line in the `` tag of your page. ```html @@ -504,7 +486,7 @@ Add the following line in the tag of your page. #### 2.c Use your existing manifest or serviceworker file (HTTPS) If you already have these files, -1. **Manifest** - Add the sender ID you saved on MoEngage dashboard as the `gcm_sender_id`. If you've used `MoEngage Shared Project` while setting up, your sender id is `540868316921`. Edit your `manifest.json` as follows: +1. **Manifest** - Add the sender ID you saved on MoEngage dashboard as the `gcm_sender_id`. If you've used `MoEngage Shared Project` while setting up, your sender ID is `540868316921`. Edit your `manifest.json` as follows: ```json { ... @@ -513,7 +495,7 @@ If you already have these files, } ``` -2. **Service Worker** - Add the following line to the top of your `serviceworker.js` file +2. **Service Worker** - Add the following line to the top of your `serviceworker.js` file. ```js importScripts("//cdn.moengage.com/webpush/releases/serviceworker_cdn.min.latest.js?date="+ new Date().getUTCFullYear()+""+new Date().getUTCMonth()+""+new Date().getUTCDate()); @@ -523,84 +505,84 @@ If you already have these files, Use [Identify](/docs/sources/website/analytics.js/#identify) to track user specific attributes. This is equal to [tracking user attributes](https://developers.moengage.com/hc/en-us/articles/360061114832-Web-SDK-User-Attributes-Tracking){:target="_blank"} on MoEngage. MoEngage supports traits supported by Segment as well as custom traits. > info "" -> MoEngage supports anonymous identifiers in Device-mode only. If you use the MoEngage destination in Cloud-mode, use a known user identifier. +> MoEngage supports anonymous identifiers in device-mode only. If you use the MoEngage destination in cloud-mode, use a known user identifier. ### Track -Use [track](/docs/sources/website/analytics.js/#track) to track events and user behavior in your app. This will send the event to MoEngage with the associated properties. Tracking events is essential and will help you create segments for engaging users. +Use [Track](/docs/sources/website/analytics.js/#track) to track events and user behavior in your app. This sends the event to MoEngage with the associated properties. Tracking events is essential and helps you create segments for engaging users. ### Reset -If your website supports the ability for a user to logout and login with a new identity, then you'll need to call [reset](/docs/sources/website/analytics.js/#reset-logout) method in `analytics.js`. +If your website supports the ability for a user to logout and login with a new identity, then you need to call [reset](/docs/sources/website/analytics.js/#reset-logout) method in `analytics.js`. -### Test Mode and Debugging +### Test mode and debugging While updating the MoEngage settings on the Segment Dashboard, you can enable the logging functionality of the MoEngage SDK to see the SDK logs on the browser console. Just set `Enable Debug Logging` to `On` and the SDK loads in debug mode. > success "" > When you enable debug mode, Segment sends the events and user attributes to the `TEST` environment of your MoEngage App. -## MoEngage Web SDK Features +## MoEngage Web SDK features For information about optional features, see the documentation below: -* [Configure opt in type](https://help.moengage.com/hc/en-us/articles/210224063-Configure-Web-Push-Settings#configure-web-push-opt-in-0-6){:target="_blank"} +* [Configure opt-in type](https://help.moengage.com/hc/en-us/articles/210224063-Configure-Web-Push-Settings#configure-web-push-opt-in-0-6){:target="_blank"} * [Self-handled opt-ins](https://developers.moengage.com/hc/en-us/articles/360061219351-Configure-Self-Handled-Opt-In){:target="_blank"} * [SDK callbacks](https://developers.moengage.com/hc/en-us/articles/4401950701076-Opted-Out-Users){:target="_blank"} -### On-Site Messaging +### On-Site messaging -On-site Messaging Campaigns allow you to show personalized pop-ups and non-intrusive banners on your website. +On-site messaging campaigns allow you to show personalized pop-ups and non-intrusive banners on your website. -Web SDK integration for On-site Messaging will automatically start working on all the pages where the web SDK is integrated. +Web SDK integration for On-site Messaging automatically starts working on all the pages where the web SDK is integrated. For more information, refer to [Configure and Integrate On-site Messaging](https://developers.moengage.com/hc/en-us/articles/360061573232-Configure-and-Integrate-On-site-Messaging){:target="_blank"}. -### Web Personalization +### Web personalization -Web Personalization is used to personalize the website experience for each user. A few popular use cases for Web Personalization include the home page banner personalization basis user behavior, localizing the website content basis user geography, testing the performance of new page layouts for improved performance, modifying the content shown on any webpage as per the user behavior. +Web personalization is used to personalize the website experience for each user. A few popular use cases for web personalization include the home page banner personalization basis user behavior, localizing the website content basis user geography, testing the performance of new page layouts for improved performance, modifying the content shown on any webpage as per the user behavior. -For more information, refer to [Configure and Integrate Web Personalization](https://developers.moengage.com/hc/en-us/articles/360062008891-Configure-and-Integrate-Web-Personlization){:target="_blank"}. +For more information, refer to MoEngage's documentation on how to [configure and integrate web personalization](https://developers.moengage.com/hc/en-us/articles/360062008891-Configure-and-Integrate-Web-Personlization){:target="_blank"}. ## Use Twilio Engage with MoEngage You can send [Computed traits](/docs/engage/audiences/computed-traits/) and [Audiences](/docs/audiences/audiences/) to MoEngage as custom attributes or custom events. -* Traits and audiences sent using the `identify` call will appear in MoEngage as _Tracked Custom Attributes_ with value as _True_. -* Traits and audiences sent using the `track` call will appear in MoEngage as _Tracked User Events_. +* Traits and audiences sent using the Identify call appear in MoEngage as _Tracked Custom Attributes_ with value as _True_. +* Traits and audiences sent using the Track call appear in MoEngage as _Tracked User Events_. -When connecting the calculated trait/audience to the MoEngage destination, you may select the method of your choice (or opt to utilise both). +When connecting the calculated trait or audience to the MoEngage destination, you can select the method of your choice (or opt to use both). -### Sync Time +### Sync time -The default integration for MoEngage <> Twilio Engage connection is **Real Time.** But there are some filters that will disqualify the persona from syncing in real-time, including some time-based filters which restrict your audience’s size at the time of message send. +The default integration for MoEngage \<> Twilio Engage connection is **Real Time.** But there are some filters that disqualify the persona from syncing in real-time, including some time-based filters which restrict your audience’s size at the time of message send. -### Computed Traits using Identify calls +### Computed traits using Identify calls -To generate custom attributes in MoEngage, you may provide Computed Traits defined in Engage as `Identify` calls. The Computed Trait's value is used to set the custom attribute. +To generate custom attributes in MoEngage, you may provide Computed Traits defined in Engage as Identify calls. The computed trait's value is used to set the custom attribute. ### Create a Segment Computed Trait -1. In Segment, navigate to the _Computed Traits_ in _Engage._ -2. Click _New Computed Trait_. +1. In Segment, navigate to the **Computed Traits** in Engage. +2. Click **New Computed Trait**. 3. Create your computed trait. A lightning bolt in the top corner of the page will indicate if the computation updates in real-time. - ![segment_new_trait.png](images/segment_new_trait.png) -4. Next, select _MoEngage_ as your destination. - ![segment_select_moengage_destination.png](images/segment_select_moengage_destination.png) -5. Preview by clicking _Review & Create_. - _Note-_ By default, Segment queries all historical data to set the current value of the computed trait and audience. To omit this data, uncheck _Historical Backfill_.  - ![segment_new_trait_backfill.png](images/segment_new_trait_backfill.png) + ![Screenshot of Configure and Preview Your Trait page](images/segment_new_trait.png) +4. Next, select **MoEngage** as your destination. + ![Screenshot of MoEngage (Actions) destination page in Segment](images/segment_select_moengage_destination.png) +5. Preview by clicking **Review & Create**. + > By default, Segment queries all historical data to set the current value of the computed trait and audience. To omit this data, uncheck **Historical Backfill**.  + ![Screenshot of Review & Create page with Historial Backfill section highlighted](images/segment_new_trait_backfill.png) 6. In the computed trait, adjust the connection settings based on how you would like your data sent to MoEngage. ### Create a Segment Audience -1. In Segment, navigate to the _Audience_ in _Engage_ -2. Click _New_. -3. Create your audience. A lightning bolt in the top corner of the page will indicate if the computation updates in real-time. - ![segment_audience_2.png](images/segment_audience_2.png) -4. Next, select _MoEngage_ as your destination. - ![segment_audience_destination.png](images/segment_audience_destination.png) -5. Preview your audience by clicking _Review & Create_. - _Note-_ By default, Segment queries all historical data to set the current value of the audience. To omit this data, uncheck _Historical Backfill_.  - ![segment_audience_4.png](images/segment_audience_4.png) +1. In Segment, navigate to the **Audience** in Engage. +2. Click **New**. +3. Create your audience. A lightning bolt indicates if the computation updates in real-time. + ![Screenshot Configure and Preview your Audience page](images/segment_audience_2.png) +4. Next, select **MoEngage** as your destination. + ![Screenshot of MoEngage (Actions) destination page in Segment](images/segment_audience_destination.png) +5. Preview your audience by clicking **Review & Create**. + > By default, Segment queries all historical data to set the current value of the audience. To omit this data, uncheck **Historical Backfill**.  + ![Screenshot of Review & Create page](images/segment_audience_4.png) 6. In the computed trait or audience settings, adjust the connection settings based on how you would like your data sent to MoEngage. - ![segment_audience_5.png](images/segment_audience_5.png) + ![Screenshot of Connection settings](images/segment_audience_5.png) ## Connect Twilio Engage to MoEngage @@ -612,9 +594,9 @@ First, link MoEngage to Twilio Engage to send Computed Traits or Audiences. The ## Segment users in MoEngage -To create a segment of these users, navigate to _Segments >> Create Segment._ Next, based on which call you used: +To create a segment of these users, navigate to **Segments > Create Segment**. Next, based on which call you used: -- **Identify**: Select _User Property_ and select the specific attribute. - ![moengage_segment_identify.png](images/moengage_segment_identify.png) -- **Track**: Select _User Behaviour_ and select the specific event. - ![moengage_segment_track.png](images/moengage_segment_track.png) +- **Identify**: Select **User Property** and select the specific attribute. + ![Screenshot of User property filter in MoEngage UI](images/moengage_segment_identify.png) +- **Track**: Select **User Behaviour** and select the specific event. + ![Screenshot of User behavior filter in MoEngage UI](images/moengage_segment_track.png) diff --git a/src/connections/destinations/catalog/olark/index.md b/src/connections/destinations/catalog/olark/index.md index 0fa22b794a..8e312ac787 100644 --- a/src/connections/destinations/catalog/olark/index.md +++ b/src/connections/destinations/catalog/olark/index.md @@ -2,37 +2,33 @@ title: Olark Destination id: 54521fd925e721e32a72eedc --- -## Getting Started +## Getting started -When you enable Olark in the Segment web app, your changes appear in the Segment CDN in about 45 minutes, and then Analytics.js starts asynchronously loading Olark's `loader0.js` onto your page. This means you should remove Olark's snippet from your page. -+ Olark's chat box will appear on your page, as configured in your [Olark account](http://www.olark.com/?r=qhl4tltg){:target="_blank"}, and you can start chatting with visitors. +When you enable Olark in the Segment Segmentb app, your changes appear in the Segment CDN in about 45 minutes. Analytics.js then starts asynchronously loading Olark's `loader0.js` onto your page. This means you should remove Olark's snippet from your page. -Olark is only supported in device mode (on the client). +Olark's chat box appears on your page, as configured in your [Olark account](http://www.olark.com/?r=qhl4tltg){:target="_blank"}, and you can start chatting with visitors. -- - - +Olark is only supported in device-mode (on the client). ## Page -When you call [`page`](/docs/connections/spec/page/), we call Olark's `sendNotificationToOperator` function as `looking at *url*`. You must enable this option with the *pageview* flag, because it can sometimes be bothersome. - +When you call [Page](/docs/connections/spec/page/), Segment calls Olark's `sendNotificationToOperator` function as `looking at *url*`. You must enable this option with the `pageview` flag, because it can sometimes be bothersome. ## Identify -When you call [`identify`](/docs/connections/spec/identify/) on `analytics.js`, we send the following data to Olark: +When you call [Identify](/docs/connections/spec/identify/) on `analytics.js`, Segment sends the following data to Olark: -* We call `api.chat.updateVisitorNickname` with `traits.name` and `traits.email`, or just their `traits.name` or just their `traits.email` or their `userId`. In that order of preference. -* We call `api.visitor.updateEmailAddress` with `traits.email` if you send it, or `userId` if that's an email. -* We call `api.visitor.updateFullName` with `traits.name` if you send it, or `traits.firstName` and `traits.lastName` appended with a space in between, if you send both first and last name. -* We call `api.visitor.updatePhoneNumber` with `traits.phone` if you send it. -* We call `api.visitor.updateCustomFields` with `traits`. +* Segment calls `api.chat.updateVisitorNickname` with `traits.name` and `traits.email`, or just their `traits.name` or just their `traits.email` or their `userId`. In that order of preference. +* Segment calls `api.visitor.updateEmailAddress` with `traits.email` if you send it, or `userId` if that's an email. +* Segment calls `api.visitor.updateFullName` with `traits.name` if you send it, or `traits.firstName` and `traits.lastName` appended with a space in betSegmenten, if you send both first and last name. +* Segment calls `api.visitor.updatePhoneNumber` with `traits.phone` if you send it. +* Segment calls `api.visitor.updateCustomFields` with `traits`. More documentation on the Olark API can be found [in Olark's docs](https://www.olark.com/api){:target="_blank"}. ## Track -When you call [`track`](/docs/connections/spec/track/) or one of its helpers on analytics.js, we call Olark's `sendNotificationToOperator` function as `visitor triggered *eventName*`. You must enable this option with the *track* flag, because it can sometimes be bothersome. - -- - - +When you call [Track](/docs/connections/spec/track/) or one of its helpers on analytics.js, Segment calls Olark's `sendNotificationToOperator` function as `visitor triggered *eventName*`. You must enable this option with the `track` flag. ## Features @@ -42,7 +38,7 @@ All the settings you can change [from your Olark settings pages](https://www.ola ### Olark JavaScript API -If you'd like to use the native Olark JavaScript functions after turning on Olark using Segment our `ready` function will allow you to do that. Since we still load the Olark library in the background you can access those functions like this: +If you'd like to use the native Olark JavaScript functions after turning on Olark using Segment, the `ready` function allows you to do that. Since Segment still loads the Olark library in the background, you can access those functions like this: ```js analytics.ready(function(){ @@ -50,21 +46,19 @@ analytics.ready(function(){ }); ``` -[Read the ready docs for more details](/docs/connections/sources/catalog/libraries/website/javascript/#ready) - -- - - +See the [`ready` docs](/docs/connections/sources/catalog/libraries/Segmentbsite/javascript/#ready) for more details. -## Record Live Chat Events +## Record Live Chat events -Using Olark through Segment gives you the ability to automatically record `track` events for live chat conversations. If you select this option, we'll collect the following events: +Using Olark through Segment gives you the ability to automatically record Track events for live chat conversations. If you select this option, Segment collects the following events: -* Live Chat Conversation Started -* Live Chat Message Sent -* Live Chat Message Received +* `Live Chat Conversation Started`. +* `Live Chat Message Sent`. +* `Live Chat Message Received`. -These events will be sent to other tools in your stack that can accept track calls, so you can do things like analyze if users who chat spend more money over time. +These events are sent to other tools in your stack that can accept Track calls, so you can do things like analyze if users who chat spend more money over time. -To learn more about the live chat events you can capture with this destination, head on over to our [Live Chat spec docs](/docs/connections/spec/live-chat/). +To learn more about the live chat events you can capture with this destination, see the [Live Chat spec docs](/docs/connections/spec/live-chat/). -![Turn on Olark](images/olarklivechat.png) +![Screenshot of Olark UI with option to Record live chat events highlighted](images/olarklivechat.png) diff --git a/src/connections/destinations/catalog/onesignal-new/index.md b/src/connections/destinations/catalog/onesignal-new/index.md index cc3f19ed19..5e761cdb3f 100644 --- a/src/connections/destinations/catalog/onesignal-new/index.md +++ b/src/connections/destinations/catalog/onesignal-new/index.md @@ -6,32 +6,29 @@ redirect_from: '/connections/destinations/catalog/onesignal/' id: 60b6a5b69fec493efbd3c64c --- [OneSignal](https://onesignal.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} is the market leader in driving customer engagement with multi-channel messaging across Web and Mobile Push, In-App Messages, SMS, and Email subscribers. -This destination is maintained by OneSignal. For any issues with the destination, [contact the OneSignal Support team](mailto:support@onesignal.com). -> info "" -> The OneSignal Destination is available to customers on OneSignal Growth, Professional and Enterprise plans. - -## Getting Started +This destination is maintained by OneSignal. For any issues with the destination, [contact the OneSignal support team](mailto:support@onesignal.com){:target="_blank"}. +> info "" +> The OneSignal Destination is available to customers on OneSignal Growth, Professional, and Enterprise plans. +## Getting started -1. Log in to the [OneSignal Dashboard](https://app.onesignal.com/){:target="_new"} -2. Navigate to **Segment App** -> **Settings** -> **Analytics** -> **Segment.com** and click **Activate**. +1. Log in to the [OneSignal dashboard](https://app.onesignal.com/){:target="_blank"}. +2. Navigate to **Segment App > Settings > Analytics > Segment.com** and click **Activate**. 3. The Segment App opens in a new window. Log in to authenticate the connection from OneSignal. -4. Select the Workspace and Source to connect with OneSignal. - +4. Select the workspace and source to connect with OneSignal. > info "" > OneSignal maps the `userId` field to the **[External User ID](https://documentation.onesignal.com/docs/onboarding-with-onesignal#step-3-connect-user-data-to-onesignal){:target="_blank"}** field in OneSignal. - ## Supported methods OneSignal supports the following methods, as specified in the [Segment Spec](/docs/connections/spec). ### Identify -Send [Identify](/docs/connections/spec/identify) calls to update Users. For example: +Send [Identify](/docs/connections/spec/identify) calls to update users. For example: ```js analytics.identify('userId123', { @@ -62,25 +59,25 @@ analytics.track('Add to Cart', { }) ``` -OneSignal stores Track properties as Data Tags but drops the event name. In the above example, `Add to Cart` is dropped. +OneSignal stores Track properties as Data Tags but drops the event name. In the example, `Add to Cart` is dropped. To keep the event names on OneSignal Data Tags, append the event name to the properties. For example, `Add_to_Cart_brand` instead of `brand`. -![""](images/track-example.png) +![Screenshot of the OneSignal dashboard showing a notification for an "eShoppe" campaign.](images/track-example.png) ## Engage -Send Computed Traits and Audiences generated using [Engage](/docs/engage) to OneSignal +You can send Computed Traits and Audiences generated using [Engage](/docs/engage) to OneSignal. ### Audiences -Engage Audiences appear as a [segment](https://documentation.onesignal.com/docs/segmentation){:target="_blank"} in OneSignal. +Engage audiences appear as a [segment](https://documentation.onesignal.com/docs/segmentation){:target="_blank"} in OneSignal. -Track calls from Audiences create a OneSignal [segment](https://documentation.onesignal.com/docs/segmentation){:target="_blank"} with the Audience Name. +Track calls from Audiences create a OneSignal [segment](https://documentation.onesignal.com/docs/segmentation){:target="_blank"} with the audience name. -Identify calls from Audiences create a OneSignal [segment](https://documentation.onesignal.com/docs/segmentation){:target="_blank"} with the Audience Name and add Data Tags on all the matching user records. +Identify calls from Audiences create a OneSignal [segment](https://documentation.onesignal.com/docs/segmentation){:target="_blank"} with the audience name and add Data Tags on all the matching user records. -![""](images/audiences.jpg) +![Screenshot of the OneSignal "eShoppe" dashboard](images/audiences.jpg) Audiences sends Identify and Track calls to OneSignal when a user enters or exits the Audience. @@ -88,13 +85,11 @@ Audiences sends Identify and Track calls to OneSignal when a user enters or exit OneSignal stores Track and Identify calls from Engage Computed Traits as [Data Tags](https://documentation.onesignal.com/docs/add-user-data-tags){:target="_blank"} for the OneSignal User/Player's records. -## OneSignal Destination FAQ -### Managing Segment's Reserved and Custom Traits - -* Segment sends user traits to OneSignal as Data Tags. The number of data tags OneSignal allows depends on your OneSignal pricing plan. OneSignal drops the data tags that go over your set number. . - -* OneSignal always updates the `firstName` and the `lastName` properties for matching users. All other traits are added/updated on a first-come basis. `firstName` and `lastName` tags are stored as `first_name` and `last_name`. +## FAQ -* Send User properties to OneSignal with blank/null values to remove the corresponding Data Tag from the OneSignal user record. +#### How do I manage Segment's Reserved and Custom Traits? +* Segment sends user traits to OneSignal as Data Tags. The number of data tags OneSignal allows depends on your OneSignal pricing plan. OneSignal drops the data tags that go over your set number. +* OneSignal always updates the `firstName` and the `lastName` properties for matching users. All other traits are added or updated on a first-come basis. `firstName` and `lastName` tags are stored as `first_name` and `last_name`. +* Send User properties to OneSignal with blank or `null` values to remove the corresponding Data Tag from the OneSignal user record. * OneSignal doesn't store `email` and `phone` properties. To update `email` and `phone` properties in OneSignal, create a player record with the email address and/or a phone number and map those records with the External_User_ID. Additional properties from Segment map across all your matching records, including email and phone number records. diff --git a/src/connections/destinations/catalog/onesignal/index.md b/src/connections/destinations/catalog/onesignal/index.md index 0dff3e8658..d1b084568f 100644 --- a/src/connections/destinations/catalog/onesignal/index.md +++ b/src/connections/destinations/catalog/onesignal/index.md @@ -11,7 +11,6 @@ OneSignal will only track new users. If you have existing push notification data OneSignal supports the `identify` and `track` methods and is currently only available on iOS using Segment. -- - - ## Identify & Track diff --git a/src/connections/destinations/catalog/optimizely-full-stack/index.md b/src/connections/destinations/catalog/optimizely-full-stack/index.md index 83ce88bc18..2171659fe6 100644 --- a/src/connections/destinations/catalog/optimizely-full-stack/index.md +++ b/src/connections/destinations/catalog/optimizely-full-stack/index.md @@ -4,167 +4,164 @@ hide-personas-partial: true redirect_from: '/connections/destinations/catalog/optimizelyx/' id: 59d3b44b8f1480000104be6b --- -## Getting Started +## Getting started +Segment's Optimizely Full Stack destination, previously Optimizely X, supports the following Optimizely products: - -Segment's **Optimizely Full Stack (previously Optimizely X)** destination supports the following Optimizely products: - -* [Optimizely Full Stack (server)](#server-side) -* [Optimizely Full Stack Android (Cloud-mode)](#android-cloud-mode-implementation) -* [Optimizely Full Stack iOS (Cloud-mode)](#ios-cloud-mode-implementation) +* [Optimizely Full Stack (server)](#server-side). +* [Optimizely Full Stack Android (Cloud-mode)](#android-cloud-mode-implementation). +* [Optimizely Full Stack iOS (Cloud-mode)](#ios-cloud-mode-implementation). If you're interested in implementing Optimizely X Web or Optimizely Full Stack with the JavaScript SDK, see Segment's [**Optimizely Web Destination**](/docs/connections/destinations/catalog/optimizely-web/), or follow the links below: -* [Optimizely X Web](/docs/connections/destinations/catalog/optimizely/#optimizely-x-web) -* [Optimizely Full Stack (JavaScript SDK)](/docs/connections/destinations/catalog/optimizely-web/#optimizely-full-stack-javascript-sdk) +* [Optimizely X Web](/docs/connections/destinations/catalog/optimizely/#optimizely-x-web). +* [Optimizely Full Stack (JavaScript SDK)](/docs/connections/destinations/catalog/optimizely-web/#optimizely-full-stack-javascript-sdk). -## Implementation Prerequisite +## Implementation prerequisite -Optimizely works differently than other Segment destinations: It requires that customers implement some Optimizely functionality natively to make sure your experiment logic runs correctly. +Optimizely works differently than other Segment destinations. It requires that customers implement some Optimizely functionality natively to make sure the experiment logic runs correctly. -Segment maps `track` events to Optimizely's `track` method, customers must implement all Optimizely decision-based methods, such as `activate` and `isFeatureEnabled` natively. Segment's API does not include methods that correspond to decision-based methods. +Segment maps Track events to Optimizely's `track` method, customers must implement all Optimizely decision-based methods, such as `activate` and `isFeatureEnabled` natively. Segment's API doesn't include methods that correspond to decision-based methods. This requires that customers include a native Optimizely implementation before their Segment implementation on pages or in mobile apps where Optimizely experiments run. -## Server Side +## Server-side -### Getting Started +### Getting started -1. In your Segment source dashboard, enable the "Optimizely Full Stack" destination (*not the "Optimizely Web" destination*). +1. In your Segment source dashboard, enable the "Optimizely Full Stack" destination (**not the "Optimizely Web" destination**). 2. Include your Optimizely project's `datafile` URL in your Segment settings. 3. Create a native Optimizely instance in your server environment so you can access Optimizely decisioning methods like `activate`, `isFeatureEnabled`. -4. Finally, define any [`events`](https://docs.developers.optimizely.com/full-stack/docs/create-events){:target="_blank"} and [`attributes`](https://docs.developers.optimizely.com/full-stack/docs/define-attributes){:target="_blank"} in your Optimizely dashboard, and to associate `metrics` with the appropriate Optimizely Experiments. Segment maps `track` event names to Optimizely `eventName` - the `eventName` corresponds to an experiment `metric`. In addition, Segment maps `track` event `context.traits` to Optimizely `attributes`. +4. Finally, define any [`events`](https://docs.developers.optimizely.com/full-stack/docs/create-events){:target="_blank"} and [`attributes`](https://docs.developers.optimizely.com/full-stack/docs/define-attributes){:target="_blank"} in your Optimizely dashboard, and to associate `metrics` with the appropriate Optimizely Experiments. Segment maps Track event names to Optimizely `eventName` - the `eventName` corresponds to an experiment `metric`. In addition, Segment maps Track event `context.traits` to Optimizely `attributes`. > warning "Optimizely SDKs v1.x or v2.x require matching `attributes` objects for correct attribution" -> If you use Optimizely SDKs v1.x or v2.x and use any `activate` or `isFeatureEnabled` calls, the `attributes` object for each user must match the `attributes` object passed to any `track` calls for that user id so that it can be correctly attributed on the Optimizely results page. +> If you use Optimizely SDKs v1.x or v2.x and use any `activate` or `isFeatureEnabled` calls, the `attributes` object for each user must match the `attributes` object passed to any Track calls for that user ID so that it can be correctly attributed on the Optimizely results page. -If you are using Optimizely SDKs v3+, [Easy Event Tracking](https://blog.optimizely.com/2019/02/26/introducing-easy-event-tracking-the-easier-way-to-understand-and-optimize-the-customer-journey/){:target="_blank"} is enabled by default for decision events. Set up does not require maintaining the attributes of a user as long as the user id stays the same between Optimizely `activate` and `isFeatureEnabled` calls and Segment `track` calls to have Optimizely `metrics` populated in the Optimizely results page. If you would like to segment your Optimizely results by user `attribute`, then make sure the `attributes` passed in for the `activate` and `isFeatureEnabled` calls match the `attributes` passed in for the `track` calls for that user id. +If you are using Optimizely SDKs v3+, [Easy Event Tracking](https://blog.optimizely.com/2019/02/26/introducing-easy-event-tracking-the-easier-way-to-understand-and-optimize-the-customer-journey/){:target="_blank"} is enabled by default for decision events. Set up does not require maintaining the attributes of a user as long as the user ID stays the same between Optimizely `activate` and `isFeatureEnabled` calls and Segment Track calls to have Optimizely `metrics` populated in the Optimizely results page. If you would like to segment your Optimizely results by user `attribute`, then make sure the `attributes` passed in for the `activate` and `isFeatureEnabled` calls match the `attributes` passed in for the Track calls for that user id. -For more details on how events are attributed on the Optimizely results page, refer to their documentation [How Optimzely Experimentation counts conversions](https://support.optimizely.com/hc/en-us/articles/19888476989325-How-Optimizely-Experimentation-counts-conversions){:target="_blank"}. +For more details on how events are attributed on the Optimizely results page, refer to Optimizely's documentation on [How Optimzely Experimentation counts conversions](https://support.optimizely.com/hc/en-us/articles/19888476989325-How-Optimizely-Experimentation-counts-conversions){:target="_blank"}. ### Track -Upon invocation of a Segment `track` event, Segment maps the event to an Optimizely `track` event: -* If the Segment event name matches exactly the name of an active experiment `metric` set up in the Optimizely dashboard; -* If the experiment `metric` is associated with a running experiment; -* If the current user has been assigned a `userId` using Segment's `identify` method (for example, `analytics.identify('123')`); +Upon invocation of a Segment Track event, Segment maps the event to an Optimizely `track` event: +* If the Segment event name matches exactly the name of an active experiment `metric` set up in the Optimizely dashboard. +* If the experiment `metric` is associated with a running experiment. +* If the current user has been assigned a `userId` using Segment's Identify method (for example, `analytics.identify('123')`). * If the current user is activated in a running experiment with the associated `metric`. Segment also handles the following mapping: -* Segment `track` event name to Optimizely `eventName`. -* Segment `track` event `properties` to Optimizely `eventTags`. -* Segment `track` event `context.traits` to Optimizely `attributes`. +* Segment Track event name to Optimizely `eventName`. +* Segment Track event `properties` to Optimizely `eventTags`. +* Segment Track event `context.traits` to Optimizely `attributes`. -`revenue` values should be passed as a Segment `property`. The value should be an integer and represent the value in cents, so, for example, $1 should be represented by `100`. +`revenue` values should be passed as a Segment `property`. The value should be an integer and represent the value in cents. For example, $1 should be represented by `100`. > info "Custom Event Tags are not displayed on the Optimizely results page" > Optimizely's [Custom Event Tags](https://docs.developers.optimizely.com/full-stack/docs/include-event-tags){:target="_blank"}, which include all Event Tags except `revenue` and `value`, are not displayed on the Optimizely results page. However, these tags are available in a [Data Export](https://docs.developers.optimizely.com/web/docs/data-export){:target="_blank"} report. Event Tags can be strings, integers, floating point numbers, or boolean values. Optimizely rejects events with any other data types (for example, arrays). -Segment defaults to identifying users with their `anonymousId`. Enabling the "Use User ID" setting in your Segment settings means that only `track` events triggered by identified users are passed downstream to Optimizely. You may optionally fall back to `anonymousId` when `userId` is unavailable by setting `fallbackToAnonymousId` to `true`. +Segment defaults to identifying users with their `anonymousId`. Enabling the **Use User ID** setting in your Segment settings means that only Track events triggered by identified users are passed downstream to Optimizely. You may optionally fall back to `anonymousId` when `userId` is unavailable by setting `fallbackToAnonymousId` to `true`. -### Notification Listeners +### Notification listeners -Segment's server-side integration with Optimizely Full Stack does not support notification listeners for Segment`track` events. [Notification listeners](https://docs.developers.optimizely.com/full-stack/docs/notification-listeners){:target="_blank"} are still available with any native call invoked from your Optimizely client instance. +Segment's server-side integration with Optimizely Full Stack does not support notification listeners for SegmentTrack events. [Notification listeners](https://docs.developers.optimizely.com/full-stack/docs/notification-listeners){:target="_blank"} are still available with any native call invoked from your Optimizely client instance. -## Android Cloud-mode Implementation +## Android cloud-mode implementation -### Getting Started +### Getting started -1. In your Segment source dashboard, enable the "Optimizely Full Stack" destination (*not the "Optimizely Web" destination*). +1. In your Segment source dashboard, enable the "Optimizely Full Stack" destination (**not the "Optimizely Web" destination**). 2. Include the latest version of Optimizely Full Stack's native SDK in your your app-level build.gradle file and [implement Optimizely as your would natively](https://docs.developers.optimizely.com/full-stack/docs/install-the-sdk#section-android){:target="_blank"}. -3. Finally, define any [`events`](https://docs.developers.optimizely.com/full-stack/docs/create-events){:target="_blank"} and [`attributes`](https://docs.developers.optimizely.com/full-stack/docs/define-attributes){:target="_blank"} in your Optimizely dashboard, and associate `metrics` with the appropriate Optimizely Experiments. Segment maps `track` event names to Optimizely `eventName` - the `eventName` corresponds to an experiment `metric`. In addition, Segment maps `identify` `traits` to Optimizely `attributes`. +3. Finally, define any [`events`](https://docs.developers.optimizely.com/full-stack/docs/create-events){:target="_blank"} and [`attributes`](https://docs.developers.optimizely.com/full-stack/docs/define-attributes){:target="_blank"} in your Optimizely dashboard, and associate `metrics` with the appropriate Optimizely Experiments. Segment maps Track event names to Optimizely `eventName` - the `eventName` corresponds to an experiment `metric`. In addition, Segment maps Identify `traits` to Optimizely `attributes`. -When implementing Optimizely Full Stack using cloud-mode, Segment will map `track` events to Optimizely `track` events on our servers and deliver the data to your Optimizely project as usual. +When implementing Optimizely Full Stack using cloud-mode, Segment maps Track events to Optimizely Track events on our servers and deliver the data to your Optimizely project as usual. > warning "Optimizely SDKs v1.x or v2.x require matching `attributes` objects for correct attribution" -> If you use Optimizely SDKs v1.x or v2.x and use any `activate` or `isFeatureEnabled` calls, the `attributes` object for each user must match the `attributes` object passed to any `track` calls for that user id so that it can be correctly attributed on the Optimizely results page. +> If you use Optimizely SDKs v1.x or v2.x and use any `activate` or `isFeatureEnabled` calls, the `attributes` object for each user must match the `attributes` object passed to any Track calls for that user id so that it can be correctly attributed on the Optimizely results page. -If you are using Optimizely SDKs v3+, [Easy Event Tracking](https://blog.optimizely.com/2019/02/26/introducing-easy-event-tracking-the-easier-way-to-understand-and-optimize-the-customer-journey/){:target="_blank"} is enabled by default for decision events. Set up does not require maintaining the attributes of a user as long as the user id stays the same between Optimizely `activate` and `isFeatureEnabled` calls and Segment `track` calls to have Optimizely `metrics` populated in the Optimizely results page. If you would like to segment your Optimizely results by user `attribute`, then make sure the `attributes` passed in for the `activate` and `isFeatureEnabled` calls match the `attributes` passed in for the `track` calls for that user id. +If you are using Optimizely SDKs v3+, [Easy Event Tracking](https://blog.optimizely.com/2019/02/26/introducing-easy-event-tracking-the-easier-way-to-understand-and-optimize-the-customer-journey/){:target="_blank"} is enabled by default for decision events. Set up does not require maintaining the attributes of a user as long as the user id stays the same between Optimizely `activate` and `isFeatureEnabled` calls and Segment Track calls to have Optimizely `metrics` populated in the Optimizely results page. If you would like to segment your Optimizely results by user `attribute`, then make sure the `attributes` passed in for the `activate` and `isFeatureEnabled` calls match the `attributes` passed in for the Track calls for that user id. -For more details on how events are attributed on the Optimizely results page, refer to their documentation [How Optimzely Experimentation counts conversions](https://support.optimizely.com/hc/en-us/articles/19888476989325-How-Optimizely-Experimentation-counts-conversions){:target="_blank"}. +For more details on how events are attributed on the Optimizely results page, refer to Optimizely's documentation on [How Optimzely Experimentation counts conversions](https://support.optimizely.com/hc/en-us/articles/19888476989325-How-Optimizely-Experimentation-counts-conversions){:target="_blank"}. ### Track -Upon invocation of a Segment `track` event, Segment maps the event to an Optimizely `track` event: -* If the Segment event name matches exactly the name of an active experiment `metric` set up in the Optimizely dashboard; -* If the experiment `metric` is associated with a running experiment; +Upon invocation of a Segment Track event, Segment maps the event to an Optimizely Track event: +* If the Segment event name matches exactly the name of an active experiment `metric` set up in the Optimizely dashboard. +* If the experiment `metric` is associated with a running experiment. * If the current user is activated in a running experiment with the associated `metric`. Segment also handles the following mapping: -* Segment `track` event name to Optimizely `eventName`. -* Segment `track` event `properties` to Optimizely `eventTags`. +* Segment Track event name to Optimizely `eventName`. +* Segment Track event `properties` to Optimizely `eventTags`. -`revenue` values should be passed as a Segment `property`. The value should be an integer and represent the value in cents, so, for example, $1 should be represented by `100`. +`revenue` values should be passed as a Segment `property`. The value should be an integer and represent the value in cents. For example, $1 should be represented by `100`. > info "Custom Event Tags are not displayed on the Optimizely results page" > Optimizely's [Custom Event Tags](https://docs.developers.optimizely.com/full-stack/docs/include-event-tags){:target="_blank"}, which include all Event Tags except `revenue` and `value`, are not displayed on the Optimizely results page. However, these tags are available in a [Data Export](https://docs.developers.optimizely.com/web/docs/data-export){:target="_blank"} report. Event Tags can be strings, integers, floating point numbers, or boolean values. Optimizely rejects events with any other data types (for example, arrays). -Segment defaults to identifying users with their `anonymousId`. Enabling "Use User ID" setting in your Segment dashboard means that only `track` events triggered by identified users are passed downstream to Optimizely. You may optionally fall back to `anonymousId` when `userId` is unavailable by setting `fallbackToAnonymousId` to `true`. +Segment defaults to identifying users with their `anonymousId`. Enabling the **Use User ID** setting in your Segment dashboard means that only Track events triggered by identified users are passed downstream to Optimizely. You may optionally fall back to `anonymousId` when `userId` is unavailable by setting `fallbackToAnonymousId` to `true`. ### Identify -Invoking a Segment `identify` event sets Segment `traits` as Optimizely `attributes`. The `attributes` are sent downstream to Optimizely upon invocation of the next Segment `track` event. +Invoking a Segment Identify event sets Segment `traits` as Optimizely `attributes`. The `attributes` are sent downstream to Optimizely upon invocation of the next Segment Track event. ## Reset Invoking this method invalidates the listener for the `Experiment Viewed` event. -### Notification Listeners +### Notification listeners -If you want to use Optimizely's [notification listeners](https://docs.developers.optimizely.com/full-stack/docs/notification-listeners){:target="_blank"}, you must use the Optimizely native code to invoke them (in addition to using the Segment SDKs). Notification listeners require an [instantiated Optimizely client](https://docs.developers.optimizely.com/full-stack/docs/java#section-2-instantiate-optimizely){:target="_blank"} to be accessed, and so are not available for Segment `track` events when you connect to Optimizely using cloud-mode. +If you want to use Optimizely's [notification listeners](https://docs.developers.optimizely.com/full-stack/docs/notification-listeners){:target="_blank"}, you must use the Optimizely native code to invoke them (in addition to using the Segment SDKs). Notification listeners require an [instantiated Optimizely client](https://docs.developers.optimizely.com/full-stack/docs/java#section-2-instantiate-optimizely){:target="_blank"} to be accessed, and so are not available for Segment Track events when you connect to Optimizely using cloud-mode. +## iOS cloud-mode implementation -## iOS Cloud-mode Implementation +### Getting started -### Getting Started - -1. In your Segment source dashboard, enable the "Optimizely Full Stack" destination (*not the "Optimizely Web" destination*). +1. In your Segment source dashboard, enable the "Optimizely Full Stack" destination (**not the "Optimizely Web" destination**). 2. Include the latest version of Optimizely Full Stack's native SDK in your app and [implement it as you would natively](https://docs.developers.optimizely.com/full-stack/docs/install-the-sdk#section-ios-and-tvos){:target="_blank"}. -3. Finally, define any [`events`](https://docs.developers.optimizely.com/full-stack/docs/create-events){:target="_blank"} and [`attributes`](https://docs.developers.optimizely.com/full-stack/docs/define-attributes){:target="_blank"} in your Optimizely dashboard, and to associate `metrics` with the appropriate Optimizely Experiments. Segment maps `track` event names to Optimizely `eventName` - the `eventName` corresponds to an experiment `metric`. In addition, Segment maps `identify` `traits` to Optimizely `attributes`. +3. Finally, define any [`events`](https://docs.developers.optimizely.com/full-stack/docs/create-events){:target="_blank"} and [`attributes`](https://docs.developers.optimizely.com/full-stack/docs/define-attributes){:target="_blank"} in your Optimizely dashboard, and to associate `metrics` with the appropriate Optimizely Experiments. Segment maps Track event names to Optimizely `eventName` - the `eventName` corresponds to an experiment `metric`. In addition, Segment maps Identify `traits` to Optimizely `attributes`. -When implementing Optimizely using cloud-mode, Segment will map `track` events to Optimizely `track` events on our servers and deliver the data to your Optimizely project as usual. +When implementing Optimizely using cloud-mode, Segment mapS Track events to Optimizely Track events on our servers and deliver the data to your Optimizely project as usual. -> warning "Optimizely SDKs v1.x or v2.x require matching `attributes` objects for correct attribution" +> warning "Optimizely SDKs v1.x or v2.x require matching attributes objects for correct attribution" > If you use Optimizely SDKs v1.x or v2.x and use any `activate` or `isFeatureEnabled` calls, the `attributes` object for each user must match the `attributes` object passed to any Track calls for that user id so that it can be correctly attributed on the Optimizely results page. -If you are using Optimizely SDKs v3+, [Easy Event Tracking](https://blog.optimizely.com/2019/02/26/introducing-easy-event-tracking-the-easier-way-to-understand-and-optimize-the-customer-journey/){:target="_blank"} is enabled by default for decision events. Set up does not require maintaining the attributes of a user as long as the user id stays the same between Optimizely `activate` and `isFeatureEnabled` calls and Segment `track` calls to have Optimizely `metrics` populated in the Optimizely results page. If you would like to segment your Optimizely results by user `attribute`, then make sure the `attributes` passed in for the `activate` and `isFeatureEnabled` calls match the `attributes` passed in for the `track` calls for that user id. +If you are using Optimizely SDKs v3+, [Easy Event Tracking](https://blog.optimizely.com/2019/02/26/introducing-easy-event-tracking-the-easier-way-to-understand-and-optimize-the-customer-journey/){:target="_blank"} is enabled by default for decision events. Set up does not require maintaining the attributes of a user as long as the user id stays the same between Optimizely `activate` and `isFeatureEnabled` calls and Segment Track calls to have Optimizely `metrics` populated in the Optimizely results page. If you would like to segment your Optimizely results by user `attribute`, then make sure the `attributes` passed in for the `activate` and `isFeatureEnabled` calls match the `attributes` passed in for the Track calls for that user id. -For more details on how events are attributed on the Optimizely results page, refer to their documentation [How Optimzely Experimentation counts conversions](https://support.optimizely.com/hc/en-us/articles/19888476989325-How-Optimizely-Experimentation-counts-conversions){:target="_blank"}. +For more details on how events are attributed on the Optimizely results page, refer to Optimizely's documentation on [How Optimzely Experimentation counts conversions](https://support.optimizely.com/hc/en-us/articles/19888476989325-How-Optimizely-Experimentation-counts-conversions){:target="_blank"}. ### Track -Upon invocation of a Segment `track` event, Segment maps the event to an Optimizely `track` event: -* If the Segment event name matches exactly the name of an active experiment `metric` set up in the Optimizely dashboard; -* If the experiment `metric` is associated with a running experiment; +Upon invocation of a Segment Track event, Segment maps the event to an Optimizely Track event: +* If the Segment event name matches exactly the name of an active experiment `metric` set up in the Optimizely dashboard. +* If the experiment `metric` is associated with a running experiment. * If the current user is activated in a running experiment with the associated `metric`. Segment also handles the following mapping: -* Segment `track` event name to Optimizely `eventName`. -* Segment `track` event `properties` to Optimizely `eventTags`. +* Segment Track event name to Optimizely `eventName`. +* Segment Track event `properties` to Optimizely `eventTags`. -`revenue` values should be passed as a Segment `property`. The value should be an integer and represent the value in cents, so, for example, $1 should be represented by `100`. +`revenue` values should be passed as a Segment `property`. The value should be an integer and represent the value in cents. For example, $1 should be represented by `100`. > info "Custom Event Tags are not displayed on the Optimizely results page" > Optimizely's [Custom Event Tags](https://docs.developers.optimizely.com/full-stack/docs/include-event-tags){:target="_blank"}, which include all Event Tags except `revenue` and `value`, are not displayed on the Optimizely results page. However, these tags are available in a [Data Export](https://docs.developers.optimizely.com/web/docs/data-export){:target="_blank"} report. Event Tags can be strings, integers, floating point numbers, or boolean values. Optimizely rejects events with any other data types (for example, arrays). -Segment defaults to identifying users with their `anonymousId`. Enabling "Use User ID" setting in your Segment dashboard means that only `track` events triggered by identified users are passed downstream to Optimizely. You may optionally fall back to `anonymousId` when `userId` is unavailable by setting `fallbackToAnonymousId` to `true`. +Segment defaults to identifying users with their `anonymousId`. Enabling the **Use User ID** setting in your Segment dashboard means that only Track events triggered by identified users are passed downstream to Optimizely. You may optionally fall back to `anonymousId` when `userId` is unavailable by setting `fallbackToAnonymousId` to `true`. ### Identify -Invoking a Segment `identify` event sets Segment `traits` as Optimizely `attributes`. The `attributes` are sent downstream to Optimizely upon invocation of the next Segment `track` event. +Invoking a Segment Identify event sets Segment `traits` as Optimizely `attributes`. The `attributes` are sent downstream to Optimizely upon invocation of the next Segment Track event. -### Notification Listeners +### Notification listeners -Notification listeners are not available for Segment `track` events when implementing Optimizely using Segment using cloud-mode. [Notification listeners](https://docs.developers.optimizely.com/full-stack/docs/notification-listeners){:target="_blank"} are still available with any native call invoked from your Optimizely client instance. +Notification listeners are not available for Segment Track events when implementing Optimizely using Segment using cloud-mode. [Notification listeners](https://docs.developers.optimizely.com/full-stack/docs/notification-listeners){:target="_blank"} are still available with any native call invoked from your Optimizely client instance. ## Engage Follow these instructions on how to set up Engage and Optimizely: -* [Using Segment Personas and Optimizely Full Stack for Omnichannel Experiments](https://www.optimizely.com/insights/blog/segment-personas-optimizely-full-stack-omnichannel-experiments/){:target="_blank"} +* [Using Segment Personas and Optimizely Full Stack for Omnichannel Experiments](https://www.optimizely.com/insights/blog/segment-personas-optimizely-full-stack-omnichannel-experiments/){:target="_blank"}. -## GDPR Support -Segment supports deleting/suppressing users in Optimizely using the [Segment app](/docs/privacy/user-deletion-and-suppression/). In order to do this however, you will need to create a [Personal Access Token](https://developers.optimizely.com/x/authentication/personal-token/){:target="_blank"} in Optimizely and provide it as the value of the Access Token setting. +## GDPR support +Segment supports deleting or rsuppressing users in Optimizely using the [Segment app](/docs/privacy/user-deletion-and-suppression/). In order to do this however, you need to create a [Personal Access Token](https://developers.optimizely.com/x/authentication/personal-token/){:target="_blank"} in Optimizely and provide it as the value of the Access Token setting. diff --git a/src/connections/destinations/catalog/pendo/index.md b/src/connections/destinations/catalog/pendo/index.md index 7d6f0f35f7..5ed5e8ac11 100644 --- a/src/connections/destinations/catalog/pendo/index.md +++ b/src/connections/destinations/catalog/pendo/index.md @@ -5,36 +5,34 @@ id: 575ef2fc80412f644ff139be --- [Pendo](http://www.pendo.io/){:target="_blank"} is a product cloud that helps product teams deliver software users love. With Pendo, product teams can understand product usage, collect feedback, measure NPS, onboard users, and announce new features in app—all without requiring engineering resources. -Pendo maintains this destination. For any issues with the destination, [contact the Pendo Support team](https://support.pendo.io/hc/en-us/articles/360034163971){:target="_blank"}. - -## Getting Started - +Pendo maintains this destination. For any issues with the destination, [contact the Pendo support team](https://support.pendo.io/hc/en-us/articles/360034163971){:target="_blank"}. +## Getting started 1. From the Segment web app, click **Catalog**. 2. Search for "Pendo" in the Catalog, select it, and choose which of your sources to connect the destination to. -3. In the destination settings, enter your Pendo API Key which a Pendo admin can find in the Pendo UI by going to Settings > [Subscription Settings](https://app.pendo.io/admin){:target="_blank"} > Applications, opening the relevant app, then locating the **API key** value. +3. In the destination settings, enter your Pendo API Key. To find the key in the Pendo UI as a Pendo admin, go to **Settings > [Subscription Settings](https://app.pendo.io/admin){:target="_blank"} > Applications**, open the relevant app, then locate the **API key** value. Your changes appear in the Segment CDN in about 45 minutes, and then Analytics.js starts asynchronously loading Pendo's snippet on your page and sending data. - This pulls in all page and click events without needing to make additional method calls. +This pulls in all page and click events without needing to make additional method calls. ### Cloud-mode configuration -> info "" -> The Pendo destination does not natively support Cloud-mode connections. Use the [Webhook](/docs/connections/destinations/catalog/webhooks) destination to send data to Pendo using a Cloud-mode connection. +> info "Pendo does not natively support cloud-mode connections" +> The Pendo destination does not natively support cloud-mode connections. Use the [webhook](/docs/connections/destinations/catalog/webhooks) destination to send data to Pendo using a cloud-mode connection. -To add the Pendo destination using Cloud-mode, use the [Webhooks](/docs/connections/destinations/catalog/webhooks) destination to enable Segment to send data to Pendo through a webhook. +To add the Pendo destination using cloud-mode, use the [webhooks](/docs/connections/destinations/catalog/webhooks) destination to enable Segment to send data to Pendo through a webhook. 1. From the Segment web app, click **Catalog**. 2. Search for **Webhooks** in the Catalog, select it, and choose which of your JavaScript sources to connect the destination to. -3. Webhook URL configuration will vary based on which Pendo environment you use and your API key: - * For US customers, add the following as your Webhook URL: `https://data.pendo.io/data/segmentio/YOUR_PENDO_API_KEY` and replace `YOUR_PENDO_API_KEY` with your actual Pendo API Key, which a Pendo Admin can find in the Pendo UI by going to **Settings** > [Subscription Settings](https://app.pendo.io/admin){:target="_blank"} > **Applications**, opening the relevant app, then locating the **API key** value. - * For EU customers, add the following as your Webhook URL: `https://data.eu.pendo.io/data/segmentio/YOUR_PENDO_API_KEY` and replace `YOUR_PENDO_API_KEY` with your actual Pendo API Key, which a Pendo Admin can find in the Pendo UI by going to **Settings** > [Subscription Settings](https://app.eu.pendo.io/admin){:target="_blank"} > **Applications**, opening the relevant app, then locating the **API Key** value. +3. Webhook URL configuration varies based on which Pendo environment you use and your API key: + * For US customers, add the following as your Webhook URL: `https://data.pendo.io/data/segmentio/YOUR_PENDO_API_KEY` and replace `YOUR_PENDO_API_KEY` with your actual Pendo API Key. + * For EU customers, add the following as your Webhook URL: `https://data.eu.pendo.io/data/segmentio/YOUR_PENDO_API_KEY` and replace `YOUR_PENDO_API_KEY` with your actual Pendo API Key. 4. Headers are not required in Webhook configuration. Once you're done adding in your URL, save changes. -5. Using the `track` method requires a setting enabled on your Pendo subscription (cloud-mode only). Contact Pendo to enable this feature flag for your account. +5. Using the [Track method](/docs/connections/spec/track/) requires a setting enabled on your Pendo subscription (cloud-mode only). Contact Pendo to enable this feature flag for your account. -To learn more about server-side data to Pendo, see Pendo's [support documentation](https://support.pendo.io/hc/en-us/articles/360031870352){:target = "_blank"}. +To learn more about server-side data to Pendo, see Pendo's [support documentation](https://support.pendo.io/hc/en-us/articles/360031870352){:target="_blank"}. ## Identify diff --git a/src/connections/destinations/catalog/planhat/index.md b/src/connections/destinations/catalog/planhat/index.md index 15f4744cb9..08cb3c80a4 100644 --- a/src/connections/destinations/catalog/planhat/index.md +++ b/src/connections/destinations/catalog/planhat/index.md @@ -2,28 +2,25 @@ title: Planhat Destination id: 55bbefd70a20f4e22f0fb3e5 --- -## Getting Started +## Getting started -Getting data from Segment to Planhat's [Customer Success Tool](http://www.planhat.com/){:target="_blank"} is easy. +You can get data from Segment to Planhat's [Customer Success Tool](http://www.planhat.com/){:target="_blank"} following these steps: +1. Once the Segment library is integrated with your product, toggle Planhat on in your Segment destinations. +2. Add your Planhat API Key which you can generate in Planhat under **App Settings > API Access**. -Once the Segment library is integrated with your product, toggle Planhat on in your Segment destinations, and add your Planhat API Key which you can generate in Planhat under App Settings > API Access. +The Segment-Planhat destination is 100% handled through the Segment servers, so you don't need to bundle their iOS or Android SDKs. Your Segment SDK is enough. -The Segment Planhat destination is 100% handled through our servers, so you don't need to bundle their iOS or Android SDKs. Your Segment SDK will be enough. - -The Segment Planhat destination supports Identify, Page, Track, and Group calls. For more information, see the [Segment Spec documentation](/docs/connections/spec/). - -- - - +The destination also supports Identify, Page, Track, and Group calls. For more information, see the [Segment Spec documentation](/docs/connections/spec/). ## Identify -When you `identify` a user, we'll pass that user's information to Planhat with `userId` as Planhat's External User ID. Segment's special traits recognized as Planhat's standard contact profile fields (in parentheses) are: - -- `name` (`name`) -- `title` (`title`) -- `email` (`email`) -- `user_id` (`externalId`) +When you Identify a user, the user's information is passed on to Planhat with `userId` as Planhat's External User ID. Segment's special traits recognized as Planhat's standard contact profile fields (in parentheses) are: +- `name` (`name`). +- `title` (`title`). +- `email` (`email`). +- `user_id` (`externalId`). -In addition, all calls will get Segment as 'source'. +In addition, all calls get Segment as 'source'. -If the `userId` or `traits.email` matches an existing Contact in Planhat the Identify-call will automatically be associated with that Contact. Otherwise a new Contact will be created in Planhat. New Contacts received from Segment can either be discarded or manually assigned to a Customer profile in Planhat. +If the `userId` or `traits.email` matches an existing Contact in Planhat the Identify-call is automatically associated with that Contact. Otherwise a new Contact is created in Planhat. New Contacts received from Segment can either be discarded or manually assigned to a Customer profile in Planhat. diff --git a/src/connections/destinations/catalog/posthog/index.md b/src/connections/destinations/catalog/posthog/index.md index d4fa611dd3..07fa921e84 100644 --- a/src/connections/destinations/catalog/posthog/index.md +++ b/src/connections/destinations/catalog/posthog/index.md @@ -11,15 +11,15 @@ This destination is maintained by PostHog. For any issues with the destination, ## Getting started -1. From the Destinations catalog page in the Segment App, click **Add Destination**. +1. From the destinations catalog page in the Segment App, click **Add Destination**. 2. Search for "PostHog" in the Destinations Catalog, and select the PostHog destination. -3. Choose which Source should send data to the PostHog destination. +3. Choose which source should send data to the PostHog destination. 4. Go to your [PostHog project settings](https://us.posthog.com/settings/project#variables){:target="_blank"}, and copy the **project API key**. 5. Enter the project API Key that you copied in the PostHog destination settings in Segment. -6. Enter your PostHog instance address *without any trailing slash*, for example: - - `https://us.i.posthog.com` if you use PostHog US Cloud - - `https://eu.i.posthog.com` if you use PostHog EU Cloud - - Your self-hosted URL if you self-host +6. Enter your PostHog instance address **without any trailing slash**, for example: + - `https://us.i.posthog.com` if you use PostHog US Cloud. + - `https://eu.i.posthog.com` if you use PostHog EU Cloud. + - Your self-hosted URL if you self-host. ## Page @@ -36,7 +36,7 @@ Segment sends Page calls to PostHog as a `$pageview`. If you aren't familiar with the Segment Spec, take a look at the [Screen method documentation](/docs/connections/spec/screen/) to learn about what it does. An example call would look like: -```obj +```objc [[SEGAnalytics sharedAnalytics] screen:@"Home"]; ``` diff --git a/src/connections/destinations/catalog/preact/index.md b/src/connections/destinations/catalog/preact/index.md index 42e22ca178..abcafd81ef 100644 --- a/src/connections/destinations/catalog/preact/index.md +++ b/src/connections/destinations/catalog/preact/index.md @@ -1,32 +1,31 @@ --- title: Preact Destination +hidden: true --- ## Identify -To create users in in Preact you'll use our [`identify`](/docs/connections/spec/identify) method. Users must be identified on the client side for events to appear in Preact. +To create users in in Preact, use the [Identify](/docs/connections/spec/identify) method. Users must be identified on the client side for events to appear in Preact. ## Group -To group users into accounts in preact you'll use our [`group`](/docs/connections/spec/group) method. +To group users into accounts in Preact, use the [Group](/docs/connections/spec/group) method. ## Track -Our [`track`](/docs/connections/spec/track) method will record events in Preact. Users must be identified on the client side for events to appear in Preact. - -- - - +The [Track](/docs/connections/spec/track) method records events in Preact. Users must be identified on the client side for events to appear in Preact. ## Features -### Recording Errors +### Recording errors -Preact can be really useful for customer support. For that to work well you'll want to send error events to Preact. +Preact can be useful for customer support. For that to work, you can send error events to Preact. -All you have to do is add a "!" as the first character in the event name and Preact will recognize it as an error event. Properties sent with the event will also show up in Preact. +Add a "!" as the first character in the event name and Preact recognizes it as an error event. Properties sent with the event also show up in Preact. Here's a JavaScript example: ```javascript diff --git a/src/connections/destinations/catalog/primer/index.md b/src/connections/destinations/catalog/primer/index.md index f1768bba1e..10c61810a1 100644 --- a/src/connections/destinations/catalog/primer/index.md +++ b/src/connections/destinations/catalog/primer/index.md @@ -16,8 +16,6 @@ Since Primer needs to be initialized as early as possible, you need to supply th This will initialize the Primer SDK under the hood and begin collecting events and initializing the Primer Flow. -- - - - Primer supports the `identify` and `track` methods. ## Identify diff --git a/src/connections/destinations/catalog/promoter-io/index.md b/src/connections/destinations/catalog/promoter-io/index.md index 879a15f2d1..045244a84a 100644 --- a/src/connections/destinations/catalog/promoter-io/index.md +++ b/src/connections/destinations/catalog/promoter-io/index.md @@ -11,8 +11,6 @@ hide-dossier: true Once the Segment library is integrated with your service, add your Promoter API Key and enable Promoter in your Segment destinations page. You can find your API key in Promoter.io under **Accounts Settings > Segment Destination**. -- - - - Promoter supports the `identify` and `track` methods from Segment and will allow you to: - Add a contact to a list diff --git a/src/connections/destinations/catalog/quora-conversion-pixel/index.md b/src/connections/destinations/catalog/quora-conversion-pixel/index.md index e63c492aac..5e9b0ae384 100644 --- a/src/connections/destinations/catalog/quora-conversion-pixel/index.md +++ b/src/connections/destinations/catalog/quora-conversion-pixel/index.md @@ -13,13 +13,13 @@ id: 5952698570a3e552b9575519 2. Search for "Quora" in the Catalog, select it, and choose which of your sources to connect the destination to. 3. Add your Quora Conversion Pixel Key to your Destination settings. To get this you will need to do the following: - i. Log into your [Quora Ads Manager Account](https://www.quora.com/ads/account){:target="_blank"}. + 1. Log into your [Quora Ads Manager Account](https://www.quora.com/ads/account){:target="_blank"}. - ii. Navigate to the "Quora Pixel" tab in your Quora Dashboard. + 2. Navigate to the "Quora Pixel" tab in your Quora Dashboard. - iii. Click the "Setup Pixel" button to open the installation popup modal. + 3. Click the "Setup Pixel" button to open the installation popup modal. - iv. Under "Option A: Install a JavaScript Pixel," find your Quora Conversion Pixel Key in the Quora JavaScript Pixel - the key is embedded in a tag that looks like `qp('init', '7cc5a029c2604daa8365d15ff337146e')`. In the example below, the key is `7cc5a029c2604daa8365d15ff337146e`. + 4. Under "Option A: Install a JavaScript Pixel," find your Quora Conversion Pixel Key in the Quora JavaScript Pixel - the key is embedded in a tag that looks like `qp('init', '7cc5a029c2604daa8365d15ff337146e')`. In the example below, the key is `7cc5a029c2604daa8365d15ff337146e`. ## Track diff --git a/src/connections/destinations/catalog/ramen/index.md b/src/connections/destinations/catalog/ramen/index.md index c4f612e7f3..6a98813dc9 100644 --- a/src/connections/destinations/catalog/ramen/index.md +++ b/src/connections/destinations/catalog/ramen/index.md @@ -2,19 +2,20 @@ title: Ramen Destination id: 558c9d1a0a20f4e22f0fb3bb --- + ## Getting Started When you enable Ramen in the Segment web app, your changes appear in the Segment CDN in about 45 minutes, and then Analytics.js starts asynchronously loading Ramen's JavaScript library onto your page. This means you should remove Ramen's snippet from your page if you already have it there. -​ -+ As of March 2016, Ramen supports asking questions of anonymous website visitors in addition to logged-in users. Calling [`page`](#page), [`track`](#track), and [`group`](#group) will work without calling [`identify`](#identify). However, when you call [`identify`](#identify) you _must_ pass in an `id` or else the Ramen destination will ignore the call. -​ -​ + +- As of March 2016, Ramen supports asking questions of anonymous website visitors in addition to logged-in users. Calling [`page`](#page), [`track`](#track), and [`group`](#group) will work without calling [`identify`](#identify). However, when you call [`identify`](#identify) you _must_ pass in an `id` or else the Ramen destination will ignore the call. + ## Identify -​ + When you make an [Identify call](/docs/connections/spec/identify) on Analytics.js, it identifies the logged-in user to Ramen. -​ + Here is a full example, which we will annotate below: -​ + + ```javascript analytics.identify('314159', { email: 'ryan@charturl.com', @@ -25,9 +26,9 @@ analytics.identify('314159', { mrr: 149.99 }); ``` -​ + Here is a list of the attributes we process: -​ + * `id` becomes the `id` of the user in Ramen. * `email` becomes the `email` of the user in Ramen. * `name` becomes the `name` of the user in Ramen. @@ -35,16 +36,13 @@ Here is a list of the attributes we process: * If `company` is an `Object` with an `id` attribute, we'll treat that information as if it was passed to [`group`](#group) and create a company in Ramen. * Attributes with names ending in `_at` will be parsed as times. * Attributes with names beginning with `is_` will be parsed as Booleans. -​ -​ + **Note:** Ramen will ignore any calls to `identify` that do not contain `userId`. -​ -​ -​ + ## Group -​ + Segment supports Ramen Companies in Analytics.js through the [`group`](/docs/connections/spec/group) method. Users can be put into multiple groups, which will associate them to multiple companies in Ramen. -​ + Here is a full example, which we will annotate below: ​ ```javascript @@ -57,49 +55,44 @@ analytics.group('314159', { mrr: 149.99 }); ``` -​ + Here is a list of the attributes we process: -​ + * `id` becomes the `id` of the company in Ramen. * `url` becomes the `url` of the company in Ramen. * `name` becomes the `name` of the company in Ramen. * `created_at` becomes the `company_created_at` timestamp for the company in Ramen. It can be passed in as a `Date` or seconds since the epoch. * Other attributes can be passed in as well, and will parsed according to the same rules as denoted in the [`identify`](#identify) section. -​ -​ + ## Page -​ + When you call [`page`](/docs/connections/spec/page) on Analytics.js, it registers a new pageview in Ramen and checks to see if any questions should be asked. -​ + Ramen does not support passing in any attributes to `page`. You can call `page({ title: "Our page" })` but the attributes (ie. `title` in this example) will be ignored. -​ -​ + ## Track -​ + When you call [`track`](/docs/connections/spec/track) on Analytics.js, it registers a new event in Ramen and checks to see if any questions should be asked. -​ + Ramen does not support passing in any attributes to `track` beyond the event name. You can call `track('Subscribed', { plan: "Startup" })` but the attributes (ie. `plan` in this example) will be ignored. -​ -​ -- - - -​ + + ## Features -​ -​ + ### Secure Mode -​ + If you want to enable Ramen [secure mode](http://docs.ramen.is/#secure-mode){:target="_blank"} for analytics.js, you can pass in the `timestamp` and `auth_hash` variables by rendering it in your server-side templates. -​ + The `timestamp` should be a Unix timestamp (epoch seconds). The `auth_hash` is a SHA256 has of several attributes. The hash is not based on the email, it is based on: -​ -+ user.email - If you do not store emails for your customers, use an empty string -+ user.id -+ user.name - If you do not have a name for your customers, use their email address or an empty string -+ timestamp -+ Ramen API Secret -​ + +- user.email - If you do not store emails for your customers, use an empty string +- user.id +- user.name - If you do not have a name for your customers, use their email address or an empty string +- timestamp +- Ramen API Secret + Here's an example of a Ruby web server rendering an identify call with secure mode: -​ + ```ruby analytics.identify('<%= current_user.id %>', { email : '<%= current_user.email %>', @@ -113,31 +106,26 @@ analytics.identify('<%= current_user.id %>', { } }); ``` -​ + `RAMEN_ORGANIZATION_SECRET_KEY` is found in Ramen's RamenJS documentation. -​ -​ -- - - -​ -​ + ## Troubleshooting -​ -​ + ### I'm seeing a `404` error -​ + Check to make sure your Ramen `ORGANIZATION_ID` is correct. -​ + ### I'm seeing a `401` error -​ + The request you are sending is not valid. Several things can cause this: -​ -+ An invalid `user.email`. It can be blank, but it cannot be an invalid email address. -+ A missing `user.id`. -+ Not including `timestamp` and `auth_hash` once Secure Mode has been enabled. You can see if Secure Mode is enabled by visiting your RamenJS settings page in Ramen. -​ + +- An invalid `user.email`. It can be blank, but it cannot be an invalid email address. +- A missing `user.id`. +- Not including `timestamp` and `auth_hash` once Secure Mode has been enabled. You can see if Secure Mode is enabled by visiting your RamenJS settings page in Ramen. + If the above all look correct, and you are sending `timestamp` and `auth_hash`, check the following: -​ -+ `timestamp` is being dynamically generated (ie. it is not accidentally hard-coded). -+ `auth_hash` is being calculated correctly -​ + +- `timestamp` is being dynamically generated (ie. it is not accidentally hard-coded). +- `auth_hash` is being calculated correctly + If you are still having trouble, you can email [Ramen support](mailto:support@ramen.is). diff --git a/src/connections/destinations/catalog/recombee-ai/index.md b/src/connections/destinations/catalog/recombee-ai/index.md index 14ce02b490..6a3a468dd4 100644 --- a/src/connections/destinations/catalog/recombee-ai/index.md +++ b/src/connections/destinations/catalog/recombee-ai/index.md @@ -18,7 +18,6 @@ This destination is maintained by Recombee. For any issues with the destination, > info "" > The Recombee Destination is currently in beta, which means that the Recombee team is still actively developing the destination. If you have any feedback to help improve the Recombee Destination and its documentation, [contact the Recombee support team](mailto:support@recombee.com). ->>>>>>> Stashed changes Use this Segment destination to send your interaction data, like views, purchases, or plays, to Recombee. diff --git a/src/connections/destinations/catalog/relay/index.md b/src/connections/destinations/catalog/relay/index.md index f39e8a5aa8..201a8b98fe 100644 --- a/src/connections/destinations/catalog/relay/index.md +++ b/src/connections/destinations/catalog/relay/index.md @@ -7,7 +7,6 @@ title: Relay Destination Once the Segment library is integrated with your server, toggle Relay on in your Segment destinations. Relay supports the `identify` and `track` methods. -- - - ## Identify diff --git a/src/connections/destinations/catalog/retina/index.md b/src/connections/destinations/catalog/retina/index.md index 5014127f77..59758bfc31 100644 --- a/src/connections/destinations/catalog/retina/index.md +++ b/src/connections/destinations/catalog/retina/index.md @@ -8,7 +8,7 @@ id: 5f287bfa332cce0b1ed18331 Retina AI maintains this destination. For any issues with the destination, contact the [Retina AI Support Team](mailto:info@retina.ai). -> info " " +> info "" > The Retina AI Destination is in beta, which means that they are still actively developing the destination. To join the beta program, or if you have any feedback to help improve the Retina AI Destination and its documentation, contact the [Retina AI Support Team](mailto:info@retina.ai). diff --git a/src/connections/destinations/catalog/rollbar/index.md b/src/connections/destinations/catalog/rollbar/index.md index a98014ab31..e3b1883908 100644 --- a/src/connections/destinations/catalog/rollbar/index.md +++ b/src/connections/destinations/catalog/rollbar/index.md @@ -20,12 +20,12 @@ This feature makes use of JavaScript Source Maps to translate the minified code 2. Provide your source map. There are two ways you can do this: - a. Automatic download: place a comment like the following at the bottom of your minified JavaScript files: + 1. Automatic download: place a comment like the following at the bottom of your minified JavaScript files: - ``` - //# sourceMappingURL=URL_TO_SOURCE_MAP - ``` + ``` + //# sourceMappingURL=URL_TO_SOURCE_MAP + ``` - b. Upload pre-deploy: at the beginning of your deploy script, upload a source map package using Rollbar's API. + 2. Upload pre-deploy: at the beginning of your deploy script, upload a source map package using Rollbar's API. For more detail on providing your source map, checkout [Rollbar's documentation here](https://rollbar.com/docs/source-maps/#step-2-provide-your-source-map){:target="_blank"}. diff --git a/src/connections/destinations/catalog/route/index.md b/src/connections/destinations/catalog/route/index.md index 1dcf08aaaf..1b0cb84bac 100644 --- a/src/connections/destinations/catalog/route/index.md +++ b/src/connections/destinations/catalog/route/index.md @@ -10,8 +10,6 @@ Once the Segment library is integrated with your server, toggle Route `on` in yo Route supports the `identify` and `track` methods. ---- - ## Identify When you `identify` a contact, we'll pass that contact's information to Route with `email` as Route's Contact ID. The traits recognized as Route's contact profile fields are: diff --git a/src/connections/destinations/catalog/sailthru/index.md b/src/connections/destinations/catalog/sailthru/index.md index 717c8b0629..32500155f2 100644 --- a/src/connections/destinations/catalog/sailthru/index.md +++ b/src/connections/destinations/catalog/sailthru/index.md @@ -18,7 +18,6 @@ The Sailthru server-side destination will allow you to add users, send custom ev - The template passed through as `reminder_template` must match the public name configured in Sailthru's UI. - We recommend appending `traits.email` whenever possible in your `identify` calls. If you send an `identify` call without a `traits.email` and only a `userId`, the profile will be created in Sailthru but you would not be able to find that user using their **User Look Up** feature. -- - - ### Page You must configure a `customerId` in your integration settings in order to use the `page` functionality. This value is only required for `page` calls and can be found in your Sailthru Dashboard under **App Settings** @@ -41,7 +40,6 @@ analytics.page('Page Name', { See our [documentation](/docs/connections/spec/page/#properties) for more info on the `keywords` property. -- - - ### Identify diff --git a/src/connections/destinations/catalog/salesforce-dmp/index.md b/src/connections/destinations/catalog/salesforce-dmp/index.md index 87058e0481..6a846b2e2d 100644 --- a/src/connections/destinations/catalog/salesforce-dmp/index.md +++ b/src/connections/destinations/catalog/salesforce-dmp/index.md @@ -28,17 +28,17 @@ Next, configure the Destination in the Segment web app: ### Setting up a Client-Side Web Implementation -3. Get your **Config ID** from your SFDMP console. Log into the +4. Get your **Config ID** from your SFDMP console. Log into the console and go to **Manage** > **Capture** > **Sites**. If you don't see this option, contact your SFDMP representative. -4. In the **Sites** tab, locate the site you want to use as the SFDMP destination. +5. In the **Sites** tab, locate the site you want to use as the SFDMP destination. If you haven't created any sites yet, click **Create Site** and go through the options to create a new site. ![A screenshot of the Manage tab in Salesforce DMP, with the Sites item selected.](images/salesforce-dmp-setup1.png) -5. In the dropdown, find the site tag for the site you want to use. The string you need is under "Config" and will look something like `r0u08k4tz`. -6. Go back to the Segment App, and navigate to the Salesforce DMP destination you're setting up. Locate the ConfigID setting, and paste the value you found in that field. +6. In the dropdown, find the site tag for the site you want to use. The string you need is under "Config" and will look something like `r0u08k4tz`. +7. Go back to the Segment App, and navigate to the Salesforce DMP destination you're setting up. Locate the ConfigID setting, and paste the value you found in that field. To send client-side events to SFDMP, you must include a SFDMP Config ID and SFDMP Namespace in your Segment settings. Segment's UI enforces inclusion of a @@ -49,14 +49,14 @@ If you don't provide a `namespace` Segment can't pass events downstream to SFDMP ### Setting up for a Server-Side Implementation -6. To set up SFDMP for a server-side connection, enter your SFDMP `Server-side +8. To set up SFDMP for a server-side connection, enter your SFDMP `Server-side Publisher UUID`. To locate this, Segment recommends that you contact your SFDMP representative. Helpful documentation can be found [in the Salesforce Audience Studio Help Center](https://konsole.zendesk.com/hc/en-us/articles/219493027-Mobile-HTTP-API){:target="_blank"}. -7. Once you've retrieved your `Server-side Publisher UUID`, follow the +9. Once you've retrieved your `Server-side Publisher UUID`, follow the instructions in the Segment SFDMP settings to enter your `Pixel.gif Domain`, `Pixel.gif Site` and, optionally, your `Pixel.gif Section` in the correct fields. -8. If you instead want to send your `track` events to SFDMP's +10. If you instead want to send your `track` events to SFDMP's Event.gif endpoint instead of their Pixel.gif endpoint, first disable the `Send Server-Side Track Calls to the Pixel.gif Endpoint` (it defaults to on) setting in the Segment UI. @@ -217,7 +217,8 @@ If you see page attributes automatically appended to outbound Pixel.gif calls and you're not sure where the attributes came from, then you or someone on your team has likely set up page scraping in SFDMP. -Warning: If you decide to rely on SFDMP's page scraping to transmit attributes +> warning "" +> If you decide to rely on SFDMP's page scraping to transmit attributes to SFDMP rather than adding them as properties to Segment events, you won't see these properties in other Segment connections, including in a raw data warehouse. @@ -401,4 +402,4 @@ The value of field `msg.event`. | Value Passed to Segment | Value Sent to SFDMP | |-|-| -| Any String value (for example, 'Account Created') | event_id: <`id mapped in Event ID Map UI setting`> | +| Any String value (for example, 'Account Created') | event_id: `` | diff --git a/src/connections/destinations/catalog/salesforce-marketing-cloud/index.md b/src/connections/destinations/catalog/salesforce-marketing-cloud/index.md index 86687ba425..5105fbaa95 100644 --- a/src/connections/destinations/catalog/salesforce-marketing-cloud/index.md +++ b/src/connections/destinations/catalog/salesforce-marketing-cloud/index.md @@ -11,8 +11,10 @@ versions: Salesforce Marketing Cloud (SFMC) provides digital marketing automation and analytics software and services. Marketers can use this software to create sophisticated multi-channel campaigns using the SFMC [Journey Builder](https://help.salesforce.com/articleView?id=mc_jb_journey_builder.htm&type=5){:target="_blank"}. This is a campaign planning tool that helps you design and automate campaigns that guide customers through their journey with your brand, such as [Weekly Product Summary Emails](https://segment.com/recipes/product-summary-emails-salesforce/){:target="_blank"} that you can enable with Segment. -### SFMC details +## SFMC details +| Feature | Details | +| ------- | ------- | | **Support for Engage** | Yes | | **Rate Limits** | 20 requests per second | | **Identifiers Required** | `userId` or `email` | @@ -33,9 +35,9 @@ Segment sends data to SFMC using [Data Extensions](https://help.salesforce.com/a Before you start working with SFMC, work through the following sections to confirm that the destination will work as you expect, and set up any authentication requirements. -### Confirm that Salesforce Marketing Cloud supports your source type and connection mode - +### Confirm support +Make sure that Salesforce Marketing Cloud supports your source type and connection mode. ### Grant Segment API access to Salesforce Marketing Cloud @@ -98,7 +100,7 @@ You must create a Data Extension in SFMC to store the Identify calls coming from If you send a trait `"nonexistent": "xyz"` with your data, but there's no matching `nonexistent` column in SFMC's table, that trait is ignored. - You do not need to create attributes for _all_ of the traits in an Identify call. If you don't need a specific trait in SFMC, don't create an attribute for it, and Segment ignores the trait when it sends data to SFMC. - All attributes you create in the Data Extension must be in **Title Case**, regardless of the casing used in your Segment Identify calls. When Segment sends Identify calls to SFMC it first transforms the data to use Title Case, but you still need to set the attributes up in SFMC in the correct format. -- Set up a Primary Key in the Identify Data Extension called `**Contact Key**`. Segment uses this to link users to SFMC's built-in Contact Key property. This field is populated with `userId` by default in Identify calls. If no `userId` exists, Segment uses the `email` instead. +- Set up a Primary Key in the Identify Data Extension called **`Contact Key`**. Segment uses this to link users to SFMC's built-in Contact Key property. This field is populated with `userId` by default in Identify calls. If no `userId` exists, Segment uses the `email` instead. - If you want to use this data to send emails or push notifications, check the **Is Sendable** box. (If you need to do this later, the box will be called "Used for Sending".) - If you will be using this data to send emails, set up any **Email** attributes so they are of the "EmailAddress" type. diff --git a/src/connections/destinations/catalog/salesforce/index.md b/src/connections/destinations/catalog/salesforce/index.md index 9e0a49bcdc..410313727a 100644 --- a/src/connections/destinations/catalog/salesforce/index.md +++ b/src/connections/destinations/catalog/salesforce/index.md @@ -11,11 +11,10 @@ private: true > Settings will be migrated automatically, but you must take additional action to ensure the destination is properly enabled.For more information, see [Migrating from Salesforce Classic](/docs/connections/destinations/catalog/actions-salesforce/#migrate-from-salesforce-classic) > > For questions or issues, or to opt out of the automatic upgrade, contact [friends@segment.com](mailto:friends@segment.com). For more information about Salesforce's deprecation, see their [deprecation notice](https://help.salesforce.com/s/articleView?id=000389618&type=1){:target="_blank"} -Segment's Salesforce destination allows you to create and store leads and records for other objects in Salesforce Sales Cloud. - +Segment's Salesforce destination allows you to create and store leads and records for other objects in Salesforce Sales Cloud. -### API Access +## API Access Segment uses the Salesforce SOAP API to connect. This API requires the following credentials of a registered Salesforce user: - email diff --git a/src/connections/destinations/catalog/salesmachine/index.md b/src/connections/destinations/catalog/salesmachine/index.md index 5efd3ee9ee..a47b88e8ce 100644 --- a/src/connections/destinations/catalog/salesmachine/index.md +++ b/src/connections/destinations/catalog/salesmachine/index.md @@ -19,11 +19,11 @@ _You must add `account_uid` in event parameters to automatically link this pagev ## Identify When you `identify` a user, we'll pass that user's information to Salesmachine.io. For a better experience with Salesmachine.io we encourage you to add at least `name` and `email` traits. -_You must add `account_uid` in traits to automatically link this user to a Salesmachine.io account. -_ +_You must add `account_uid` in traits to automatically link this user to a Salesmachine.io account._ + ## Track -When you `track` an event, we will send that event to Salesmachine.io.(include details about how that event is sent). +When you `track` an event, we will send that event to Salesmachine.io. (include details about how that event is sent). _You must add `account_uid` in event parameters to automatically link this event to an account. However, if the contact that performed the event has only one account, Salesmachine.io will automatically link the event to his account._ ## Group diff --git a/src/connections/destinations/catalog/satismeter/index.md b/src/connections/destinations/catalog/satismeter/index.md index 4e00d42fac..a56505fe7e 100644 --- a/src/connections/destinations/catalog/satismeter/index.md +++ b/src/connections/destinations/catalog/satismeter/index.md @@ -68,7 +68,8 @@ We also record the following events - `Answered NPS Survey`: User filled the rating of NPS Survey - `Completed NPS Survey`: User completed the survey (including the follow-up question) -# Troubleshooting +## Troubleshooting + ### The SatisMeter widget does not show up Make sure you are sending an `analytics.identify()` call when the page is loaded. If you are calling this method, make sure SatisMeter survey has a reason to be displayed. The widget will not display unless the customer fits your targeting settings. diff --git a/src/connections/destinations/catalog/scuba-analytics/index.md b/src/connections/destinations/catalog/scuba-analytics/index.md index 44b667d0b1..53a83b0304 100644 --- a/src/connections/destinations/catalog/scuba-analytics/index.md +++ b/src/connections/destinations/catalog/scuba-analytics/index.md @@ -20,11 +20,11 @@ Credentials to access your cloud storage account * For AWS and S3 backed clusters you will need S3 credentials with write access to your bucket * For Azure and Blob Storage backed clusters you will need a Shared Access Signature with write access to your container To begin sending data to Scuba Analytics from the Segment portal select Scuba Analytics as a new destination. -1. In the "API Key" field insert your Blob Shared Access Signature or your S3 credentials. For S3 credentials, comma separate the access key id & the secret access key in the format of "accessKeyId,secretAccessKey" -2. In the "Bucket Container URL" field insert the URL for the cloud storage directory. + 1. In the "API Key" field insert your Blob Shared Access Signature or your S3 credentials. For S3 credentials, comma separate the access key id & the secret access key in the format of "accessKeyId,secretAccessKey" + 2. In the "Bucket Container URL" field insert the URL for the cloud storage directory. * For S3: ``https://{your bucket}.{your region}.amazonaws.com/{your directory}`` * For Azure Blob Storage: ``https://{your storage account name}.blob.core.windows.net/{your container}`` -3. In the "Platform" field insert "AWS" or "Azure" depending on the provider of your cloud storage. + 1. In the "Platform" field insert "AWS" or "Azure" depending on the provider of your cloud storage. ## Methods Supported diff --git a/src/connections/destinations/catalog/selligent-marketing-cloud/index.md b/src/connections/destinations/catalog/selligent-marketing-cloud/index.md index 83debbb250..cfc3f36f6b 100644 --- a/src/connections/destinations/catalog/selligent-marketing-cloud/index.md +++ b/src/connections/destinations/catalog/selligent-marketing-cloud/index.md @@ -31,7 +31,7 @@ You can then proceed to configure your destination. 1. From your Segment UI's Destinations page click on "Add Destination". 2. Search for "*Selligent Marketing Cloud*" within the Destinations Catalog and confirm the Source you'd like to connect to. 3. Enter the "*API Key*" and "*API Secret*" into your Segment Settings UI. -4. *SMC Admin URL* - Copy the link you use to log into the SMC admin should look like https://**{you company}**.slgnt.us +4. *SMC Admin URL* - Copy the link you use to log into the SMC admin should look like `https://{you company}.slgnt.us` ![5](images/5.png) 5. *Organization* - You will find the organization name on the top-right hand corner next to the menu icon. ![6](images/6.png) @@ -91,12 +91,12 @@ An example call can look like: ``` Segment sends Group calls to *Selligent Marketing Cloud* as a `group` event. These calls are used to populate static segments in the *Selligent Marketing Cloud* platform. The static segment must be created in Selligent Marketing Cloud before you can use it. The call should adhere the above example and contain the following elements: -* groupId: The *api_name* of the static segment to populate -* userId: The value on which the matching to populate the segment should happen -* traits: - * matchkey: this is a mandatory trait and should contain the name of the field in the userlist on which the matching should be done - * method: this trait is optional and indicates either a remove call or an add call to the *Selligent Marketing Cloud* segment. The two values possible are REMOVE or ADD but it will default to ADD. So it’s only needed in case of a remove call - * userlist: this is a mandatory trait and should contain the *api_name* of the userlist in *Selligent Marketing Cloud* +* groupId: The *api_name* of the static segment to populate +* userId: The value on which the matching to populate the segment should happen +* traits: + * matchkey: this is a mandatory trait and should contain the name of the field in the userlist on which the matching should be done + * method: this trait is optional and indicates either a remove call or an add call to the *Selligent Marketing Cloud* segment. The two values possible are REMOVE or ADD but it will default to ADD. So it’s only needed in case of a remove call + * userlist: this is a mandatory trait and should contain the *api_name* of the userlist in *Selligent Marketing Cloud* ## Alias diff --git a/src/connections/destinations/catalog/selligent/index.md b/src/connections/destinations/catalog/selligent/index.md index 06e73c299c..598163624f 100644 --- a/src/connections/destinations/catalog/selligent/index.md +++ b/src/connections/destinations/catalog/selligent/index.md @@ -8,103 +8,56 @@ This destination is built and supported by Selligent. If you run into any issues ## Getting Started Once the Segment Connector is integrated with Message Studio, -the Segment API shall support receiving Segment's "Identify" and -"Track" event data. Message Studio translates these events as follows:

+the Segment API shall support receiving Segment's "Identify" and +"Track" event data. Message Studio translates these events as follows: - ->Identify: add records to an Internal Data Source (IDS) - ->Track: add records to an Interaction Extension +- Identify: add records to an Internal Data Source (IDS) +- Track: add records to an Interaction Extension These records can be used to enhance the targeting and -personalization of your email messages within the Message Studio platform.

+personalization of your email messages within the Message Studio platform. ## Identify When you identify a user, we'll pass that user's information to -Message Studio as a record in the configured Internal Data Source.  Since +Message Studio as a record in the configured Internal Data Source. Since the Internal Data Source schema is flexible, each customer's destination with -Segment will require unique mapping of the Internal Data Source fields.  -Customers should contact their Selligent Relationship Manager so we can work +Segment will require unique mapping of the Internal Data Source fields. Customers should contact their Selligent Relationship Manager so we can work with them to configure the mapping to best meet their needs. ### Example Internal Data Source Schema -

_      customer_id -(primary key)

- -

_      email_address -(email)

- -

_      first_name

- -

_      last_name

- -

_      address_street_1

- -

_      address_street_2

- -

_      address_city

- -

_      address_state

- -

_      address_zip

- -

_      country

- +- customer_id (primary key) +- email_address (email) +- first_name +- last_name +- address_street_1 +- address_street_2 +- address_city +- address_state +- address_zip +- country ## Track When you track an event, we pass that event to Message Studio as a record in the configured Interaction Extension. Since the Interaction Extension is flexible, each customer's destination with Segment will require -unique mapping of the Interaction Extension fields.  Customers should +unique mapping of the Interaction Extension fields. Customers should contact their Selligent Relationship Manager so we can work with them to configure the mapping to best meet their needs. ### Example Interaction Extension schema: -

_      event_id -(primary key)

- -

_      customer_id -(recipient key)

- -

_      event_type -(event type)

- -

_      event_timestamp -(event timestamp)

- -

_      channel

- -

_      ip_address

- -

_      plan_name

- -

_      acct_type

- -

 

+- event_id (primary key) +- customer_id (recipient key) +- event_type (event key) +- event_timestamp (event timestamp) +- channel +- ip_address +- plan_name +- acct_type -

If you have any questions, -contact your Selligent Relationship Manager for assistance.

+If you have any questions, contact your Selligent Relationship Manager for assistance. diff --git a/src/connections/destinations/catalog/sherlock/index.md b/src/connections/destinations/catalog/sherlock/index.md index eee50a9015..bbead8a9c4 100644 --- a/src/connections/destinations/catalog/sherlock/index.md +++ b/src/connections/destinations/catalog/sherlock/index.md @@ -5,7 +5,7 @@ id: 5a947eee1ad6310001435883 --- Sherlock is the first engagement scoring application for SaaS businesses who want to truly understand user engagement. Build an engagement algorithm and understand the engagement of your users, accounts and segments. -This integration is maintained by Sherlock. For questions or help with your integration, contact [Sherlock support][support@sherlockscore.com]. +This integration is maintained by Sherlock. For questions or help with your integration, contact [Sherlock support](support@sherlockscore.com). ## Getting Started diff --git a/src/connections/destinations/catalog/smyte/index.md b/src/connections/destinations/catalog/smyte/index.md index 914581fdc9..c54d5603d3 100644 --- a/src/connections/destinations/catalog/smyte/index.md +++ b/src/connections/destinations/catalog/smyte/index.md @@ -4,7 +4,6 @@ title: Smyte Destination This destination is maintained by Smyte. -- - - # Getting Started diff --git a/src/connections/destinations/catalog/stonly/index.md b/src/connections/destinations/catalog/stonly/index.md index 360a4db8e0..4787d59428 100644 --- a/src/connections/destinations/catalog/stonly/index.md +++ b/src/connections/destinations/catalog/stonly/index.md @@ -7,7 +7,7 @@ id: 5f354f1a928763feb8caf724 This destination is maintained by Stonly. For any issues with the destination, [contact their support team](mailto:support@stonly.com). -> "Note:" +> info "" > Stonly Destination is currently in beta, which means that they are still actively developing the destination. To join their beta program, or if you have any feedback to help improve Stonly Destination and its documentation, [contact Stonly support team](mailto:support@stonly.com)! ## Getting Started @@ -61,8 +61,6 @@ Segment sends Track calls to Stonly as a `track` event. If one of your properties is of the date property type, it should be sent as an ISO string. ---- - ## Troubleshooting ### Nested Objects and Arrays diff --git a/src/connections/destinations/catalog/tag-injector/index.md b/src/connections/destinations/catalog/tag-injector/index.md index b5085b13c4..790aba70f6 100644 --- a/src/connections/destinations/catalog/tag-injector/index.md +++ b/src/connections/destinations/catalog/tag-injector/index.md @@ -15,14 +15,14 @@ _**NOTE:** Tag Injector is only available for select customers at this time._ 1. Once you have access, with the link provided confirm the Source you'd like to connect to. 2. You have the following configuration options which will manipulate the page at runtime: - - **URL**: A URL to the JavaScript code to load on the page as the `src` attribute of the `