diff --git a/src/_data/catalog/destination_categories.yml b/src/_data/catalog/destination_categories.yml
index 0f854a01f1..3612d0d943 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 2024-09-03
+# destination categories last updated 2024-09-10
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 410dfea48b..a6084c30df 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 2024-09-03
+# destination data last updated 2024-09-10
items:
- id: 637e8d185e2dec264895ea89
display_name: 1Flow
@@ -22197,7 +22197,7 @@ items:
hidden: false
defaultTrigger: type = "identify"
fields:
- - id: gWMtCPKhYpHNKJ7wmLEZaK
+ - id: c68r6dfc6ZPNJHeiNiyHVr
sortOrder: 0
fieldKey: external_id
label: External User ID
@@ -22211,7 +22211,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: bbSq3bctftu6GWY3mfmU2r
+ - id: fKURnNu38SgU8gixR9eUpf
sortOrder: 1
fieldKey: user_alias
label: User Alias Object
@@ -22225,7 +22225,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: r6U2iEEn27fhpM7ngYmrkz
+ - id: vwpPZhmmLx5phWzaeBwfyy
sortOrder: 2
fieldKey: braze_id
label: Braze User Identifier
@@ -22239,7 +22239,7 @@ items:
choices: null
dynamic: false
allowNull: true
- - id: obUiaKkQQn86g5mdtQniPn
+ - id: pGTdrjZ3xYVcduT4Va3hGR
sortOrder: 3
fieldKey: country
label: Country
@@ -22253,7 +22253,7 @@ items:
choices: null
dynamic: false
allowNull: true
- - id: gUWycRqZ1JtDPrh3dggPFQ
+ - id: qH6nR9GnbwCzREHTBmnXR
sortOrder: 4
fieldKey: current_location
label: Current Location
@@ -22270,7 +22270,7 @@ items:
choices: null
dynamic: false
allowNull: true
- - id: wfYWnjYvQCsrtxssNZHzcN
+ - id: ogBWQ6C1CyDezTLy1QUX3E
sortOrder: 5
fieldKey: date_of_first_session
label: Date of First Session
@@ -22282,7 +22282,7 @@ items:
choices: null
dynamic: false
allowNull: true
- - id: q2i93JgYZotT8h1ZPDmjsP
+ - id: 3AJJbHH15MkXy1oh9xESg2
sortOrder: 6
fieldKey: date_of_last_session
label: Date of Last Session
@@ -22294,7 +22294,7 @@ items:
choices: null
dynamic: false
allowNull: true
- - id: Y4bNqN3e8vDoJcYW1eQkt
+ - id: sLVVuTiQQ5QDgDSp3NFwyz
sortOrder: 7
fieldKey: dob
label: Date of Birth
@@ -22306,7 +22306,7 @@ items:
choices: null
dynamic: false
allowNull: true
- - id: ei96vhiyv3H58PnpVQKEfL
+ - id: g2Nh1ah75L3HZnCRnn7Lc8
sortOrder: 8
fieldKey: email
label: Email
@@ -22320,7 +22320,7 @@ items:
choices: null
dynamic: false
allowNull: true
- - id: 8G8NbyDJ5LswGkrXVTZYgE
+ - id: ahHthFUavS2xRcUFdnioes
sortOrder: 9
fieldKey: email_subscribe
label: Email Subscribe
@@ -22335,7 +22335,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 3EvkDQzEKHqdLHFM3G5u7s
+ - id: tURrQk9HdpgHHvHYobisbS
sortOrder: 10
fieldKey: email_open_tracking_disabled
label: Email Open Tracking Disabled
@@ -22349,7 +22349,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: v4oV9P7We4smsxwzbwHGBr
+ - id: tpwfKprUuQCrWuyDWewBtd
sortOrder: 11
fieldKey: email_click_tracking_disabled
label: Email Click Tracking Disabled
@@ -22363,7 +22363,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 2MNkda9rLBLjFSeo2KXFYC
+ - id: bso8R2TCbLH8tMSL1fx6nB
sortOrder: 12
fieldKey: facebook
label: Facebook Attribution Data
@@ -22377,7 +22377,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 5g6NuZN8AkX5c3rhtKn22F
+ - id: 7A7nUuvNHqfHg88Lx2Jkgm
sortOrder: 13
fieldKey: first_name
label: First Name
@@ -22391,7 +22391,7 @@ items:
choices: null
dynamic: false
allowNull: true
- - id: fnPhQXde1UpLcvr8fSKpn6
+ - id: npGJZbNJT7QSfxdy417aRK
sortOrder: 14
fieldKey: gender
label: Gender
@@ -22407,7 +22407,7 @@ items:
choices: null
dynamic: false
allowNull: true
- - id: cV4KkBQ1bGLfaoNQaXJUwn
+ - id: nx35oDUXdGUTG93xk7hjHD
sortOrder: 15
fieldKey: home_city
label: Home City
@@ -22421,7 +22421,7 @@ items:
choices: null
dynamic: false
allowNull: true
- - id: 5nVWv1MPWfEA9s3j8UsL2c
+ - id: kLH2kdAiHKuo5YYAaK5qNc
sortOrder: 16
fieldKey: image_url
label: Image URL
@@ -22435,7 +22435,7 @@ items:
choices: null
dynamic: false
allowNull: true
- - id: dQpQDs3vrfV8DofBqgQfLX
+ - id: aeZ6wvrKgGiaYkKBzuj2Ho
sortOrder: 17
fieldKey: language
label: Language
@@ -22447,7 +22447,7 @@ items:
choices: null
dynamic: false
allowNull: true
- - id: 56RfxX2XuGMrZPLHKoGZ4e
+ - id: 2nmtMEFMyvxiPRLndcZc21
sortOrder: 18
fieldKey: last_name
label: Last Name
@@ -22461,7 +22461,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: p6RpzcSiBBicUE3KXFUouY
+ - id: fJZ6nSBmsnA8y3vc4bwZA4
sortOrder: 19
fieldKey: marked_email_as_spam_at
label: Marked Email as Spam At
@@ -22473,7 +22473,7 @@ items:
choices: null
dynamic: false
allowNull: true
- - id: b67f8epgxQpMPr5o9wE1DL
+ - id: nXV5hq6G4ZvAenQy1o7URn
sortOrder: 20
fieldKey: phone
label: Phone Number
@@ -22487,7 +22487,7 @@ items:
choices: null
dynamic: false
allowNull: true
- - id: dD9u5hadnL7ELQq5vPAFHD
+ - id: 6FfgrJDX9ot7zUFsG1rcYd
sortOrder: 21
fieldKey: push_subscribe
label: Push Subscribe
@@ -22502,7 +22502,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 97cEbQWxeUTsQ9GqbvCg8e
+ - id: 882YgJxE7fxRMZ8HYqJaTz
sortOrder: 22
fieldKey: push_tokens
label: Push Tokens
@@ -22519,7 +22519,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: usT8yd63GijUWBF2enb5gc
+ - id: 91FWcoYetBDAL7R2HxzCuZ
sortOrder: 23
fieldKey: time_zone
label: Time zone
@@ -22534,7 +22534,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: x7UPcubwZ6xVTCs2DBJCwc
+ - id: 8Y17J6jSvqg5BMFjmxqCFg
sortOrder: 24
fieldKey: twitter
label: Twitter Attribution Data
@@ -22549,7 +22549,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: jscpiTqc6Lr58dmsUzySjJ
+ - id: b19KhigjWCj5fAe8oFzMW3
sortOrder: 25
fieldKey: custom_attributes
label: Custom Attributes
@@ -22563,7 +22563,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: txy4Rp4GsWJ5rFDime2XaN
+ - id: tT31tvyX7VjgvAKUMX8Xd4
sortOrder: 26
fieldKey: _update_existing_only
label: Update Existing Only
@@ -22578,7 +22578,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: nHLUzQSTkwU4vZq9Q4Jo5q
+ - id: e3YvPty7HhLAf7wS36wHCg
sortOrder: 27
fieldKey: enable_batching
label: Batch Data to Braze
@@ -22601,7 +22601,7 @@ items:
hidden: false
defaultTrigger: type = "track" and event != "Order Completed"
fields:
- - id: QGnVX7kx7Nfp5LFaFwwv9
+ - id: 88t7JHp8xzn1knxdG6EfzW
sortOrder: 0
fieldKey: external_id
label: External User ID
@@ -22615,7 +22615,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: pt2WddyycYYjo5tE681ocu
+ - id: 3cruKrD8XZ1gLLf6Y1jLBV
sortOrder: 1
fieldKey: user_alias
label: User Alias Object
@@ -22629,7 +22629,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: jsdzB5TpfKhGSsq9LqqqVz
+ - id: gsq54Q9QadBHv1dywo9NXk
sortOrder: 2
fieldKey: email
label: Email
@@ -22643,7 +22643,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: tRtLCsrfSrwAjAVvyxnk2S
+ - id: ocn55mTqi2SVE7ZSVvbaFT
sortOrder: 3
fieldKey: braze_id
label: Braze User Identifier
@@ -22657,7 +22657,7 @@ items:
choices: null
dynamic: false
allowNull: true
- - id: 2arzyfMQtVWTRMSDJviVyy
+ - id: ufsfb2PV7PGmqkKwtMefm
sortOrder: 4
fieldKey: name
label: Event Name
@@ -22671,7 +22671,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: e23vNx95rokPN3jCt847tv
+ - id: 6EHcmqyA1uT4RXrpwyMCmh
sortOrder: 5
fieldKey: time
label: Time
@@ -22685,7 +22685,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 4M3kZ3KcFZWY2Ne9x3yoVJ
+ - id: nYLAn1vLtDGzzgSjyRLJVE
sortOrder: 6
fieldKey: properties
label: Event Properties
@@ -22699,7 +22699,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: vq8Yf8P2yqAY1Nit1AhJEb
+ - id: nyNoXt2pGUEb1125doeiaQ
sortOrder: 7
fieldKey: _update_existing_only
label: Update Existing Only
@@ -22714,7 +22714,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: QP24JeQgDprDXU9GphnmJ
+ - id: x2N1T5D1nA5mQQ2Ngy9H1V
sortOrder: 8
fieldKey: enable_batching
label: Batch Data to Braze
@@ -22737,7 +22737,7 @@ items:
hidden: false
defaultTrigger: event = "Order Completed"
fields:
- - id: aFWYUFQYuiyZfuhZPKjNrd
+ - id: n6A5PUh1u3LKCwWA3Sdx7J
sortOrder: 0
fieldKey: external_id
label: External User ID
@@ -22751,7 +22751,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 8FTrjR5mp372hyLhhhUHsu
+ - id: 57ASYgk71v8otsT9uBMGG4
sortOrder: 1
fieldKey: user_alias
label: User Alias Object
@@ -22765,7 +22765,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: igcQTZXq7sakXHbQ8NqHXA
+ - id: kFdWrRySSxJyXCponB2uQN
sortOrder: 2
fieldKey: email
label: Email
@@ -22779,7 +22779,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 6qgSP8rBtMo26Y84Y5LoDx
+ - id: rDvUnx9EUNkPKhxvmizvwD
sortOrder: 3
fieldKey: braze_id
label: Braze User Identifier
@@ -22793,7 +22793,7 @@ items:
choices: null
dynamic: false
allowNull: true
- - id: 5FUN94gAo5y5Z7xxZTKHu2
+ - id: wqr9BwMtUVjCjVuB3WA9R5
sortOrder: 4
fieldKey: time
label: Time
@@ -22807,7 +22807,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 9aU9uoTFaqZ5rCUN57nxJW
+ - id: wr1aYATksP8E3ezGBpgNrp
sortOrder: 5
fieldKey: products
label: Products
@@ -22821,7 +22821,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 3MWvbUUnYXcY7CnZPtGZTT
+ - id: x2VNichaGnW9AaXYugEe5B
sortOrder: 6
fieldKey: properties
label: Event Properties
@@ -22835,7 +22835,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 8AvoVcGkGkC2KyH73SB8Uj
+ - id: bLeP5MW1X3urkYkcqso9EE
sortOrder: 7
fieldKey: _update_existing_only
label: Update Existing Only
@@ -22850,7 +22850,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: cRMhAwAMTvNP7KhSwEpBZy
+ - id: mxvx3suNxRtLQZX2WK2eGW
sortOrder: 8
fieldKey: enable_batching
label: Batch Data to Braze
@@ -22887,7 +22887,7 @@ items:
hidden: false
defaultTrigger: null
fields:
- - id: ruxjvBv6sWC9MDRhdSc3U5
+ - id: 6y9XKEcaxEDQ6zjJ2MTcrt
sortOrder: 0
fieldKey: external_id
label: External ID
@@ -22899,7 +22899,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: sHNBiHcBNYo3eFohDgefXE
+ - id: 2KqcAShbpZFftvnhZ37Gmw
sortOrder: 1
fieldKey: user_alias
label: User Alias Object
@@ -22913,7 +22913,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: dtgLMEDREznCWRAopqFSRj
+ - id: q7LXdRanaLjsn7TUDhdE82
sortOrder: 2
fieldKey: merge_behavior
label: Merge Behavior
@@ -22942,7 +22942,7 @@ items:
hidden: false
defaultTrigger: event = "Create Alias"
fields:
- - id: 5k2aGQuSGhu5YLBhcjLJBY
+ - id: dGTtATiUdZKQeeWTikfgAQ
sortOrder: 0
fieldKey: external_id
label: External ID
@@ -22954,7 +22954,7 @@ items:
choices: null
dynamic: false
allowNull: true
- - id: fAcRv5C6rQfKsnHq6jDkDK
+ - id: mV2Hw9K2eJJZbiFQ5igZqy
sortOrder: 1
fieldKey: alias_name
label: Alias Name
@@ -22966,7 +22966,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: v1d3XbsEoF5xpaE8Y3s6Uz
+ - id: uCYBMxLv8SN1gUhoeKqjsX
sortOrder: 2
fieldKey: alias_label
label: Alias Label
@@ -22979,6 +22979,25 @@ items:
dynamic: false
allowNull: false
presets:
+ - actionId: vE7Gf9yobj2gTuMBhwmg7g
+ name: Order Completed Calls
+ fields:
+ external_id:
+ '@path': $.userId
+ email:
+ '@path': $.traits.email
+ braze_id:
+ '@path': $.properties.braze_id
+ time:
+ '@path': $.receivedAt
+ products:
+ '@path': $.properties.products
+ properties:
+ '@path': $.properties
+ _update_existing_only: false
+ enable_batching: true
+ batch_size: 75
+ trigger: event = "Order Completed"
- actionId: 2P24zUSAL8BUpyGYNGmD7M
name: Identify Calls
fields:
@@ -23032,25 +23051,6 @@ items:
enable_batching: true
batch_size: 75
trigger: type = "track" and event != "Order Completed"
- - actionId: vE7Gf9yobj2gTuMBhwmg7g
- name: Order Completed Calls
- fields:
- external_id:
- '@path': $.userId
- email:
- '@path': $.traits.email
- braze_id:
- '@path': $.properties.braze_id
- time:
- '@path': $.receivedAt
- products:
- '@path': $.properties.products
- properties:
- '@path': $.properties
- _update_existing_only: false
- enable_batching: true
- batch_size: 75
- trigger: event = "Order Completed"
partnerOwned: false
- id: 63872c01c0c112b9b4d75412
display_name: Braze Cohorts
@@ -24077,231 +24077,6 @@ items:
actions: []
presets: []
partnerOwned: true
-- id: 656dc9330d1863a8870bacd1
- display_name: Bucket Web (Actions)
- name: Bucket Web (Actions)
- slug: bucket-web
- hidden: false
- endpoints:
- - US
- regions:
- - us-west-2
- - eu-west-1
- url: connections/destinations/catalog/bucket-web
- previous_names:
- - Bucket Web (Actions)
- website: https://bucket.co
- status: PUBLIC
- categories:
- - Analytics
- logo:
- url: https://cdn-devcenter.segment.com/454148e9-b05e-4b0e-b153-5bad605bf109.svg
- mark:
- url: https://cdn-devcenter.segment.com/bcafc19d-4505-4c3c-8823-078fc383a990.svg
- methods:
- track: true
- identify: true
- group: true
- alias: true
- screen: false
- page: true
- platforms:
- browser: true
- mobile: false
- server: false
- warehouse: false
- cloudAppObject: false
- components: []
- browserUnbundlingSupported: false
- browserUnbundlingPublic: false
- replay: false
- connection_modes:
- device:
- web: false
- mobile: false
- server: false
- cloud:
- web: true
- mobile: false
- server: false
- settings:
- - name: trackingKey
- type: string
- defaultValue: ''
- description: >-
- The publishable key for your Bucket environment, found on the tracking
- page on app.bucket.co.
- required: true
- label: Publishable Key
- actions:
- - id: 9RtXauSPeppnNv9S8CwpqZ
- name: Track Event
- slug: trackEvent
- description: Map a Segment track() event to Bucket
- platform: WEB
- hidden: false
- defaultTrigger: type = "track"
- fields:
- - id: jkHUB493nMGLEMsSKTRKrr
- sortOrder: 0
- fieldKey: name
- label: Event name
- type: STRING
- description: The event name
- placeholder: ''
- defaultValue:
- '@path': $.event
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: gfrsr7oemcWzNnKpDgvFkx
- sortOrder: 1
- fieldKey: userId
- label: User ID
- type: STRING
- description: Unique identifier for the user
- placeholder: ''
- defaultValue:
- '@path': $.userId
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: dVbqiQT1nQW4q4n2fvec3y
- sortOrder: 2
- fieldKey: properties
- label: Event Properties
- type: OBJECT
- description: Object containing the properties of the event
- placeholder: ''
- defaultValue:
- '@path': $.properties
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: hvgMsbTryH7WBktAmpmKBE
- name: Identify Company
- slug: group
- description: Creates or updates a Company in Bucket and associates the user with it
- platform: WEB
- hidden: false
- defaultTrigger: type = "group"
- fields:
- - id: ojLRp8PoTtT8XFXrt1HyXR
- sortOrder: 0
- fieldKey: groupId
- label: Company ID
- type: STRING
- description: Unique identifier for the company
- placeholder: ''
- defaultValue:
- '@path': $.groupId
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 7LZxof2kdkTPkuPGe6BuAs
- sortOrder: 1
- fieldKey: userId
- label: User ID
- type: STRING
- description: Unique identifier for the user
- placeholder: ''
- defaultValue:
- '@path': $.userId
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: wwpYyjcfwiN6fqF2bidMjW
- sortOrder: 2
- fieldKey: traits
- label: Company Attributes
- type: OBJECT
- description: Additional information to associate with the Company in Bucket
- placeholder: ''
- defaultValue:
- '@path': $.traits
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: i1XWim52toRNFZBohWgJKv
- name: Identify User
- slug: identifyUser
- description: >-
- Creates or updates a user profile in Bucket. Also initializes Live
- Satisfaction
- platform: WEB
- hidden: false
- defaultTrigger: type = "identify"
- fields:
- - id: 5XjjX5XvkU6nCMPnfR3jGw
- sortOrder: 0
- fieldKey: userId
- label: User ID
- type: STRING
- description: Unique identifier for the User
- placeholder: ''
- defaultValue:
- '@path': $.userId
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 8dztrcyH9JALg44wqScdNS
- sortOrder: 1
- fieldKey: traits
- label: User Attributes
- type: OBJECT
- description: Additional information to associate with the User in Bucket
- placeholder: ''
- defaultValue:
- '@path': $.traits
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- presets:
- - actionId: hvgMsbTryH7WBktAmpmKBE
- name: Group
- fields:
- groupId:
- '@path': $.groupId
- userId:
- '@path': $.userId
- traits:
- '@path': $.traits
- trigger: type = "group"
- - actionId: 9RtXauSPeppnNv9S8CwpqZ
- name: Track Event
- fields:
- name:
- '@path': $.event
- userId:
- '@path': $.userId
- properties:
- '@path': $.properties
- trigger: type = "track"
- - actionId: i1XWim52toRNFZBohWgJKv
- name: Identify User
- fields:
- userId:
- '@path': $.userId
- traits:
- '@path': $.traits
- trigger: type = "identify"
- partnerOwned: true
- id: 54521fd525e721e32a72ee99
display_name: BugHerd
name: BugHerd
@@ -34784,7 +34559,7 @@ items:
hidden: false
defaultTrigger: null
fields:
- - id: pivmjBhLaQ2TuN5f3vmKAy
+ - id: 73tkjvniKz8nvxv7oVVVzg
sortOrder: 0
fieldKey: action_source
label: Action Source
@@ -34816,7 +34591,7 @@ items:
value: other
dynamic: false
allowNull: false
- - id: xttPEaUU4E5bkHsHTLW1Uw
+ - id: gh4nYjVrVqch5ejEt7m9Di
sortOrder: 1
fieldKey: event_name
label: Event Name
@@ -34835,7 +34610,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 4g6C5JzQDzi347kbZH2ffj
+ - id: gSJ6tVVxWrsrSfinXshiTG
sortOrder: 2
fieldKey: event_time
label: Event Time
@@ -34851,7 +34626,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: nFGxUzySVnT7Xq1u34ckAs
+ - id: cHVDzHsAFZux9jTbh8Vqaq
sortOrder: 3
fieldKey: user_data
label: User Data
@@ -34901,7 +34676,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 5kST3PEjcUmP3KFp8y7dHq
+ - id: jgNXmCrzxEzjhAbQ84dssm
sortOrder: 4
fieldKey: app_data_field
label: App Events Fields
@@ -34943,7 +34718,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 4KMmGSf2iZSqmdGEZNvHgK
+ - id: bMM5dDgEHEBJzHtPPGoNsj
sortOrder: 5
fieldKey: custom_data
label: Custom Data
@@ -34959,7 +34734,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 4GHDdSXGsaKudAyy9p2DBo
+ - id: 71aguiU9tyNdFj57HRrc4x
sortOrder: 6
fieldKey: event_id
label: Event ID
@@ -34975,7 +34750,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: o7Pb5FWZyZhAKz2KEufb5g
+ - id: eTQrXbDaU1xsUanhRpKSES
sortOrder: 7
fieldKey: event_source_url
label: Event Source URL
@@ -34992,7 +34767,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 4x5DZ8YykzuPiptLgYm8Wa
+ - id: qP3EK1dfLYiXCPLbtEw3XG
sortOrder: 8
fieldKey: data_processing_options
label: Data Processing Options
@@ -35009,7 +34784,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: odhTuWE7bYf3MKkMmz4bY2
+ - id: xdL6wyChgYyBsfBPAKxUiR
sortOrder: 9
fieldKey: data_processing_options_country
label: Data Processing Country
@@ -35030,7 +34805,7 @@ items:
value: 1
dynamic: false
allowNull: false
- - id: nMyWMm9qJ3KeC6jaY9kBhw
+ - id: gFtacEEZSfbj5Yc2uc489N
sortOrder: 10
fieldKey: data_processing_options_state
label: Data Processing State
@@ -35063,7 +34838,2065 @@ items:
hidden: false
defaultTrigger: type = "track" and event = "Order Completed"
fields:
- - id: eT3S2hHz9VEiqxApVhehQ6
+ - id: xfBWg1nd1sLqgpTDWVhkcA
+ sortOrder: 0
+ fieldKey: action_source
+ label: Action Source
+ type: STRING
+ description: >-
+ This field allows you to specify where your conversions occurred. See
+ [Facebook
+ documentation](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event)
+ for supported values.
+ 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: other
+ dynamic: false
+ allowNull: false
+ - id: k5ZnLHHUDEk6mXJAUYoL9D
+ sortOrder: 1
+ fieldKey: currency
+ label: Currency
+ type: STRING
+ description: >-
+ The currency for the value specified. Currency must be a valid ISO 4217
+ three-digit currency code.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.currency
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: egVStWCcMfkX4buT4sUdzh
+ sortOrder: 2
+ fieldKey: event_time
+ label: Event Time
+ type: STRING
+ description: >-
+ A Unix timestamp in seconds indicating when the actual event occurred.
+ Facebook will automatically convert ISO 8601 timestamps to Unix.
+ placeholder: ''
+ defaultValue:
+ '@path': $.timestamp
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: W1LWKWwRW7dsa1M5gAivE
+ sortOrder: 3
+ fieldKey: user_data
+ label: User Data
+ type: OBJECT
+ description: >-
+ These parameters are a set of identifiers Facebook can use for targeted
+ attribution. You must provide at least one of the following parameters
+ in your request. More information on recommended User Data parameters in
+ Facebook’s [Best Practices for Conversions
+ API](https://www.facebook.com/business/help/308855623839366).
+ placeholder: ''
+ defaultValue:
+ externalId:
+ '@if':
+ exists:
+ '@path': $.userId
+ then:
+ '@path': $.userId
+ else:
+ '@path': $.anonymousId
+ email:
+ '@path': $.context.traits.email
+ phone:
+ '@path': $.context.traits.phone
+ dateOfBirth:
+ '@path': $.context.traits.birthday
+ lastName:
+ '@path': $.context.traits.lastName
+ firstName:
+ '@path': $.context.traits.firstName
+ city:
+ '@path': $.context.traits.address.city
+ state:
+ '@path': $.context.traits.address.state
+ zip:
+ '@path': $.context.traits.address.postalCode
+ client_ip_address:
+ '@path': $.context.ip
+ client_user_agent:
+ '@path': $.context.userAgent
+ fbc:
+ '@path': $.properties.fbc
+ fbp:
+ '@path': $.properties.fbp
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: nFDXbhk8KwCZhuE9d6gmcu
+ sortOrder: 4
+ fieldKey: app_data_field
+ label: App Events Fields
+ type: OBJECT
+ description: >-
+ These fields support sending app events to Facebook through the
+ Conversions API. For more information about app events support in the
+ Conversions API, see the Facebook docs
+ [here](https://developers.facebook.com/docs/marketing-api/conversions-api/app-events).
+ App events sent through the Conversions API must be associated with a dataset.
+ Instructions for creating a dataset can be found [here](https://www.facebook.com/business/help/750785952855662?id=490360542427371). Once a dataset is created, the dataset ID
+ can be substituted for the pixel ID in the destination settings.
+ placeholder: ''
+ defaultValue:
+ application_tracking_enabled:
+ '@path': $.context.device.adTrackingEnabled
+ packageName:
+ '@path': $.context.app.namespace
+ longVersion:
+ '@path': $.context.app.version
+ osVersion:
+ '@path': $.context.os.version
+ deviceName:
+ '@path': $.context.device.model
+ locale:
+ '@path': $.context.locale
+ carrier:
+ '@path': $.context.network.carrier
+ width:
+ '@path': $.context.screen.width
+ height:
+ '@path': $.context.screen.height
+ density:
+ '@path': $.context.screen.density
+ deviceTimezone:
+ '@path': $.context.timezone
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: a8r84utA7LkEDXXatK2sME
+ sortOrder: 5
+ fieldKey: value
+ label: Value
+ type: NUMBER
+ description: >-
+ A numeric value associated with this event. This could be a monetary
+ value or a value in some other metric.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.revenue
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: A8q9tyTKNR25RfcrD98pg
+ sortOrder: 6
+ fieldKey: content_ids
+ label: Content IDs
+ type: STRING
+ description: The content IDs associated with the event, such as product SKUs.
+ placeholder: ''
+ required: false
+ multiple: true
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: hkeUPe7154h6Jpz9F4VmTZ
+ sortOrder: 7
+ fieldKey: content_name
+ label: Content Name
+ type: STRING
+ description: The name of the page or product associated with the event.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: kgivKNkVXWjoRhzg16Wfev
+ sortOrder: 8
+ fieldKey: content_type
+ label: Content Type
+ type: STRING
+ description: >-
+ The content type should be set to product or product_group. See
+ [Facebook
+ documentation](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/custom-data)
+ for more information.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: eLkHYHAtuiqhxXj9fnopDS
+ sortOrder: 9
+ fieldKey: contents
+ label: Contents
+ type: OBJECT
+ description: >-
+ A list of JSON objects that contain the product IDs associated with the
+ event plus information about the products. ID and quantity are required
+ fields.
+ 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: 4mL8MioG3F8X67GTeGXHUW
+ sortOrder: 10
+ fieldKey: event_id
+ label: Event ID
+ type: STRING
+ description: >-
+ This ID can be any unique string. Event ID is used to deduplicate events
+ sent by both Facebook Pixel and Conversions API.
+ placeholder: ''
+ defaultValue:
+ '@path': $.messageId
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: peptCfsb8pW6AyMwZH38RL
+ sortOrder: 11
+ fieldKey: event_source_url
+ label: Event Source URL
+ type: STRING
+ description: >-
+ The browser URL where the event happened. The URL must begin with
+ http:// or https:// and should match the verified domain. This is
+ required if the action source is "website."
+ placeholder: ''
+ defaultValue:
+ '@path': $.context.page.url
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: efKX2zSckYYNXzzXXApn1d
+ sortOrder: 12
+ fieldKey: num_items
+ label: Number of Items
+ type: INTEGER
+ description: The number of items when checkout was initiated.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: rwHdxxk72r6tYqnXskVBur
+ sortOrder: 13
+ fieldKey: custom_data
+ label: Custom Data
+ type: OBJECT
+ description: >-
+ The custom data object can be used to pass custom properties. See
+ [Facebook
+ documentation](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/custom-data#custom-properties)
+ for more information.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 9UQzwATuAiJuFHTpLdfD9D
+ sortOrder: 14
+ fieldKey: data_processing_options
+ label: Data Processing Options
+ type: BOOLEAN
+ description: >-
+ The Data Processing Options to send to Facebook. If set to true, Segment
+ will send an array to Facebook indicating events should be processed
+ with Limited Data Use (LDU) restrictions. More information can be found
+ in [Facebook’s
+ documentation](https://developers.facebook.com/docs/marketing-apis/data-processing-options).
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: qjWx9dyBVryKUTk1uiCoGf
+ sortOrder: 15
+ fieldKey: data_processing_options_country
+ label: Data Processing Country
+ type: NUMBER
+ description: >-
+ A country that you want to associate to the Data Processing Options.
+ Accepted values are 1, for the United States of America, or 0, to
+ request that Facebook geolocates the event using IP address. This is
+ required if Data Processing Options is set to true. If nothing is
+ provided, Segment will send 0.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices:
+ - label: Use Facebook’s Geolocation Logic
+ value: 0
+ - label: United States of America
+ value: 1
+ dynamic: false
+ allowNull: false
+ - id: 4FLCZA71bfRs7nTuys97xo
+ sortOrder: 16
+ fieldKey: data_processing_options_state
+ label: Data Processing State
+ type: NUMBER
+ description: >-
+ A state that you want to associate to the Data Processing Options.
+ Accepted values are 1000, for California, or 0, to request that Facebook
+ geolocates the event using IP address. This is required if Data
+ Processing Options is set to true. If nothing is provided, Segment will
+ send 0.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices:
+ - label: Use Facebook’s Geolocation Logic
+ value: 0
+ - label: California
+ value: 1000
+ - label: Colorado
+ value: 1001
+ - label: Connecticut
+ value: 1002
+ dynamic: false
+ allowNull: false
+ - id: aUx4xZYhZhM99yNPYmbFtU
+ name: Search
+ slug: search
+ description: Send event when a user searches content or products
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: type = "track" and event = "Products Searched"
+ fields:
+ - id: e7ScRrMfQ9vafi7c8kvhfZ
+ sortOrder: 0
+ fieldKey: action_source
+ label: Action Source
+ type: STRING
+ description: >-
+ This field allows you to specify where your conversions occurred. See
+ [Facebook
+ documentation](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event)
+ for supported values.
+ 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: other
+ dynamic: false
+ allowNull: false
+ - id: iQMzbozCMUNNk25VyCaJqU
+ sortOrder: 1
+ fieldKey: event_time
+ label: Event Time
+ type: STRING
+ description: >-
+ A Unix timestamp in seconds indicating when the actual event occurred.
+ Facebook will automatically convert ISO 8601 timestamps to Unix.
+ placeholder: ''
+ defaultValue:
+ '@path': $.timestamp
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: wB5Wc4JR5n4qZaTZcV7ag4
+ sortOrder: 2
+ fieldKey: user_data
+ label: User Data
+ type: OBJECT
+ description: >-
+ These parameters are a set of identifiers Facebook can use for targeted
+ attribution. You must provide at least one of the following parameters
+ in your request. More information on recommended User Data parameters in
+ Facebook’s [Best Practices for Conversions
+ API](https://www.facebook.com/business/help/308855623839366).
+ placeholder: ''
+ defaultValue:
+ externalId:
+ '@if':
+ exists:
+ '@path': $.userId
+ then:
+ '@path': $.userId
+ else:
+ '@path': $.anonymousId
+ email:
+ '@path': $.context.traits.email
+ phone:
+ '@path': $.context.traits.phone
+ dateOfBirth:
+ '@path': $.context.traits.birthday
+ lastName:
+ '@path': $.context.traits.lastName
+ firstName:
+ '@path': $.context.traits.firstName
+ city:
+ '@path': $.context.traits.address.city
+ state:
+ '@path': $.context.traits.address.state
+ zip:
+ '@path': $.context.traits.address.postalCode
+ client_ip_address:
+ '@path': $.context.ip
+ client_user_agent:
+ '@path': $.context.userAgent
+ fbc:
+ '@path': $.properties.fbc
+ fbp:
+ '@path': $.properties.fbp
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: pRt3sh6v5Hj7MNB8ddWqXp
+ sortOrder: 3
+ fieldKey: app_data_field
+ label: App Events Fields
+ type: OBJECT
+ description: >-
+ These fields support sending app events to Facebook through the
+ Conversions API. For more information about app events support in the
+ Conversions API, see the Facebook docs
+ [here](https://developers.facebook.com/docs/marketing-api/conversions-api/app-events).
+ App events sent through the Conversions API must be associated with a dataset.
+ Instructions for creating a dataset can be found [here](https://www.facebook.com/business/help/750785952855662?id=490360542427371). Once a dataset is created, the dataset ID
+ can be substituted for the pixel ID in the destination settings.
+ placeholder: ''
+ defaultValue:
+ application_tracking_enabled:
+ '@path': $.context.device.adTrackingEnabled
+ packageName:
+ '@path': $.context.app.namespace
+ longVersion:
+ '@path': $.context.app.version
+ osVersion:
+ '@path': $.context.os.version
+ deviceName:
+ '@path': $.context.device.model
+ locale:
+ '@path': $.context.locale
+ carrier:
+ '@path': $.context.network.carrier
+ width:
+ '@path': $.context.screen.width
+ height:
+ '@path': $.context.screen.height
+ density:
+ '@path': $.context.screen.density
+ deviceTimezone:
+ '@path': $.context.timezone
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: tChEfhU5Xs4ncYH481WeUK
+ sortOrder: 4
+ fieldKey: content_category
+ label: Content Category
+ type: STRING
+ description: The category of the content associated with the event.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: nbZbBpwqmWoxksxrpkidaj
+ sortOrder: 5
+ fieldKey: content_ids
+ label: Content IDs
+ type: STRING
+ description: The content IDs associated with the event, such as product SKUs.
+ placeholder: ''
+ required: false
+ multiple: true
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: jyKaDs6J32EscmHT7uyrgF
+ sortOrder: 6
+ fieldKey: contents
+ label: Contents
+ type: OBJECT
+ description: >-
+ A list of JSON objects that contain the product IDs associated with the
+ event plus information about the products. ID and quantity are required
+ fields.
+ placeholder: ''
+ defaultValue:
+ '@arrayPath':
+ - $.properties
+ - id:
+ '@path': $.product_id
+ quantity:
+ '@path': $.quantity
+ item_price:
+ '@path': $.price
+ required: false
+ multiple: true
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: bpRgV842h6DazqE47Xxepc
+ sortOrder: 7
+ fieldKey: currency
+ label: Currency
+ type: STRING
+ description: >-
+ The currency for the value specified. Currency must be a valid ISO 4217
+ three-digit currency code.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.currency
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: cgQxLEETAzinvS1ozdzqjv
+ sortOrder: 8
+ fieldKey: event_id
+ label: Event ID
+ type: STRING
+ description: >-
+ This ID can be any unique string. Event ID is used to deduplicate events
+ sent by both Facebook Pixel and Conversions API.
+ placeholder: ''
+ defaultValue:
+ '@path': $.messageId
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 6fDMSYNQ5ymV9XKqN6KXBc
+ sortOrder: 9
+ fieldKey: event_source_url
+ label: Event Source URL
+ type: STRING
+ description: >-
+ The browser URL where the event happened. The URL must begin with
+ http:// or https:// and should match the verified domain. This is
+ required if the action source is "website."
+ placeholder: ''
+ defaultValue:
+ '@path': $.context.page.url
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 54PmFY6Bwd2FhXx963Xv5J
+ sortOrder: 10
+ fieldKey: search_string
+ label: Search String
+ type: STRING
+ description: A search query made by a user. This must be a string.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.query
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 7QKGVJrktDBzkHtmR6ABc4
+ sortOrder: 11
+ fieldKey: value
+ label: Value
+ type: NUMBER
+ description: >-
+ A numeric value associated with this event. This could be a monetary
+ value or a value in some other metric.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 5h6v16R1sX16V42Yr35wEu
+ sortOrder: 12
+ fieldKey: custom_data
+ label: Custom Data
+ type: OBJECT
+ description: >-
+ The custom data object can be used to pass custom properties. See
+ [Facebook
+ documentation](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/custom-data#custom-properties)
+ for more information.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: fVATXUZc94H57tZcgPf9sZ
+ sortOrder: 13
+ fieldKey: data_processing_options
+ label: Data Processing Options
+ type: BOOLEAN
+ description: >-
+ The Data Processing Options to send to Facebook. If set to true, Segment
+ will send an array to Facebook indicating events should be processed
+ with Limited Data Use (LDU) restrictions. More information can be found
+ in [Facebook’s
+ documentation](https://developers.facebook.com/docs/marketing-apis/data-processing-options).
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: cQsZqtKzraNMhAvAaXoxSs
+ sortOrder: 14
+ fieldKey: data_processing_options_country
+ label: Data Processing Country
+ type: NUMBER
+ description: >-
+ A country that you want to associate to the Data Processing Options.
+ Accepted values are 1, for the United States of America, or 0, to
+ request that Facebook geolocates the event using IP address. This is
+ required if Data Processing Options is set to true. If nothing is
+ provided, Segment will send 0.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices:
+ - label: Use Facebook’s Geolocation Logic
+ value: 0
+ - label: United States of America
+ value: 1
+ dynamic: false
+ allowNull: false
+ - id: nUjXq5DiboGQJABTCZqhEB
+ sortOrder: 15
+ fieldKey: data_processing_options_state
+ label: Data Processing State
+ type: NUMBER
+ description: >-
+ A state that you want to associate to the Data Processing Options.
+ Accepted values are 1000, for California, or 0, to request that Facebook
+ geolocates the event using IP address. This is required if Data
+ Processing Options is set to true. If nothing is provided, Segment will
+ send 0.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices:
+ - label: Use Facebook’s Geolocation Logic
+ value: 0
+ - label: California
+ value: 1000
+ - label: Colorado
+ value: 1001
+ - label: Connecticut
+ value: 1002
+ dynamic: false
+ allowNull: false
+ - id: cKRefik3FJxeKpj45W5WMo
+ name: Page View
+ slug: pageView
+ description: Send a page view event when a user lands on a page
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: type = "page"
+ fields:
+ - id: ueqaWymu9tf1VtN3KZBi3X
+ sortOrder: 0
+ fieldKey: action_source
+ label: Action Source
+ type: STRING
+ description: >-
+ This field allows you to specify where your conversions occurred. See
+ [Facebook
+ documentation](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event)
+ for supported values.
+ 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: other
+ dynamic: false
+ allowNull: false
+ - id: 7ertsPy1ASNB4egnzvwoxR
+ sortOrder: 1
+ fieldKey: event_time
+ label: Event Time
+ type: STRING
+ description: >-
+ A Unix timestamp in seconds indicating when the actual event occurred.
+ Facebook will automatically convert ISO 8601 timestamps to Unix.
+ placeholder: ''
+ defaultValue:
+ '@path': $.timestamp
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 3jGFPwUGT9guYJ1PcGAmUx
+ sortOrder: 2
+ fieldKey: user_data
+ label: User Data
+ type: OBJECT
+ description: >-
+ These parameters are a set of identifiers Facebook can use for targeted
+ attribution. You must provide at least one of the following parameters
+ in your request. More information on recommended User Data parameters in
+ Facebook’s [Best Practices for Conversions
+ API](https://www.facebook.com/business/help/308855623839366).
+ placeholder: ''
+ defaultValue:
+ externalId:
+ '@if':
+ exists:
+ '@path': $.userId
+ then:
+ '@path': $.userId
+ else:
+ '@path': $.anonymousId
+ email:
+ '@path': $.context.traits.email
+ phone:
+ '@path': $.context.traits.phone
+ dateOfBirth:
+ '@path': $.context.traits.birthday
+ lastName:
+ '@path': $.context.traits.lastName
+ firstName:
+ '@path': $.context.traits.firstName
+ city:
+ '@path': $.context.traits.address.city
+ state:
+ '@path': $.context.traits.address.state
+ zip:
+ '@path': $.context.traits.address.postalCode
+ client_ip_address:
+ '@path': $.context.ip
+ client_user_agent:
+ '@path': $.context.userAgent
+ fbc:
+ '@path': $.properties.fbc
+ fbp:
+ '@path': $.properties.fbp
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: a51JGJKcwg2MebGUr6Ep7P
+ sortOrder: 3
+ fieldKey: app_data_field
+ label: App Events Fields
+ type: OBJECT
+ description: >-
+ These fields support sending app events to Facebook through the
+ Conversions API. For more information about app events support in the
+ Conversions API, see the Facebook docs
+ [here](https://developers.facebook.com/docs/marketing-api/conversions-api/app-events).
+ App events sent through the Conversions API must be associated with a dataset.
+ Instructions for creating a dataset can be found [here](https://www.facebook.com/business/help/750785952855662?id=490360542427371). Once a dataset is created, the dataset ID
+ can be substituted for the pixel ID in the destination settings.
+ placeholder: ''
+ defaultValue:
+ application_tracking_enabled:
+ '@path': $.context.device.adTrackingEnabled
+ packageName:
+ '@path': $.context.app.namespace
+ longVersion:
+ '@path': $.context.app.version
+ osVersion:
+ '@path': $.context.os.version
+ deviceName:
+ '@path': $.context.device.model
+ locale:
+ '@path': $.context.locale
+ carrier:
+ '@path': $.context.network.carrier
+ width:
+ '@path': $.context.screen.width
+ height:
+ '@path': $.context.screen.height
+ density:
+ '@path': $.context.screen.density
+ deviceTimezone:
+ '@path': $.context.timezone
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: iujuf2xc7o9CpR9UTZ7LDW
+ sortOrder: 4
+ fieldKey: event_id
+ label: Event ID
+ type: STRING
+ description: >-
+ This ID can be any unique string. Event ID is used to deduplicate events
+ sent by both Facebook Pixel and Conversions API.
+ placeholder: ''
+ defaultValue:
+ '@path': $.messageId
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: jFXpReHyTcMWSE4b2EqYwp
+ sortOrder: 5
+ fieldKey: event_source_url
+ label: Event Source URL
+ type: STRING
+ description: >-
+ The browser URL where the event happened. The URL must begin with
+ http:// or https:// and should match the verified domain. This is
+ required if the action source is "website."
+ placeholder: ''
+ defaultValue:
+ '@path': $.context.page.url
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 8Zu4P9xEhvVaGjPnpV2xt1
+ sortOrder: 6
+ fieldKey: custom_data
+ label: Custom Data
+ type: OBJECT
+ description: >-
+ The custom data object can be used to pass custom properties. See
+ [Facebook
+ documentation](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/custom-data#custom-properties)
+ for more information.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: jxir2jGn3NJrsMQLx6h5vd
+ sortOrder: 7
+ fieldKey: data_processing_options
+ label: Data Processing Options
+ type: BOOLEAN
+ description: >-
+ The Data Processing Options to send to Facebook. If set to true, Segment
+ will send an array to Facebook indicating events should be processed
+ with Limited Data Use (LDU) restrictions. More information can be found
+ in [Facebook’s
+ documentation](https://developers.facebook.com/docs/marketing-apis/data-processing-options).
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: ktoizjSaU9rA6zvGirRrMB
+ sortOrder: 8
+ fieldKey: data_processing_options_country
+ label: Data Processing Country
+ type: NUMBER
+ description: >-
+ A country that you want to associate to the Data Processing Options.
+ Accepted values are 1, for the United States of America, or 0, to
+ request that Facebook geolocates the event using IP address. This is
+ required if Data Processing Options is set to true. If nothing is
+ provided, Segment will send 0.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices:
+ - label: Use Facebook’s Geolocation Logic
+ value: 0
+ - label: United States of America
+ value: 1
+ dynamic: false
+ allowNull: false
+ - id: rEhTgXYZTwEfV4AQRTFD6T
+ sortOrder: 9
+ fieldKey: data_processing_options_state
+ label: Data Processing State
+ type: NUMBER
+ description: >-
+ A state that you want to associate to the Data Processing Options.
+ Accepted values are 1000, for California, or 0, to request that Facebook
+ geolocates the event using IP address. This is required if Data
+ Processing Options is set to true. If nothing is provided, Segment will
+ send 0.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices:
+ - label: Use Facebook’s Geolocation Logic
+ value: 0
+ - label: California
+ value: 1000
+ - label: Colorado
+ value: 1001
+ - label: Connecticut
+ value: 1002
+ dynamic: false
+ allowNull: false
+ - id: eKJbw1Nv4iMEG6MLSGykbs
+ name: Initiate Checkout
+ slug: initiateCheckout
+ description: Send event when a user enters the checkout flow
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: type = "track" and event = "Checkout Started"
+ fields:
+ - id: s1LjkkuspY45jCCLRXFcF2
+ sortOrder: 0
+ fieldKey: action_source
+ label: Action Source
+ type: STRING
+ description: >-
+ This field allows you to specify where your conversions occurred. See
+ [Facebook
+ documentation](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event)
+ for supported values.
+ 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: other
+ dynamic: false
+ allowNull: false
+ - id: m3WuMtyFWGyQS7wE6YsnP
+ sortOrder: 1
+ fieldKey: event_time
+ label: Event Time
+ type: STRING
+ description: >-
+ A Unix timestamp in seconds indicating when the actual event occurred.
+ Facebook will automatically convert ISO 8601 timestamps to Unix.
+ placeholder: ''
+ defaultValue:
+ '@path': $.timestamp
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: bgzM9nqe8cixw3wY5gPc7U
+ sortOrder: 2
+ fieldKey: user_data
+ label: User Data
+ type: OBJECT
+ description: >-
+ These parameters are a set of identifiers Facebook can use for targeted
+ attribution. You must provide at least one of the following parameters
+ in your request. More information on recommended User Data parameters in
+ Facebook’s [Best Practices for Conversions
+ API](https://www.facebook.com/business/help/308855623839366).
+ placeholder: ''
+ defaultValue:
+ externalId:
+ '@if':
+ exists:
+ '@path': $.userId
+ then:
+ '@path': $.userId
+ else:
+ '@path': $.anonymousId
+ email:
+ '@path': $.context.traits.email
+ phone:
+ '@path': $.context.traits.phone
+ dateOfBirth:
+ '@path': $.context.traits.birthday
+ lastName:
+ '@path': $.context.traits.lastName
+ firstName:
+ '@path': $.context.traits.firstName
+ city:
+ '@path': $.context.traits.address.city
+ state:
+ '@path': $.context.traits.address.state
+ zip:
+ '@path': $.context.traits.address.postalCode
+ client_ip_address:
+ '@path': $.context.ip
+ client_user_agent:
+ '@path': $.context.userAgent
+ fbc:
+ '@path': $.properties.fbc
+ fbp:
+ '@path': $.properties.fbp
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: uvXyPe84LMZ9UxNmYX3M52
+ sortOrder: 3
+ fieldKey: app_data_field
+ label: App Events Fields
+ type: OBJECT
+ description: >-
+ These fields support sending app events to Facebook through the
+ Conversions API. For more information about app events support in the
+ Conversions API, see the Facebook docs
+ [here](https://developers.facebook.com/docs/marketing-api/conversions-api/app-events).
+ App events sent through the Conversions API must be associated with a dataset.
+ Instructions for creating a dataset can be found [here](https://www.facebook.com/business/help/750785952855662?id=490360542427371). Once a dataset is created, the dataset ID
+ can be substituted for the pixel ID in the destination settings.
+ placeholder: ''
+ defaultValue:
+ application_tracking_enabled:
+ '@path': $.context.device.adTrackingEnabled
+ packageName:
+ '@path': $.context.app.namespace
+ longVersion:
+ '@path': $.context.app.version
+ osVersion:
+ '@path': $.context.os.version
+ deviceName:
+ '@path': $.context.device.model
+ locale:
+ '@path': $.context.locale
+ carrier:
+ '@path': $.context.network.carrier
+ width:
+ '@path': $.context.screen.width
+ height:
+ '@path': $.context.screen.height
+ density:
+ '@path': $.context.screen.density
+ deviceTimezone:
+ '@path': $.context.timezone
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: vs5BKuBJpT6YBzs5wbFUrJ
+ sortOrder: 4
+ fieldKey: content_category
+ label: Content Category
+ type: STRING
+ description: The category of the content associated with the event.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 6h2QnAyW3BPiHvbZbjpQbu
+ sortOrder: 5
+ fieldKey: content_ids
+ label: Content IDs
+ type: STRING
+ description: The content IDs associated with the event, such as product SKUs.
+ placeholder: ''
+ required: false
+ multiple: true
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: ir8NH9cA6baz4s99ewxQcm
+ sortOrder: 6
+ fieldKey: contents
+ label: Contents
+ type: OBJECT
+ description: >-
+ A list of JSON objects that contain the product IDs associated with the
+ event plus information about the products. ID and quantity are required
+ fields.
+ 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: 4PoJNTP1YGQDxMyYPENzdW
+ sortOrder: 7
+ fieldKey: currency
+ label: Currency
+ type: STRING
+ description: >-
+ The currency for the value specified. Currency must be a valid ISO 4217
+ three-digit currency code.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.currency
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: cuZvuEvTTAHXL6EzujPvh4
+ sortOrder: 8
+ fieldKey: event_id
+ label: Event ID
+ type: STRING
+ description: >-
+ This ID can be any unique string. Event ID is used to deduplicate events
+ sent by both Facebook Pixel and Conversions API.
+ placeholder: ''
+ defaultValue:
+ '@path': $.messageId
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 9Psh5ikxvkLRMk6Nm7tUjQ
+ sortOrder: 9
+ fieldKey: event_source_url
+ label: Event Source URL
+ type: STRING
+ description: >-
+ The browser URL where the event happened. The URL must begin with
+ http:// or https:// and should match the verified domain. This is
+ required if the action source is "website."
+ placeholder: ''
+ defaultValue:
+ '@path': $.context.page.url
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 9i334PMM4Kvu26yastTLPx
+ sortOrder: 10
+ fieldKey: num_items
+ label: Number of Items
+ type: INTEGER
+ description: The number of items when checkout was initiated.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 8TCUJyRQSEygpEgf2Axdcy
+ sortOrder: 11
+ fieldKey: value
+ label: Value
+ type: NUMBER
+ description: >-
+ A numeric value associated with this event. This could be a monetary
+ value or a value in some other metric.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.revenue
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: b1rutnp2T5cTS6cQXUNwMD
+ sortOrder: 12
+ fieldKey: custom_data
+ label: Custom Data
+ type: OBJECT
+ description: >-
+ The custom data object can be used to pass custom properties. See
+ [Facebook
+ documentation](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/custom-data#custom-properties)
+ for more information.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: qNB3XxyKWs3AT87173JnMR
+ sortOrder: 13
+ fieldKey: data_processing_options
+ label: Data Processing Options
+ type: BOOLEAN
+ description: >-
+ The Data Processing Options to send to Facebook. If set to true, Segment
+ will send an array to Facebook indicating events should be processed
+ with Limited Data Use (LDU) restrictions. More information can be found
+ in [Facebook’s
+ documentation](https://developers.facebook.com/docs/marketing-apis/data-processing-options).
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: qYXCgQ8cheR9tQfoahzvf3
+ sortOrder: 14
+ fieldKey: data_processing_options_country
+ label: Data Processing Country
+ type: NUMBER
+ description: >-
+ A country that you want to associate to the Data Processing Options.
+ Accepted values are 1, for the United States of America, or 0, to
+ request that Facebook geolocates the event using IP address. This is
+ required if Data Processing Options is set to true. If nothing is
+ provided, Segment will send 0.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices:
+ - label: Use Facebook’s Geolocation Logic
+ value: 0
+ - label: United States of America
+ value: 1
+ dynamic: false
+ allowNull: false
+ - id: 2G1mhsgKiVADpXomNRZZsj
+ sortOrder: 15
+ fieldKey: data_processing_options_state
+ label: Data Processing State
+ type: NUMBER
+ description: >-
+ A state that you want to associate to the Data Processing Options.
+ Accepted values are 1000, for California, or 0, to request that Facebook
+ geolocates the event using IP address. This is required if Data
+ Processing Options is set to true. If nothing is provided, Segment will
+ send 0.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices:
+ - label: Use Facebook’s Geolocation Logic
+ value: 0
+ - label: California
+ value: 1000
+ - label: Colorado
+ value: 1001
+ - label: Connecticut
+ value: 1002
+ dynamic: false
+ allowNull: false
+ - id: hTMHeGeBbD7dwjPCGp3LXE
+ name: View Content
+ slug: viewContent
+ description: Send event when a user views content or a product
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: type = "track" and event = "Product Viewed"
+ fields:
+ - id: ogAhBQ2eaEGsgHkLgbhK4t
+ sortOrder: 0
+ fieldKey: action_source
+ label: Action Source
+ type: STRING
+ description: >-
+ This field allows you to specify where your conversions occurred. See
+ [Facebook
+ documentation](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event)
+ for supported values.
+ 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: other
+ dynamic: false
+ allowNull: false
+ - id: 3k7928HeY3i3j5cxHJSD8M
+ sortOrder: 1
+ fieldKey: event_time
+ label: Event Time
+ type: STRING
+ description: >-
+ A Unix timestamp in seconds indicating when the actual event occurred.
+ Facebook will automatically convert ISO 8601 timestamps to Unix.
+ placeholder: ''
+ defaultValue:
+ '@path': $.timestamp
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 7AcJGmRZcW5MSUfXphJ9qo
+ sortOrder: 2
+ fieldKey: user_data
+ label: User Data
+ type: OBJECT
+ description: >-
+ These parameters are a set of identifiers Facebook can use for targeted
+ attribution. You must provide at least one of the following parameters
+ in your request. More information on recommended User Data parameters in
+ Facebook’s [Best Practices for Conversions
+ API](https://www.facebook.com/business/help/308855623839366).
+ placeholder: ''
+ defaultValue:
+ externalId:
+ '@if':
+ exists:
+ '@path': $.userId
+ then:
+ '@path': $.userId
+ else:
+ '@path': $.anonymousId
+ email:
+ '@path': $.context.traits.email
+ phone:
+ '@path': $.context.traits.phone
+ dateOfBirth:
+ '@path': $.context.traits.birthday
+ lastName:
+ '@path': $.context.traits.lastName
+ firstName:
+ '@path': $.context.traits.firstName
+ city:
+ '@path': $.context.traits.address.city
+ state:
+ '@path': $.context.traits.address.state
+ zip:
+ '@path': $.context.traits.address.postalCode
+ client_ip_address:
+ '@path': $.context.ip
+ client_user_agent:
+ '@path': $.context.userAgent
+ fbc:
+ '@path': $.properties.fbc
+ fbp:
+ '@path': $.properties.fbp
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 95MkBQ31qfr2qo94wJk171
+ sortOrder: 3
+ fieldKey: app_data_field
+ label: App Events Fields
+ type: OBJECT
+ description: >-
+ These fields support sending app events to Facebook through the
+ Conversions API. For more information about app events support in the
+ Conversions API, see the Facebook docs
+ [here](https://developers.facebook.com/docs/marketing-api/conversions-api/app-events).
+ App events sent through the Conversions API must be associated with a dataset.
+ Instructions for creating a dataset can be found [here](https://www.facebook.com/business/help/750785952855662?id=490360542427371). Once a dataset is created, the dataset ID
+ can be substituted for the pixel ID in the destination settings.
+ placeholder: ''
+ defaultValue:
+ application_tracking_enabled:
+ '@path': $.context.device.adTrackingEnabled
+ packageName:
+ '@path': $.context.app.namespace
+ longVersion:
+ '@path': $.context.app.version
+ osVersion:
+ '@path': $.context.os.version
+ deviceName:
+ '@path': $.context.device.model
+ locale:
+ '@path': $.context.locale
+ carrier:
+ '@path': $.context.network.carrier
+ width:
+ '@path': $.context.screen.width
+ height:
+ '@path': $.context.screen.height
+ density:
+ '@path': $.context.screen.density
+ deviceTimezone:
+ '@path': $.context.timezone
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: iUsuQrpek7aSdjN6zErUG2
+ sortOrder: 4
+ fieldKey: content_category
+ label: Content Category
+ type: STRING
+ description: The category of the content associated with the event.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: i3iV6hfHju2Qubhty8j12r
+ sortOrder: 5
+ fieldKey: content_ids
+ label: Content IDs
+ type: STRING
+ description: The content IDs associated with the event, such as product SKUs.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.product_id
+ required: false
+ multiple: true
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: qK8hZXJTDi29h5qHFxWq17
+ sortOrder: 6
+ fieldKey: content_name
+ label: Content Name
+ type: STRING
+ description: The name of the page or product associated with the event.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: dtzXWYjPYNQ1Aq9G7kj3Y5
+ sortOrder: 7
+ fieldKey: content_type
+ label: Content Type
+ type: STRING
+ description: >-
+ The content type should be set to product or product_group. See
+ [Facebook
+ documentation](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/custom-data)
+ for more information.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: qhjVH3SMLYJJVrhkg1gbYC
+ sortOrder: 8
+ fieldKey: contents
+ label: Contents
+ type: OBJECT
+ description: >-
+ A list of JSON objects that contain the product IDs associated with the
+ event plus information about the products. ID and quantity are required
+ fields.
+ placeholder: ''
+ defaultValue:
+ '@arrayPath':
+ - $.properties
+ - id:
+ '@path': $.product_id
+ quantity:
+ '@path': $.quantity
+ item_price:
+ '@path': $.price
+ required: false
+ multiple: true
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 6iayEnqu7EziG87oPHDiE4
+ sortOrder: 9
+ fieldKey: currency
+ label: Currency
+ type: STRING
+ description: >-
+ The currency for the value specified. Currency must be a valid ISO 4217
+ three-digit currency code.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.currency
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: fhv4H5DycgECERyjTvSQas
+ sortOrder: 10
+ fieldKey: event_id
+ label: Event ID
+ type: STRING
+ description: >-
+ This ID can be any unique string. Event ID is used to deduplicate events
+ sent by both Facebook Pixel and Conversions API.
+ placeholder: ''
+ defaultValue:
+ '@path': $.messageId
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: sHDbgCtPc4qyz83NSgq8Pf
+ sortOrder: 11
+ fieldKey: event_source_url
+ label: Event Source URL
+ type: STRING
+ description: >-
+ The browser URL where the event happened. The URL must begin with
+ http:// or https:// and should match the verified domain. This is
+ required if the action source is "website."
+ placeholder: ''
+ defaultValue:
+ '@path': $.context.page.url
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: dbbdMov5rnbSJPExYXLYNB
+ sortOrder: 12
+ fieldKey: value
+ label: Value
+ type: NUMBER
+ description: >-
+ A numeric value associated with this event. This could be a monetary
+ value or a value in some other metric.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.price
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: phEAayodYWjDLC9dQ4EKoW
+ sortOrder: 13
+ fieldKey: custom_data
+ label: Custom Data
+ type: OBJECT
+ description: >-
+ The custom data object can be used to pass custom properties. See
+ [Facebook
+ documentation](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/custom-data#custom-properties)
+ for more information.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: tQEBJPYWwfVXGJDtgcj9i8
+ sortOrder: 14
+ fieldKey: data_processing_options
+ label: Data Processing Options
+ type: BOOLEAN
+ description: >-
+ The Data Processing Options to send to Facebook. If set to true, Segment
+ will send an array to Facebook indicating events should be processed
+ with Limited Data Use (LDU) restrictions. More information can be found
+ in [Facebook’s
+ documentation](https://developers.facebook.com/docs/marketing-apis/data-processing-options).
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: qkpoVTs9YxDLiXAekEbVqF
+ sortOrder: 15
+ fieldKey: data_processing_options_country
+ label: Data Processing Country
+ type: NUMBER
+ description: >-
+ A country that you want to associate to the Data Processing Options.
+ Accepted values are 1, for the United States of America, or 0, to
+ request that Facebook geolocates the event using IP address. This is
+ required if Data Processing Options is set to true. If nothing is
+ provided, Segment will send 0.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices:
+ - label: Use Facebook’s Geolocation Logic
+ value: 0
+ - label: United States of America
+ value: 1
+ dynamic: false
+ allowNull: false
+ - id: xaFWWd4r7sjPCDftSWLsDm
+ sortOrder: 16
+ fieldKey: data_processing_options_state
+ label: Data Processing State
+ type: NUMBER
+ description: >-
+ A state that you want to associate to the Data Processing Options.
+ Accepted values are 1000, for California, or 0, to request that Facebook
+ geolocates the event using IP address. This is required if Data
+ Processing Options is set to true. If nothing is provided, Segment will
+ send 0.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices:
+ - label: Use Facebook’s Geolocation Logic
+ value: 0
+ - label: California
+ value: 1000
+ - label: Colorado
+ value: 1001
+ - label: Connecticut
+ value: 1002
+ dynamic: false
+ allowNull: false
+ - id: ky2wkC8WvTrC8PEZMwwGq5
+ name: Add to Cart
+ slug: addToCart
+ description: Send event when a user adds a product to the shopping cart
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: type = "track" and event = "Product Added"
+ fields:
+ - id: 6Xnxk2nEzGphidqW6j2nCT
+ sortOrder: 0
+ fieldKey: action_source
+ label: Action Source
+ type: STRING
+ description: >-
+ This field allows you to specify where your conversions occurred. See
+ [Facebook
+ documentation](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event)
+ for supported values.
+ 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: other
+ dynamic: false
+ allowNull: false
+ - id: rAi4CgA1QXA6Anfy15rukn
+ sortOrder: 1
+ fieldKey: event_time
+ label: Event Time
+ type: STRING
+ description: >-
+ A Unix timestamp in seconds indicating when the actual event occurred.
+ Facebook will automatically convert ISO 8601 timestamps to Unix.
+ placeholder: ''
+ defaultValue:
+ '@path': $.timestamp
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 6rktwQVEptdd6vJWFwueq1
+ sortOrder: 2
+ fieldKey: user_data
+ label: User Data
+ type: OBJECT
+ description: >-
+ These parameters are a set of identifiers Facebook can use for targeted
+ attribution. You must provide at least one of the following parameters
+ in your request. More information on recommended User Data parameters in
+ Facebook’s [Best Practices for Conversions
+ API](https://www.facebook.com/business/help/308855623839366).
+ placeholder: ''
+ defaultValue:
+ externalId:
+ '@if':
+ exists:
+ '@path': $.userId
+ then:
+ '@path': $.userId
+ else:
+ '@path': $.anonymousId
+ email:
+ '@path': $.context.traits.email
+ phone:
+ '@path': $.context.traits.phone
+ dateOfBirth:
+ '@path': $.context.traits.birthday
+ lastName:
+ '@path': $.context.traits.lastName
+ firstName:
+ '@path': $.context.traits.firstName
+ city:
+ '@path': $.context.traits.address.city
+ state:
+ '@path': $.context.traits.address.state
+ zip:
+ '@path': $.context.traits.address.postalCode
+ client_ip_address:
+ '@path': $.context.ip
+ client_user_agent:
+ '@path': $.context.userAgent
+ fbc:
+ '@path': $.properties.fbc
+ fbp:
+ '@path': $.properties.fbp
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: d5rTaAr2BMFwzteNv1Bx1E
+ sortOrder: 3
+ fieldKey: app_data_field
+ label: App Events Fields
+ type: OBJECT
+ description: >-
+ These fields support sending app events to Facebook through the
+ Conversions API. For more information about app events support in the
+ Conversions API, see the Facebook docs
+ [here](https://developers.facebook.com/docs/marketing-api/conversions-api/app-events).
+ App events sent through the Conversions API must be associated with a dataset.
+ Instructions for creating a dataset can be found [here](https://www.facebook.com/business/help/750785952855662?id=490360542427371). Once a dataset is created, the dataset ID
+ can be substituted for the pixel ID in the destination settings.
+ placeholder: ''
+ defaultValue:
+ application_tracking_enabled:
+ '@path': $.context.device.adTrackingEnabled
+ packageName:
+ '@path': $.context.app.namespace
+ longVersion:
+ '@path': $.context.app.version
+ osVersion:
+ '@path': $.context.os.version
+ deviceName:
+ '@path': $.context.device.model
+ locale:
+ '@path': $.context.locale
+ carrier:
+ '@path': $.context.network.carrier
+ width:
+ '@path': $.context.screen.width
+ height:
+ '@path': $.context.screen.height
+ density:
+ '@path': $.context.screen.density
+ deviceTimezone:
+ '@path': $.context.timezone
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: dWCVrzYjX7TJjqyfmZcmW8
+ sortOrder: 4
+ fieldKey: content_ids
+ label: Content IDs
+ type: STRING
+ description: The content IDs associated with the event, such as product SKUs.
+ placeholder: ''
+ required: false
+ multiple: true
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 3m7QkaWvgiiDmv9hyKYAbF
+ sortOrder: 5
+ fieldKey: content_name
+ label: Content Name
+ type: STRING
+ description: The name of the page or product associated with the event.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: ts5Z7HbNz3woVzWEUUyyCr
+ sortOrder: 6
+ fieldKey: content_type
+ label: Content Type
+ type: STRING
+ description: >-
+ The content type should be set to product or product_group. See
+ [Facebook
+ documentation](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/custom-data)
+ for more information.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: rHcocVLjWDB41bgwAbNcNT
+ sortOrder: 7
+ fieldKey: contents
+ label: Contents
+ type: OBJECT
+ description: >-
+ A list of JSON objects that contain the product IDs associated with the
+ event plus information about the products. ID and quantity are required
+ fields.
+ placeholder: ''
+ defaultValue:
+ '@arrayPath':
+ - $.properties
+ - id:
+ '@path': $.product_id
+ quantity:
+ '@path': $.quantity
+ item_price:
+ '@path': $.price
+ required: false
+ multiple: true
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: g5P6c7YFwqYgaMBvNhkvXT
+ sortOrder: 8
+ fieldKey: currency
+ label: Currency
+ type: STRING
+ description: >-
+ The currency for the value specified. Currency must be a valid ISO 4217
+ three-digit currency code.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.currency
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: ugACFs5b2uU8qcawheZugx
+ sortOrder: 9
+ fieldKey: event_id
+ label: Event ID
+ type: STRING
+ description: >-
+ This ID can be any unique string. Event ID is used to deduplicate events
+ sent by both Facebook Pixel and Conversions API.
+ placeholder: ''
+ defaultValue:
+ '@path': $.messageId
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: cR6ZpXfJpbYpHyFZ68rJDN
+ sortOrder: 10
+ fieldKey: event_source_url
+ label: Event Source URL
+ type: STRING
+ description: >-
+ The browser URL where the event happened. The URL must begin with
+ http:// or https:// and should match the verified domain. This is
+ required if the action source is "website."
+ placeholder: ''
+ defaultValue:
+ '@path': $.context.page.url
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: FxEvca7b4py6WprQd8cmp
+ sortOrder: 11
+ fieldKey: value
+ label: Value
+ type: NUMBER
+ description: >-
+ A numeric value associated with this event. This could be a monetary
+ value or a value in some other metric.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.price
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: m7g8w19fPAssj7BSyHktRt
+ sortOrder: 12
+ fieldKey: custom_data
+ label: Custom Data
+ type: OBJECT
+ description: >-
+ The custom data object can be used to pass custom properties. See
+ [Facebook
+ documentation](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/custom-data#custom-properties)
+ for more information.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: s3tM665YUxVmpaEym4YiLm
+ sortOrder: 13
+ fieldKey: data_processing_options
+ label: Data Processing Options
+ type: BOOLEAN
+ description: >-
+ The Data Processing Options to send to Facebook. If set to true, Segment
+ will send an array to Facebook indicating events should be processed
+ with Limited Data Use (LDU) restrictions. More information can be found
+ in [Facebook’s
+ documentation](https://developers.facebook.com/docs/marketing-apis/data-processing-options).
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 6c9JYGYt6iZfi5N6qZFH6F
+ sortOrder: 14
+ fieldKey: data_processing_options_country
+ label: Data Processing Country
+ type: NUMBER
+ description: >-
+ A country that you want to associate to the Data Processing Options.
+ Accepted values are 1, for the United States of America, or 0, to
+ request that Facebook geolocates the event using IP address. This is
+ required if Data Processing Options is set to true. If nothing is
+ provided, Segment will send 0.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices:
+ - label: Use Facebook’s Geolocation Logic
+ value: 0
+ - label: United States of America
+ value: 1
+ dynamic: false
+ allowNull: false
+ - id: 3RLfaDukomhcpuP4vaTksb
+ sortOrder: 15
+ fieldKey: data_processing_options_state
+ label: Data Processing State
+ type: NUMBER
+ description: >-
+ A state that you want to associate to the Data Processing Options.
+ Accepted values are 1000, for California, or 0, to request that Facebook
+ geolocates the event using IP address. This is required if Data
+ Processing Options is set to true. If nothing is provided, Segment will
+ send 0.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices:
+ - label: Use Facebook’s Geolocation Logic
+ value: 0
+ - label: California
+ value: 1000
+ - label: Colorado
+ value: 1001
+ - label: Connecticut
+ value: 1002
+ dynamic: false
+ allowNull: false
+ - id: WPutGZbpwTiko86RQ3Z4d
+ name: Purchase V2
+ slug: purchase2
+ description: Send event when a user completes a purchase
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: type = "track" and event = "Order Completed"
+ fields:
+ - id: mcoCunPWzMVkzFboS7Hmhb
sortOrder: 0
fieldKey: action_source
label: Action Source
@@ -35095,7 +36928,7 @@ items:
value: other
dynamic: false
allowNull: false
- - id: 9mC2eH7ATt7ZXRKCLpTVe6
+ - id: 8uWMBYBWcFMGhuPjegnXud
sortOrder: 1
fieldKey: currency
label: Currency
@@ -35111,7 +36944,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: ixF4gKQCrJXxQavku3cwdU
+ - id: rrBCuapjh9hsGfDEm3zvns
sortOrder: 2
fieldKey: event_time
label: Event Time
@@ -35127,7 +36960,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: i2uZEZRjQ4pGcjcT72MCc3
+ - id: eA7nnffnn5zRXBMZgVq8s9
sortOrder: 3
fieldKey: user_data
label: User Data
@@ -35177,7 +37010,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: bLFFqtomHPDjz4t72r3RfN
+ - id: 914ZpUcAbQfexWVAJnr224
sortOrder: 4
fieldKey: app_data_field
label: App Events Fields
@@ -35219,7 +37052,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: tSRSuh4LYbLihH6pSf3irf
+ - id: mSehzLjk3BP97EKqgnJXqY
sortOrder: 5
fieldKey: value
label: Value
@@ -35235,7 +37068,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: qksmzETfyeoSSXirFWwt8A
+ - id: dVfPbBW6FZpLvMzaGLLb6J
sortOrder: 6
fieldKey: content_ids
label: Content IDs
@@ -35247,7 +37080,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: rdWgn7xDRsNfgE363vzqhs
+ - id: ih8AHE4o9E832mJNvmsPSc
sortOrder: 7
fieldKey: content_name
label: Content Name
@@ -35259,7 +37092,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: kTWCBZyh8f6Cxq14umCvAU
+ - id: a4xB1Sa71NHaMf6YvfHiLt
sortOrder: 8
fieldKey: content_type
label: Content Type
@@ -35275,7 +37108,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: fdwwGnEK1LvhUXw2aC41QN
+ - id: 9e4myDtiE2rgCeQ5jwqK7N
sortOrder: 9
fieldKey: contents
label: Contents
@@ -35299,7 +37132,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: oduGmno8KjXgBZBmZ8Vjn2
+ - id: moV331Sdeft4tW2GZjAukc
sortOrder: 10
fieldKey: event_id
label: Event ID
@@ -35315,7 +37148,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: pfyZuTm5emfXsrWNkB8TVY
+ - id: 9gtUaRFU2kgpaAtPjhwDVr
sortOrder: 11
fieldKey: event_source_url
label: Event Source URL
@@ -35332,7 +37165,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: fSwKWar36S4yMyetcVntr1
+ - id: 5Qc1giC5xLV9xamdvNF6m6
sortOrder: 12
fieldKey: num_items
label: Number of Items
@@ -35344,7 +37177,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: to9hEWREFzGkH2fgyqG7FL
+ - id: 8iYtiadr9CLE9WNQU7mhyo
sortOrder: 13
fieldKey: custom_data
label: Custom Data
@@ -35360,7 +37193,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 5fga3FopAJUMGvsvpVyKXi
+ - id: pjjgvNspgLw2ipga1wSAMz
sortOrder: 14
fieldKey: data_processing_options
label: Data Processing Options
@@ -35377,7 +37210,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 6gVKNHd7VgNJ8uqDSsPFGL
+ - id: kDjjLxU8CADcQNdgA5r3dZ
sortOrder: 15
fieldKey: data_processing_options_country
label: Data Processing Country
@@ -35398,7 +37231,7 @@ items:
value: 1
dynamic: false
allowNull: false
- - id: jomYA5evCdi9QJGEfJQjt4
+ - id: 5tbQAa2PX367KGxLtrSDk9
sortOrder: 16
fieldKey: data_processing_options_state
label: Data Processing State
@@ -35423,15 +37256,15 @@ items:
value: 1002
dynamic: false
allowNull: false
- - id: aUx4xZYhZhM99yNPYmbFtU
- name: Search
- slug: search
- description: Send event when a user searches content or products
+ - id: e8H2xz2UYypWEXGDmzDZ2y
+ name: Add to Cart V2
+ slug: addToCart2
+ description: Send event when a user adds a product to the shopping cart
platform: CLOUD
hidden: false
- defaultTrigger: type = "track" and event = "Products Searched"
+ defaultTrigger: type = "track" and event = "Product Added"
fields:
- - id: h7mRgmLLN3V8GHBmiqLC7Z
+ - id: vLo1YqMLCaLRr3kdmb1qwv
sortOrder: 0
fieldKey: action_source
label: Action Source
@@ -35463,7 +37296,7 @@ items:
value: other
dynamic: false
allowNull: false
- - id: foSLa6WsmguTA6pEEyK4Gv
+ - id: cEzTiv5EJQFb4zdPDpDWLW
sortOrder: 1
fieldKey: event_time
label: Event Time
@@ -35479,7 +37312,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: aqQ7Nc39ZakHaHC6pkDL6d
+ - id: bMi5yZF6Qu89c5gVcrcKhg
sortOrder: 2
fieldKey: user_data
label: User Data
@@ -35529,7 +37362,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 5YwU164bx3AHtpfTeULWM7
+ - id: vezbJ3zYwggFNGWc2yrKU6
sortOrder: 3
fieldKey: app_data_field
label: App Events Fields
@@ -35571,32 +37404,48 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: uh9gGdzEuTXnrpmeedXepW
+ - id: axhZeyue7TTH1oit3R9S7T
sortOrder: 4
- fieldKey: content_category
- label: Content Category
+ fieldKey: content_ids
+ label: Content IDs
type: STRING
- description: The category of the content associated with the event.
+ description: The content IDs associated with the event, such as product SKUs.
placeholder: ''
required: false
- multiple: false
+ multiple: true
choices: null
dynamic: false
allowNull: false
- - id: qeh9nBSJZ9uXj3iDxYGmVA
+ - id: ngsrnTKYoGWfUdyC3GqXmw
sortOrder: 5
- fieldKey: content_ids
- label: Content IDs
+ fieldKey: content_name
+ label: Content Name
type: STRING
- description: The content IDs associated with the event, such as product SKUs.
+ description: The name of the page or product associated with the event.
placeholder: ''
required: false
- multiple: true
+ multiple: false
choices: null
dynamic: false
allowNull: false
- - id: gjHvne5Un6HRyHcAVWMesg
+ - id: 3CErHwNUVpuyP9tapGP3PJ
sortOrder: 6
+ fieldKey: content_type
+ label: Content Type
+ type: STRING
+ description: >-
+ The content type should be set to product or product_group. See
+ [Facebook
+ documentation](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/custom-data)
+ for more information.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: vFtWRACuY44jCmTafGJ2E5
+ sortOrder: 7
fieldKey: contents
label: Contents
type: OBJECT
@@ -35619,8 +37468,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 7nM8zKTs21om2KpYUofJGx
- sortOrder: 7
+ - id: swnUDbRbUxqiSiEftz97vB
+ sortOrder: 8
fieldKey: currency
label: Currency
type: STRING
@@ -35635,8 +37484,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: mKY7DkAtuHouQwLF8QKeKy
- sortOrder: 8
+ - id: 7PkqC9g93fnQvHuzm2njYs
+ sortOrder: 9
fieldKey: event_id
label: Event ID
type: STRING
@@ -35651,8 +37500,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: hQjXZngJAszSK5MZLbbC3j
- sortOrder: 9
+ - id: 664bHf2EM4fFJsFr15SKVB
+ sortOrder: 10
fieldKey: event_source_url
label: Event Source URL
type: STRING
@@ -35668,21 +37517,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: sMfEV3bZ5ymr8qFor3wBw
- sortOrder: 10
- fieldKey: search_string
- label: Search String
- type: STRING
- description: A search query made by a user. This must be a string.
- placeholder: ''
- defaultValue:
- '@path': $.properties.query
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 8nNT55KQyvno3srvRwJfMr
+ - id: rmBt4rFw2JFAn4kPCYShhY
sortOrder: 11
fieldKey: value
label: Value
@@ -35691,12 +37526,14 @@ items:
A numeric value associated with this event. This could be a monetary
value or a value in some other metric.
placeholder: ''
+ defaultValue:
+ '@path': $.properties.price
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: tEGdjpbq4Ax4uBhgn1TCkS
+ - id: iiYb7p3nAhLaHuohSGEpDd
sortOrder: 12
fieldKey: custom_data
label: Custom Data
@@ -35712,7 +37549,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: rCskGZMjraHr4PAZroZtt2
+ - id: sSiVRrPayF6qcVKhG6hKaH
sortOrder: 13
fieldKey: data_processing_options
label: Data Processing Options
@@ -35729,7 +37566,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: kEv8vSDQ5rkshfM96i4yUq
+ - id: 6hWXbZZwrfbGWuK136NetK
sortOrder: 14
fieldKey: data_processing_options_country
label: Data Processing Country
@@ -35750,7 +37587,7 @@ items:
value: 1
dynamic: false
allowNull: false
- - id: rnXvMV3znDL2c9L5jrVByK
+ - id: 5HsEvSk2hJuWUB6fVSWVKA
sortOrder: 15
fieldKey: data_processing_options_state
label: Data Processing State
@@ -35775,15 +37612,294 @@ items:
value: 1002
dynamic: false
allowNull: false
- - id: cKRefik3FJxeKpj45W5WMo
- name: Page View
- slug: pageView
+ - id: evdcEYsm4uM3LNKtFqLBR4
+ name: Custom Event V2
+ slug: custom2
+ description: Send a custom event
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: null
+ fields:
+ - id: dsFumrHc2fAsqoMATCFGf9
+ sortOrder: 0
+ fieldKey: action_source
+ label: Action Source
+ type: STRING
+ description: >-
+ This field allows you to specify where your conversions occurred. See
+ [Facebook
+ documentation](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event)
+ for supported values.
+ 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: other
+ dynamic: false
+ allowNull: false
+ - id: 6WeVKfc3kc3D3xRryVZaAD
+ sortOrder: 1
+ fieldKey: event_name
+ label: Event Name
+ type: STRING
+ description: >-
+ A Facebook [standard
+ event](https://developers.facebook.com/docs/meta-pixel/implementation/conversion-tracking#standard-events)
+ or [custom
+ event](https://developers.facebook.com/docs/meta-pixel/implementation/conversion-tracking#custom-events)
+ name.
+ placeholder: ''
+ defaultValue:
+ '@path': $.event
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: kHwmkxy6DrHxFuLjSLWmvB
+ sortOrder: 2
+ fieldKey: event_time
+ label: Event Time
+ type: STRING
+ description: >-
+ A Unix timestamp in seconds indicating when the actual event occurred.
+ Facebook will automatically convert ISO 8601 timestamps to Unix.
+ placeholder: ''
+ defaultValue:
+ '@path': $.timestamp
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: teVu9rKahTjeS3a5zaWdwd
+ sortOrder: 3
+ fieldKey: user_data
+ label: User Data
+ type: OBJECT
+ description: >-
+ These parameters are a set of identifiers Facebook can use for targeted
+ attribution. You must provide at least one of the following parameters
+ in your request. More information on recommended User Data parameters in
+ Facebook’s [Best Practices for Conversions
+ API](https://www.facebook.com/business/help/308855623839366).
+ placeholder: ''
+ defaultValue:
+ externalId:
+ '@if':
+ exists:
+ '@path': $.userId
+ then:
+ '@path': $.userId
+ else:
+ '@path': $.anonymousId
+ email:
+ '@path': $.context.traits.email
+ phone:
+ '@path': $.context.traits.phone
+ dateOfBirth:
+ '@path': $.context.traits.birthday
+ lastName:
+ '@path': $.context.traits.lastName
+ firstName:
+ '@path': $.context.traits.firstName
+ city:
+ '@path': $.context.traits.address.city
+ state:
+ '@path': $.context.traits.address.state
+ zip:
+ '@path': $.context.traits.address.postalCode
+ client_ip_address:
+ '@path': $.context.ip
+ client_user_agent:
+ '@path': $.context.userAgent
+ fbc:
+ '@path': $.properties.fbc
+ fbp:
+ '@path': $.properties.fbp
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: nFHyB3ieXXULFXHHARn8Fn
+ sortOrder: 4
+ fieldKey: app_data_field
+ label: App Events Fields
+ type: OBJECT
+ description: >-
+ These fields support sending app events to Facebook through the
+ Conversions API. For more information about app events support in the
+ Conversions API, see the Facebook docs
+ [here](https://developers.facebook.com/docs/marketing-api/conversions-api/app-events).
+ App events sent through the Conversions API must be associated with a dataset.
+ Instructions for creating a dataset can be found [here](https://www.facebook.com/business/help/750785952855662?id=490360542427371). Once a dataset is created, the dataset ID
+ can be substituted for the pixel ID in the destination settings.
+ placeholder: ''
+ defaultValue:
+ application_tracking_enabled:
+ '@path': $.context.device.adTrackingEnabled
+ packageName:
+ '@path': $.context.app.namespace
+ longVersion:
+ '@path': $.context.app.version
+ osVersion:
+ '@path': $.context.os.version
+ deviceName:
+ '@path': $.context.device.model
+ locale:
+ '@path': $.context.locale
+ carrier:
+ '@path': $.context.network.carrier
+ width:
+ '@path': $.context.screen.width
+ height:
+ '@path': $.context.screen.height
+ density:
+ '@path': $.context.screen.density
+ deviceTimezone:
+ '@path': $.context.timezone
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: fnC6j74xitvgNGTVvVom9A
+ sortOrder: 5
+ fieldKey: custom_data
+ label: Custom Data
+ type: OBJECT
+ description: >-
+ The custom data object can be used to pass custom properties. See
+ [Facebook
+ documentation](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/custom-data#custom-properties)
+ for more information.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 4jr291kDu4UhJnKrHoqBRA
+ sortOrder: 6
+ fieldKey: event_id
+ label: Event ID
+ type: STRING
+ description: >-
+ This ID can be any unique string. Event ID is used to deduplicate events
+ sent by both Facebook Pixel and Conversions API.
+ placeholder: ''
+ defaultValue:
+ '@path': $.messageId
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 3HR7ueDpmtKz8cjjzkB4Gf
+ sortOrder: 7
+ fieldKey: event_source_url
+ label: Event Source URL
+ type: STRING
+ description: >-
+ The browser URL where the event happened. The URL must begin with
+ http:// or https:// and should match the verified domain. This is
+ required if the action source is "website."
+ placeholder: ''
+ defaultValue:
+ '@path': $.context.page.url
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: wmEjdscMkQUDDTCTVUrLu
+ sortOrder: 8
+ fieldKey: data_processing_options
+ label: Data Processing Options
+ type: BOOLEAN
+ description: >-
+ The Data Processing Options to send to Facebook. If set to true, Segment
+ will send an array to Facebook indicating events should be processed
+ with Limited Data Use (LDU) restrictions. More information can be found
+ in [Facebook’s
+ documentation](https://developers.facebook.com/docs/marketing-apis/data-processing-options).
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: oYq1MaDhWZRscdeEmL4SDh
+ sortOrder: 9
+ fieldKey: data_processing_options_country
+ label: Data Processing Country
+ type: NUMBER
+ description: >-
+ A country that you want to associate to the Data Processing Options.
+ Accepted values are 1, for the United States of America, or 0, to
+ request that Facebook geolocates the event using IP address. This is
+ required if Data Processing Options is set to true. If nothing is
+ provided, Segment will send 0.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices:
+ - label: Use Facebook’s Geolocation Logic
+ value: 0
+ - label: United States of America
+ value: 1
+ dynamic: false
+ allowNull: false
+ - id: wDSaj4FQhGyEyg3qU7fqkA
+ sortOrder: 10
+ fieldKey: data_processing_options_state
+ label: Data Processing State
+ type: NUMBER
+ description: >-
+ A state that you want to associate to the Data Processing Options.
+ Accepted values are 1000, for California, or 0, to request that Facebook
+ geolocates the event using IP address. This is required if Data
+ Processing Options is set to true. If nothing is provided, Segment will
+ send 0.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices:
+ - label: Use Facebook’s Geolocation Logic
+ value: 0
+ - label: California
+ value: 1000
+ - label: Colorado
+ value: 1001
+ - label: Connecticut
+ value: 1002
+ dynamic: false
+ allowNull: false
+ - id: ih16tnLTeTnXUkuFPjwt7K
+ name: Page View V2
+ slug: pageView2
description: Send a page view event when a user lands on a page
platform: CLOUD
hidden: false
defaultTrigger: type = "page"
fields:
- - id: jz3dPQR8KxsDghauwMgJBi
+ - id: oq9jEeGUpuREXuAaP9eaup
sortOrder: 0
fieldKey: action_source
label: Action Source
@@ -35815,7 +37931,7 @@ items:
value: other
dynamic: false
allowNull: false
- - id: jjvBo6CULtEhfhhsu5tJtz
+ - id: qGTR2wG3y62sokAEjb3fNW
sortOrder: 1
fieldKey: event_time
label: Event Time
@@ -35831,7 +37947,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: km3NYajqJEC9u8E77U4Sa8
+ - id: PFhFQESiynr4H148pEeEZ
sortOrder: 2
fieldKey: user_data
label: User Data
@@ -35881,7 +37997,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: jCKx1XhB28w3Cek8X5M768
+ - id: tC4tkYZuGpdkx5bNds6Ff9
sortOrder: 3
fieldKey: app_data_field
label: App Events Fields
@@ -35923,7 +38039,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: hfJ6W5o2c3xQzoAYKQPBzG
+ - id: t6JeWxEGma8JaybD19bQ7L
sortOrder: 4
fieldKey: event_id
label: Event ID
@@ -35939,7 +38055,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: oAoiNiUVXEVqTbmxLTmkoM
+ - id: jsXorkC4Fy6kVdJjmHzot5
sortOrder: 5
fieldKey: event_source_url
label: Event Source URL
@@ -35956,7 +38072,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 3VZTsMGobp2DDX7xtwi4hE
+ - id: dvs39VgLwGciQxWWXunwEa
sortOrder: 6
fieldKey: custom_data
label: Custom Data
@@ -35972,7 +38088,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: wzgxFV3x8f4V4PhNKSJt3D
+ - id: 9NW6PbNod8ZfJ8oivyBDnN
sortOrder: 7
fieldKey: data_processing_options
label: Data Processing Options
@@ -35989,7 +38105,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: g6DrobXiH7haCMR9bJ6PeZ
+ - id: 2R8tdtPUzQ4sbyJj4CKPNZ
sortOrder: 8
fieldKey: data_processing_options_country
label: Data Processing Country
@@ -36010,7 +38126,7 @@ items:
value: 1
dynamic: false
allowNull: false
- - id: xy6UgbbMmye6GzfD82m9ak
+ - id: hTVJ6oAsTXfGkZqF782vhs
sortOrder: 9
fieldKey: data_processing_options_state
label: Data Processing State
@@ -36035,15 +38151,15 @@ items:
value: 1002
dynamic: false
allowNull: false
- - id: eKJbw1Nv4iMEG6MLSGykbs
- name: Initiate Checkout
- slug: initiateCheckout
- description: Send event when a user enters the checkout flow
+ - id: 6DhMqFMRHXiJQqnkiHXn2u
+ name: View Content V2
+ slug: viewContent2
+ description: Send event when a user views content or a product
platform: CLOUD
hidden: false
- defaultTrigger: type = "track" and event = "Checkout Started"
+ defaultTrigger: type = "track" and event = "Product Viewed"
fields:
- - id: xpBX5ESMpe4BPBjA74Fqff
+ - id: goyJaaZALt77XzxwocHq51
sortOrder: 0
fieldKey: action_source
label: Action Source
@@ -36075,7 +38191,7 @@ items:
value: other
dynamic: false
allowNull: false
- - id: iEVAcqyb3adBUxKBZ7r5Ni
+ - id: gJiEoXB5VpbXUxspd872XA
sortOrder: 1
fieldKey: event_time
label: Event Time
@@ -36091,7 +38207,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: mdHD9wJXP6f8GxjCGoEEid
+ - id: rY1geRJK5a7dbtMps6251Z
sortOrder: 2
fieldKey: user_data
label: User Data
@@ -36141,7 +38257,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: oqzt9mDZwBRBCZqvG58m32
+ - id: iEkBHf2sQ16jWpEV58fe43
sortOrder: 3
fieldKey: app_data_field
label: App Events Fields
@@ -36183,7 +38299,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 368rRM2LUQ5b5K2eGX25vT
+ - id: fdfUixAzpoinuC6e3Ry5gx
sortOrder: 4
fieldKey: content_category
label: Content Category
@@ -36195,20 +38311,50 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: viP4sXLg7NEM6zhuPrQW5f
+ - id: uJGbQ2tosUbLSaHwXdmsbX
sortOrder: 5
fieldKey: content_ids
label: Content IDs
type: STRING
description: The content IDs associated with the event, such as product SKUs.
placeholder: ''
+ defaultValue:
+ '@path': $.properties.product_id
required: false
multiple: true
choices: null
dynamic: false
allowNull: false
- - id: odNKAPHa4YMRwynfRVM5qb
+ - id: sXbqzPMwfEUgugLrRCw1M6
sortOrder: 6
+ fieldKey: content_name
+ label: Content Name
+ type: STRING
+ description: The name of the page or product associated with the event.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: pAwtZjp6GX1GAhj1GfpDV1
+ sortOrder: 7
+ fieldKey: content_type
+ label: Content Type
+ type: STRING
+ description: >-
+ The content type should be set to product or product_group. See
+ [Facebook
+ documentation](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/custom-data)
+ for more information.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 3X1md9td83RA6okfao85yw
+ sortOrder: 8
fieldKey: contents
label: Contents
type: OBJECT
@@ -36219,7 +38365,7 @@ items:
placeholder: ''
defaultValue:
'@arrayPath':
- - $.properties.products
+ - $.properties
- id:
'@path': $.product_id
quantity:
@@ -36231,8 +38377,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: uxe1TUsUAbvThQcx5A4Cpw
- sortOrder: 7
+ - id: iiJDdo7iUSxjDivGwG3rCi
+ sortOrder: 9
fieldKey: currency
label: Currency
type: STRING
@@ -36247,8 +38393,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: rW6G4v68zntcaB2kqUmMYD
- sortOrder: 8
+ - id: cYR6bPgpVv2dTiGrpA45Eu
+ sortOrder: 10
fieldKey: event_id
label: Event ID
type: STRING
@@ -36263,8 +38409,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: hm8LW7ow2zN8VbauzvkMCF
- sortOrder: 9
+ - id: taj6c3AoiLnjs4drYdpRBL
+ sortOrder: 11
fieldKey: event_source_url
label: Event Source URL
type: STRING
@@ -36280,20 +38426,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: sFy3cdYx3QF7VzP2ntVK1i
- sortOrder: 10
- fieldKey: num_items
- label: Number of Items
- type: INTEGER
- description: The number of items when checkout was initiated.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: cB4wQFJsvoHmcQR3MaJCU6
- sortOrder: 11
+ - id: 2rP58MPTambeKB8kKvU8sB
+ sortOrder: 12
fieldKey: value
label: Value
type: NUMBER
@@ -36302,14 +38436,14 @@ items:
value or a value in some other metric.
placeholder: ''
defaultValue:
- '@path': $.properties.revenue
+ '@path': $.properties.price
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: c4SxWfrmi5bizRTePtBFrr
- sortOrder: 12
+ - id: eYMbxDoJ3zZoEPMJ5f8LGe
+ sortOrder: 13
fieldKey: custom_data
label: Custom Data
type: OBJECT
@@ -36324,8 +38458,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: mU7VMXyiKRcoYScU5Vctkz
- sortOrder: 13
+ - id: fBBGFJ4C4uGu9waMcpwRCS
+ sortOrder: 14
fieldKey: data_processing_options
label: Data Processing Options
type: BOOLEAN
@@ -36341,8 +38475,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: fpjm6ipWykZ1sYFRDnUe5W
- sortOrder: 14
+ - id: paVMpLLfLojLKLv1fjr39E
+ sortOrder: 15
fieldKey: data_processing_options_country
label: Data Processing Country
type: NUMBER
@@ -36362,8 +38496,8 @@ items:
value: 1
dynamic: false
allowNull: false
- - id: dM9VCGMmAPUMCji54y2uEZ
- sortOrder: 15
+ - id: sb2TmoxJBhKeaDDn8YgtMt
+ sortOrder: 16
fieldKey: data_processing_options_state
label: Data Processing State
type: NUMBER
@@ -36387,15 +38521,15 @@ items:
value: 1002
dynamic: false
allowNull: false
- - id: hTMHeGeBbD7dwjPCGp3LXE
- name: View Content
- slug: viewContent
- description: Send event when a user views content or a product
+ - id: 7bUjfzV1tx4kRPsCVUfbj3
+ name: Initiate Checkout V2
+ slug: initiateCheckout2
+ description: Send event when a user enters the checkout flow
platform: CLOUD
hidden: false
- defaultTrigger: type = "track" and event = "Product Viewed"
+ defaultTrigger: type = "track" and event = "Checkout Started"
fields:
- - id: bscoA96geKyUPyJohQTmTM
+ - id: 7ULvzPVWJ6YNagmAidmYSJ
sortOrder: 0
fieldKey: action_source
label: Action Source
@@ -36427,7 +38561,7 @@ items:
value: other
dynamic: false
allowNull: false
- - id: pGh7HDEcDDmuWX8v959LJg
+ - id: 53i3SkpyQnY67gr9mdf4Sr
sortOrder: 1
fieldKey: event_time
label: Event Time
@@ -36443,7 +38577,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: pKN93pjCCDC7uBZtuVYN6Y
+ - id: ndstTrLVr7ukjZs7DsDeLo
sortOrder: 2
fieldKey: user_data
label: User Data
@@ -36493,7 +38627,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 884sbLCRrxXse9KCFyVqNV
+ - id: uPEH6DXMfGKpZxiHUqHkZ3
sortOrder: 3
fieldKey: app_data_field
label: App Events Fields
@@ -36535,7 +38669,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: do4rHvQ1RNhczemQiu7xrH
+ - id: jmpoUee6VkpvWNHXAwucBG
sortOrder: 4
fieldKey: content_category
label: Content Category
@@ -36547,50 +38681,20 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: fFGiDXy8fiFTyzwu212Tzc
+ - id: 9iLPy6k5zPMmh78ucj7oiu
sortOrder: 5
fieldKey: content_ids
label: Content IDs
type: STRING
description: The content IDs associated with the event, such as product SKUs.
placeholder: ''
- defaultValue:
- '@path': $.properties.product_id
required: false
multiple: true
choices: null
dynamic: false
allowNull: false
- - id: aNBfmeEois1EAvHpw9Ah24
+ - id: pUViP8m4caZxPaf3J2kC8S
sortOrder: 6
- fieldKey: content_name
- label: Content Name
- type: STRING
- description: The name of the page or product associated with the event.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: nMQLzJ6uzd86hbL19eUVJY
- sortOrder: 7
- fieldKey: content_type
- label: Content Type
- type: STRING
- description: >-
- The content type should be set to product or product_group. See
- [Facebook
- documentation](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/custom-data)
- for more information.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: cNeV57BVKbginmkY5xMrGA
- sortOrder: 8
fieldKey: contents
label: Contents
type: OBJECT
@@ -36601,7 +38705,7 @@ items:
placeholder: ''
defaultValue:
'@arrayPath':
- - $.properties
+ - $.properties.products
- id:
'@path': $.product_id
quantity:
@@ -36613,8 +38717,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 6aZGi4G9uMz8KbQwh71mmg
- sortOrder: 9
+ - id: xmdiXht9Fp31GpQnD3VzLS
+ sortOrder: 7
fieldKey: currency
label: Currency
type: STRING
@@ -36629,8 +38733,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: iwTWT2YZ5Dg9oZwHj7hTk9
- sortOrder: 10
+ - id: tKfHPzLXPk83u1wVthCk9z
+ sortOrder: 8
fieldKey: event_id
label: Event ID
type: STRING
@@ -36645,8 +38749,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: xipRpmkHkhqGTpT3LxqTyc
- sortOrder: 11
+ - id: nPETuUNqeyJFK53qa72ZgC
+ sortOrder: 9
fieldKey: event_source_url
label: Event Source URL
type: STRING
@@ -36662,8 +38766,20 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: bbPAp1LReVKkZbjfuYwukv
- sortOrder: 12
+ - id: sb8uUNkbqLzhXjy2JZWGXq
+ sortOrder: 10
+ fieldKey: num_items
+ label: Number of Items
+ type: INTEGER
+ description: The number of items when checkout was initiated.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 2RCMe8Q9Y63VktvupN8qV4
+ sortOrder: 11
fieldKey: value
label: Value
type: NUMBER
@@ -36672,14 +38788,14 @@ items:
value or a value in some other metric.
placeholder: ''
defaultValue:
- '@path': $.properties.price
+ '@path': $.properties.revenue
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: 3pEgnymfPdkPdHNpZ8CAs8
- sortOrder: 13
+ - id: tUPPKLbYE75ucVfHJ3QA4W
+ sortOrder: 12
fieldKey: custom_data
label: Custom Data
type: OBJECT
@@ -36694,8 +38810,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: mBQu1pdGPVThzminEyDvgc
- sortOrder: 14
+ - id: mNHTYdnEeRWR4MGQfhP99H
+ sortOrder: 13
fieldKey: data_processing_options
label: Data Processing Options
type: BOOLEAN
@@ -36711,8 +38827,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: t5LPbXDKoWfHUkzwitfktD
- sortOrder: 15
+ - id: gurq3MeaXSTff5ehHKivg2
+ sortOrder: 14
fieldKey: data_processing_options_country
label: Data Processing Country
type: NUMBER
@@ -36732,8 +38848,8 @@ items:
value: 1
dynamic: false
allowNull: false
- - id: f9QP42h1CREgxP2bymPhiB
- sortOrder: 16
+ - id: mMUVwQ9Fx6aGLAR9PQqzDR
+ sortOrder: 15
fieldKey: data_processing_options_state
label: Data Processing State
type: NUMBER
@@ -36757,15 +38873,15 @@ items:
value: 1002
dynamic: false
allowNull: false
- - id: ky2wkC8WvTrC8PEZMwwGq5
- name: Add to Cart
- slug: addToCart
- description: Send event when a user adds a product to the shopping cart
+ - id: mXCmJL8XpnvVDxuonYLqyF
+ name: Search V2
+ slug: search2
+ description: Send event when a user searches content or products
platform: CLOUD
hidden: false
- defaultTrigger: type = "track" and event = "Product Added"
+ defaultTrigger: type = "track" and event = "Products Searched"
fields:
- - id: 28pB8xiNnCbAYeMua4KKFc
+ - id: 8i3D1PK1pjr6kwL1xcpy7W
sortOrder: 0
fieldKey: action_source
label: Action Source
@@ -36797,7 +38913,7 @@ items:
value: other
dynamic: false
allowNull: false
- - id: gQ12w6uV5B1dyALSTkRhok
+ - id: 64YZgycLwGaavd1R74T3Ch
sortOrder: 1
fieldKey: event_time
label: Event Time
@@ -36813,7 +38929,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 4mCQHsnMabtAuQGdbJusQb
+ - id: nsRVeuMnY1Y3XTZjwcuVRY
sortOrder: 2
fieldKey: user_data
label: User Data
@@ -36863,7 +38979,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: vPyV1LhZejr94uoezkTxLK
+ - id: 8fXrUbJ1eDXbz82NLxmtsB
sortOrder: 3
fieldKey: app_data_field
label: App Events Fields
@@ -36905,48 +39021,32 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: wdfLk4eufYheXfEn4LU5EJ
+ - id: recDkvY4AjcZksFXftmGgu
sortOrder: 4
- fieldKey: content_ids
- label: Content IDs
+ fieldKey: content_category
+ label: Content Category
type: STRING
- description: The content IDs associated with the event, such as product SKUs.
+ description: The category of the content associated with the event.
placeholder: ''
required: false
- multiple: true
+ multiple: false
choices: null
dynamic: false
allowNull: false
- - id: 56t7d5TRR6fvEzVE7i2LSZ
+ - id: 5RnkNHf1zxqp5yHiDV4QW9
sortOrder: 5
- fieldKey: content_name
- label: Content Name
+ fieldKey: content_ids
+ label: Content IDs
type: STRING
- description: The name of the page or product associated with the event.
+ description: The content IDs associated with the event, such as product SKUs.
placeholder: ''
required: false
- multiple: false
+ multiple: true
choices: null
dynamic: false
allowNull: false
- - id: 5TDE6D79Mq95BC5czLrcnw
+ - id: wLZDWaiiiQsA7dzx6oniT4
sortOrder: 6
- fieldKey: content_type
- label: Content Type
- type: STRING
- description: >-
- The content type should be set to product or product_group. See
- [Facebook
- documentation](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/custom-data)
- for more information.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: rrGmA56yLY6TaRM8gfhe8B
- sortOrder: 7
fieldKey: contents
label: Contents
type: OBJECT
@@ -36969,8 +39069,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: hcxofx5giDUNyuZFeRoa5M
- sortOrder: 8
+ - id: m9gyTQQYrcxHn7FZE5FNas
+ sortOrder: 7
fieldKey: currency
label: Currency
type: STRING
@@ -36985,8 +39085,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 99xRnFn8yeNRR955nwWE74
- sortOrder: 9
+ - id: vrT4hf5a3yKdeeqcR2hGbn
+ sortOrder: 8
fieldKey: event_id
label: Event ID
type: STRING
@@ -37001,8 +39101,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: oUJfxSpc6oYpeQNVWNEc9D
- sortOrder: 10
+ - id: bJLvmPdnjKwGmiFEVQXN8C
+ sortOrder: 9
fieldKey: event_source_url
label: Event Source URL
type: STRING
@@ -37018,7 +39118,21 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: jYVy839Ky4yz4hMY71GQNh
+ - id: kyhnMAKTeftkMtqkDy6Ugq
+ sortOrder: 10
+ fieldKey: search_string
+ label: Search String
+ type: STRING
+ description: A search query made by a user. This must be a string.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.query
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: hq8NYyJuzSKdgH9PrHPBFd
sortOrder: 11
fieldKey: value
label: Value
@@ -37027,14 +39141,12 @@ items:
A numeric value associated with this event. This could be a monetary
value or a value in some other metric.
placeholder: ''
- defaultValue:
- '@path': $.properties.price
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: 6Ha5zPga8T9evE16zEqhYq
+ - id: qVEbcT2FnFycB4Ruy6Fd7G
sortOrder: 12
fieldKey: custom_data
label: Custom Data
@@ -37050,7 +39162,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: e3Y7qh8sPib3eXSxMsGWn5
+ - id: nV2yVS7KKj43JMYopA6654
sortOrder: 13
fieldKey: data_processing_options
label: Data Processing Options
@@ -37067,7 +39179,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: f7WDz3nGYtjjGkfM5fkH1Y
+ - id: j5c4rLSMBKYsGnr78DGN5t
sortOrder: 14
fieldKey: data_processing_options_country
label: Data Processing Country
@@ -37088,7 +39200,7 @@ items:
value: 1
dynamic: false
allowNull: false
- - id: uPaPuVnMSmVbQQRE7xgHJ3
+ - id: wda4xFsPmvJR1oYwBqFCFD
sortOrder: 15
fieldKey: data_processing_options_state
label: Data Processing State
@@ -42289,12 +44401,12 @@ items:
website: https://gameball.co
status: PUBLIC_BETA
categories:
- - Analytics
- - Referrals
+ - Marketing Automation
+ - Personalization
logo:
- url: https://cdn.filepicker.io/api/file/xtCx7XETbmRkCnYnJJ2Y
+ url: https://cdn-devcenter.segment.com/ed473a14-4d4e-4880-a63f-2ef88baadd5a.svg
mark:
- url: https://cdn.filepicker.io/api/file/BL3WrhoASWm1sSQ4J2bb
+ url: https://cdn-devcenter.segment.com/35f5dd13-db69-477d-88da-31c0172f94c9.svg
methods:
track: true
identify: true
@@ -44313,7 +46425,7 @@ items:
hidden: true
defaultTrigger: null
fields:
- - id: uLdgBnHMjxmBcm2iq7nEsh
+ - id: eNSduZ7ZVwV1mEkSXe2Jaq
sortOrder: 0
fieldKey: conversion_label
label: Conversion Label
@@ -44330,7 +46442,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: wDZ5gf7SCq1YCc5EhDcnAh
+ - id: 6g2EZvqj8ajZ2Qp1N5QWXZ
sortOrder: 1
fieldKey: email
label: Email
@@ -44351,7 +46463,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: fKwewQP6eXMCWRNVXHH8KC
+ - id: 94t52F6JpKbUHt9Hj37JaT
sortOrder: 2
fieldKey: transaction_id
label: Order ID
@@ -44370,7 +46482,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: rwW5x7EYK541EcCDUnUCHy
+ - id: Ft1ttjsFwk6BParEyrQho
sortOrder: 3
fieldKey: user_agent
label: User Agent
@@ -44390,7 +46502,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: gK4R6TTn6NJLUxB8xDzaHB
+ - id: xj4aBZX4YL1X4HVPeRAokp
sortOrder: 4
fieldKey: conversion_time
label: Conversion Time
@@ -44405,7 +46517,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: sVrG9DxnRNtpEFTrmhr9QY
+ - id: XAKcvjuh8pFq7GKrCSSmW
sortOrder: 5
fieldKey: value
label: Value
@@ -44420,7 +46532,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: 7NMwkAPihf9WEnSGQZMrZy
+ - id: jUS4tFE3cVGze2HTJwG1mU
sortOrder: 6
fieldKey: currency_code
label: Currency Code
@@ -44437,7 +46549,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: wThdt78TvHppmLcY1YUgfA
+ - id: ksE6Vq1Amrrj5ep7RA7KLL
sortOrder: 7
fieldKey: is_app_incrementality
label: App Conversion for Incrementality Study
@@ -44451,7 +46563,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: ntLWjxvR9RJRm7myAqdhpY
+ - id: qr4uuHbMgdmFqCeBQSbK6s
sortOrder: 8
fieldKey: pcc_game
label: PCC Game Flag
@@ -44467,7 +46579,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: 6n3z4GRydLkeDT7NHFskbj
+ - id: uFSAmcMupPeE5PrbK4qZUf
sortOrder: 9
fieldKey: phone_number
label: Phone Number
@@ -44490,7 +46602,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: gB5SiMFqmPHJEveCkHdDyU
+ - id: eGva2Z25nKZS9a7yjNh4aq
sortOrder: 10
fieldKey: first_name
label: First Name
@@ -44511,7 +46623,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: 3N4QbL8e26zs6fT3PRDNTY
+ - id: 63sn7hpGo6SWz1bGaxovea
sortOrder: 11
fieldKey: last_name
label: Last Name
@@ -44532,7 +46644,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: 5uD6vmjwNuGcsejVsGJ3T9
+ - id: ibWuJgNPN8b6oywUgXPZtu
sortOrder: 12
fieldKey: street_address
label: Street Address
@@ -44553,7 +46665,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: sUxRStVNr3UaiztksYiNYz
+ - id: gaCQQGd3ZfCEttq3g5j8X1
sortOrder: 13
fieldKey: city
label: City
@@ -44574,7 +46686,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: 6cUVN76KdNC9bGw5mipyEN
+ - id: pqotMLdxU2rcc7X2HmiLBh
sortOrder: 14
fieldKey: region
label: Region
@@ -44595,7 +46707,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: qpesS2w31wZywE5gcrL9SL
+ - id: hdwfQFuq4pmCEdjoa58vEF
sortOrder: 15
fieldKey: post_code
label: Postal Code
@@ -44616,7 +46728,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: XXQ2r4aTi9Um88jZ51MgA
+ - id: fqxdzJLyQrmrzJrtCxVRVJ
sortOrder: 16
fieldKey: country
label: Country
@@ -44645,7 +46757,7 @@ items:
hidden: false
defaultTrigger: null
fields:
- - id: gim7gDyBZj5horWWzBirK6
+ - id: 9kUShKdJkgJ38Gz2YRKXga
sortOrder: 0
fieldKey: conversion_action
label: Conversion Action ID
@@ -44658,7 +46770,7 @@ items:
dynamic: true
allowNull: false
hidden: false
- - id: azHBQREkPSbsYuXVhtt7pV
+ - id: ctEAQjiPXfmahzbiAZzCko
sortOrder: 1
fieldKey: adjustment_type
label: Adjustment Type
@@ -44684,7 +46796,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: 8xEa5WNUdLc4C23KiC5yrc
+ - id: sk7PapLeCPmZZVDNCHMorf
sortOrder: 2
fieldKey: adjustment_timestamp
label: Adjustment Timestamp
@@ -44703,7 +46815,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: pxR34HB3d44maEL5t6jQw8
+ - id: 5ax2BupWQeur7uR1kXncLy
sortOrder: 3
fieldKey: order_id
label: Order ID
@@ -44727,7 +46839,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: t55kDd21Qzuqvgw6sDU2nM
+ - id: eYwzkEufzTuuHcMBQeigJw
sortOrder: 4
fieldKey: gclid
label: GCLID
@@ -44742,7 +46854,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: fkt4fRT6ZSRCdYPaosKt8o
+ - id: 2JLoXDCjnZf66Xbw2KbycU
sortOrder: 5
fieldKey: conversion_timestamp
label: Conversion Timestamp
@@ -44759,7 +46871,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: sbqKaD4cx3SW5sGy1so9HS
+ - id: wqtUzaFzvz7eSKrkmAua2J
sortOrder: 6
fieldKey: restatement_value
label: Restatement Value
@@ -44776,7 +46888,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: nrPYtLsGFXyYP3BV5jctmb
+ - id: jJmWjJP5VGu8VFmj236aGm
sortOrder: 7
fieldKey: restatement_currency_code
label: Restatement Currency Code
@@ -44793,7 +46905,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: aHdjZusdFt7vsPBLZLL7ZN
+ - id: mjKWqpP38HuEFkHUX6v9dx
sortOrder: 8
fieldKey: email_address
label: Email Address
@@ -44816,7 +46928,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: 491CK7u9cErQPGB857sokr
+ - id: 84V4dq541WUwE3QrxJ5ty3
sortOrder: 9
fieldKey: phone_number
label: Phone Number
@@ -44840,7 +46952,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: xtYyUGUCfGw213yaK3bGsm
+ - id: pPAqHgZHUe4oyuuoinwYpx
sortOrder: 10
fieldKey: first_name
label: First Name
@@ -44863,7 +46975,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: wEis85M8QDX1DjcxBxNx8h
+ - id: nYF2HBGX1wFf7W8J6po84V
sortOrder: 11
fieldKey: last_name
label: Last Name
@@ -44886,7 +46998,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: jdUdxQRjwBvRpc1ki1x2AB
+ - id: ehRhLeNvZhLUXQnikMcW5o
sortOrder: 12
fieldKey: city
label: City
@@ -44907,7 +47019,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: uz5j8MP17H7Qf6brAjASm9
+ - id: 4qyiJHCJaZWz19erawS5rH
sortOrder: 13
fieldKey: state
label: State
@@ -44928,7 +47040,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: rqFBHvfTGeiEfzgynMhDrs
+ - id: hV6UdUof5BxJtkfrzKUHds
sortOrder: 14
fieldKey: country
label: Country
@@ -44951,7 +47063,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: 6z2hEBKRYzGpJmanCyPtap
+ - id: rsWdk2YoWuJ8pCXqRnfJXf
sortOrder: 15
fieldKey: postal_code
label: Postal Code
@@ -44972,7 +47084,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: iYppEYjPuseThf1o9dQkWz
+ - id: smT68jXoYYuDTz18t8booX
sortOrder: 16
fieldKey: street_address
label: Street Address
@@ -44995,7 +47107,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: 4v8RhCpudgH3axASomKvx8
+ - id: f4xPB59Zdw67883mMkf3gC
sortOrder: 17
fieldKey: user_agent
label: User Agent
@@ -45023,7 +47135,7 @@ items:
hidden: false
defaultTrigger: null
fields:
- - id: ujC3Vm5HkWAkpBfR66JjTY
+ - id: 2PvhL4bExtYzGQE6hLbsd9
sortOrder: 0
fieldKey: conversion_action
label: Conversion Action ID
@@ -45036,7 +47148,7 @@ items:
dynamic: true
allowNull: false
hidden: false
- - id: wN7t6WW4cZEyR7C2UR9Bws
+ - id: u58HePpHL8v9RStDKdwpgz
sortOrder: 1
fieldKey: gclid
label: GCLID
@@ -45049,7 +47161,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: 8bZEiayoBNb8jPrjKiQJjG
+ - id: r3KFe4BNaGYhyhczAowWYA
sortOrder: 2
fieldKey: gbraid
label: GBRAID
@@ -45064,7 +47176,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: tMMx6TKMN5Z6nNdTMG3JDy
+ - id: nsecYtAKU3wAkMSREaUrr3
sortOrder: 3
fieldKey: wbraid
label: WBRAID
@@ -45079,7 +47191,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: pjRKWv8iqXGH8t5CymHgCQ
+ - id: hgA3J4vNjvcedwnB1x8ayd
sortOrder: 4
fieldKey: conversion_timestamp
label: Conversion Timestamp
@@ -45097,7 +47209,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: xd1c5DeMSKyKxYPjbNKBff
+ - id: 35yzkrLEjQoBWWW51szNaY
sortOrder: 5
fieldKey: email_address
label: Email Address
@@ -45120,7 +47232,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: r6Fg1F2uJ2R6Nuseha9JN2
+ - id: fJaHzhfHg9yL3kpoJQURwL
sortOrder: 6
fieldKey: phone_number
label: Phone Number
@@ -45144,7 +47256,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: oYiLhhA8oJsPBmSVSEB3XV
+ - id: 8wVPNFYREdFBrfTR2F7T22
sortOrder: 7
fieldKey: order_id
label: Order ID
@@ -45167,7 +47279,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: aKQor8YtZMPqMQ7tnhB6Xq
+ - id: uphSioJEPwbKBZ4oWFyfvG
sortOrder: 8
fieldKey: value
label: Value
@@ -45182,7 +47294,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: hPhyWXL8czNtYERvWbRuby
+ - id: ri6ff47GyAJtUJtMZHp7Dc
sortOrder: 9
fieldKey: currency
label: Currency
@@ -45199,7 +47311,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: c6EmuYQ9J3Aq1scQuoxBSE
+ - id: p7gaL255fw7vLWZskATmKC
sortOrder: 10
fieldKey: conversion_environment
label: Conversion Environment
@@ -45222,7 +47334,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: shdgzEbdSQwbTwUX9SKLHz
+ - id: gG8i2bLseoc3nbGkEqnB1Y
sortOrder: 11
fieldKey: merchant_id
label: Merchant Center ID
@@ -45235,7 +47347,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: smyBw1NSCAvFWwftCyfNz8
+ - id: xacfk5mR1GaTsZubFH2vba
sortOrder: 12
fieldKey: merchant_country_code
label: Merchant Center Feed Country Code
@@ -45250,7 +47362,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: vHiYv9D8rXpRPSBRqB9qVT
+ - id: 8c39pfZVaAM5J7mRca3HKB
sortOrder: 13
fieldKey: merchant_language_code
label: Merchant Center Feed Language Code
@@ -45265,7 +47377,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: x9hChrYxvFTeSKv2aNKc46
+ - id: e8HH5XvM9QtjE3gphYqQEk
sortOrder: 14
fieldKey: local_cost
label: Local Transaction Cost
@@ -45280,7 +47392,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: qD4G9cKdWQc4XUW7EcDtbo
+ - id: 7bcaJekqhRhLv3ig8anXuJ
sortOrder: 15
fieldKey: items
label: Items
@@ -45302,7 +47414,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: jg63D6EXRASYUatMdsCCEr
+ - id: 3mYzyZnk2nzMT6c2HRpgT8
sortOrder: 16
fieldKey: custom_variables
label: Custom Variables
@@ -45321,7 +47433,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: qcZSGY4gVzk93g51ofDZr4
+ - id: tWi2jLTZyCrLNb8R3B1gRj
sortOrder: 17
fieldKey: ad_user_data_consent_state
label: Ad User Data Consent State
@@ -45342,7 +47454,7 @@ items:
value: UNSPECIFIED
dynamic: false
allowNull: false
- - id: eWcZheB6rePX91Wr1wvGqP
+ - id: wpzwu2peaNbV6QbGJgZSmB
sortOrder: 18
fieldKey: ad_personalization_consent_state
label: Ad Personalization Consent State
@@ -45372,7 +47484,7 @@ items:
hidden: false
defaultTrigger: null
fields:
- - id: u8rvVgazVW6U5wsnkXRccx
+ - id: 4WxxcHUVn3vdQzCa7BtTW5
sortOrder: 0
fieldKey: conversion_action
label: Conversion Action ID
@@ -45385,7 +47497,7 @@ items:
dynamic: true
allowNull: false
hidden: false
- - id: rjApBQkAPTdbxPTWXhTZyg
+ - id: X1QJxXPxABXZ7CwwqHYgQ
sortOrder: 1
fieldKey: caller_id
label: Caller ID
@@ -45400,7 +47512,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: 2HykZmpBMMh8Xr7im4J6S
+ - id: kNwLsBruBsA6eATegAyCDZ
sortOrder: 2
fieldKey: call_timestamp
label: Call Timestamp
@@ -45416,7 +47528,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: eiWknAp29PVbB48FsEQbvk
+ - id: a4zmDEduvCqrRjVmTnMfis
sortOrder: 3
fieldKey: conversion_timestamp
label: Conversion Timestamp
@@ -45434,7 +47546,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: urSmAzP2GfoAPyXKTwKSxb
+ - id: ayrdEJLKixAcd6DJ7pEJiP
sortOrder: 4
fieldKey: value
label: Value
@@ -45449,7 +47561,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: iv8xfo7Wh9iASRfbAC66Ex
+ - id: n4mtniuEJ2PQvcHXDUVmf1
sortOrder: 5
fieldKey: currency
label: Currency
@@ -45466,7 +47578,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: sn6cDF5S9XBmtn88iHhmsz
+ - id: re4E7KNk5eqGTLsH2ovR1F
sortOrder: 6
fieldKey: custom_variables
label: Custom Variables
@@ -45485,7 +47597,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: 3gXzkPDJaLdXbQv84EQpdK
+ - id: pLyxXPSLLtrPMfPgzJ5Bom
sortOrder: 7
fieldKey: ad_user_data_consent_state
label: Ad User Data Consent State
@@ -45506,7 +47618,7 @@ items:
value: UNSPECIFIED
dynamic: false
allowNull: false
- - id: koWswig4qAXJtEDJeyFaBy
+ - id: fDCQqYrJvEAmj7LvsRdjHQ
sortOrder: 8
fieldKey: ad_personalization_consent_state
label: Ad Personalization Consent State
@@ -45536,7 +47648,7 @@ items:
hidden: false
defaultTrigger: event = "Audience Entered" or event = "Audience Exited"
fields:
- - id: nmoGeeQgALTmNZ4jydTrtx
+ - id: bs8uhisbBH4AW4waKf9c5w
sortOrder: 0
fieldKey: first_name
label: First Name
@@ -45558,7 +47670,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: wLaS7Agk6uyta5QzTPG4sE
+ - id: 6pgT1iLCwhVAEPC4KgB5Re
sortOrder: 1
fieldKey: last_name
label: Last Name
@@ -45580,7 +47692,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: v8PjQsFnmHQis3qcCaGYmC
+ - id: 63QukvypK6eVqc6jEBkyUH
sortOrder: 2
fieldKey: email
label: Email
@@ -45602,7 +47714,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: kBqAxTVScVyrj3Gdze6R8g
+ - id: fvTViLAJNMS1rVrxFJSSew
sortOrder: 3
fieldKey: phone
label: Phone
@@ -45624,7 +47736,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: bbWzoZrupP5vYMoRsCYVFq
+ - id: 8H4DNCHBDZHiWhoZEowtRg
sortOrder: 4
fieldKey: country_code
label: Country Code
@@ -45636,7 +47748,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: u3QCnkJRzCLZzBNgryy3GX
+ - id: fmuctFrwn7rnjeVxBmG1Az
sortOrder: 5
fieldKey: postal_code
label: Postal Code
@@ -45648,7 +47760,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: i4sjoSeE73xAuPJfK3nFn6
+ - id: wR4fingryaswujYi3r5EA1
sortOrder: 6
fieldKey: crm_id
label: CRM ID
@@ -45662,7 +47774,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: rFahbxn3KhcmeXoAv2woD7
+ - id: o4AczNsP6bFrXfRBcEZ6N9
sortOrder: 7
fieldKey: mobile_advertising_id
label: Mobile Advertising ID
@@ -45678,7 +47790,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: hUTEMTngCppcG7Gkqy6Mc
+ - id: p1CNftxhLLKvrvxnq9Mizf
sortOrder: 8
fieldKey: ad_user_data_consent_state
label: Ad User Data Consent State
@@ -45699,7 +47811,7 @@ items:
value: UNSPECIFIED
dynamic: false
allowNull: false
- - id: hDZHa1qYr5gi9HAgBwNcJb
+ - id: tRukPoFuVMjbzKW6q9FTsP
sortOrder: 9
fieldKey: ad_personalization_consent_state
label: Ad Personalization Consent State
@@ -45721,7 +47833,7 @@ items:
value: UNSPECIFIED
dynamic: false
allowNull: false
- - id: mscNamo6E55qTmo66H7gc2
+ - id: 4QEG3kXgzQ7nh9UnRFdYv7
sortOrder: 14
fieldKey: list_id
label: Existing List ID
@@ -45735,7 +47847,7 @@ items:
choices: null
dynamic: true
allowNull: false
- - id: 3wBBiKPCG4oMG69JgFSimS
+ - id: iRXNh5sx7uEVMYvkMcBoP6
sortOrder: 15
fieldKey: list_name
label: List Name
@@ -45747,7 +47859,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: eMHy6JKYoRCic5D9ahpVTV
+ - id: xf85RbHXzdxefqnZZxG7YR
sortOrder: 16
fieldKey: external_id_type
label: External ID Type
@@ -45766,7 +47878,7 @@ items:
value: MOBILE_ADVERTISING_ID
dynamic: false
allowNull: false
- - id: 3c4KskyQ5kpEc7U7TfRyjE
+ - id: b5xjA9PEv2FWRsNNcfx4et
sortOrder: 17
fieldKey: app_id
label: App ID
@@ -45781,7 +47893,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: uemAvhhgJWhhpVrEPQt5oU
+ - id: dbjkCY1h18iwkPGhKDHGdH
sortOrder: 18
fieldKey: retlOnMappingSave
label: Connect to a Google Customer Match User List
@@ -45797,14 +47909,14 @@ items:
allowNull: false
hidden: false
- id: aEXyKwvX58cDpANMSz1Wyr
- name: Call Conversion
+ name: Call Conversion V2
slug: uploadCallConversion2
description: Send an offline call conversion to the Google Ads API.
platform: CLOUD
hidden: false
defaultTrigger: null
fields:
- - id: 3k8cvcB5JTSJzpYfrBWfhe
+ - id: bRLZJbakuFREheoL4ymgPs
sortOrder: 0
fieldKey: conversion_action
label: Conversion Action ID
@@ -45816,7 +47928,7 @@ items:
choices: null
dynamic: true
allowNull: false
- - id: 6TZu6DqNyYYaqcnok4toeS
+ - id: 4cz8PJzNaXae5GEpHoaqRV
sortOrder: 1
fieldKey: caller_id
label: Caller ID
@@ -45830,7 +47942,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: kDjCHtgJecqWUEbGAaqcN9
+ - id: t8MYiLhcDEZ1LP4kMz5YmS
sortOrder: 2
fieldKey: call_timestamp
label: Call Timestamp
@@ -45845,7 +47957,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 4fyeQYKAoP1hwTsQYPHMgE
+ - id: 9XZWbsLf5zmuVsDvZYJ3PU
sortOrder: 3
fieldKey: conversion_timestamp
label: Conversion Timestamp
@@ -45862,7 +47974,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: dj3Za9ZCkx6XhZ8tRLzn9Q
+ - id: oZ8SL8zLpkwvR71soM5rSQ
sortOrder: 4
fieldKey: value
label: Value
@@ -45876,7 +47988,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: c7UncD7fb3FZvk2wEoG6eZ
+ - id: p8b3ubkdRbybuaySdVzF5o
sortOrder: 5
fieldKey: currency
label: Currency
@@ -45892,7 +48004,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: ccCd3pYmfvCkMpo1PpEV3r
+ - id: sER76YEstevVLhn1rg4ob
sortOrder: 6
fieldKey: custom_variables
label: Custom Variables
@@ -45910,7 +48022,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: pJSQcrMh8DttS2y8mBcLDW
+ - id: udjp8eBdCFULfWPX2jQ3oW
sortOrder: 7
fieldKey: ad_user_data_consent_state
label: Ad User Data Consent State
@@ -45931,7 +48043,7 @@ items:
value: UNSPECIFIED
dynamic: false
allowNull: false
- - id: 4nfBK5fGfyh8VBFxfrm8nd
+ - id: 6GU1H2yeCFFbQYAMDkdCZT
sortOrder: 8
fieldKey: ad_personalization_consent_state
label: Ad Personalization Consent State
@@ -45954,14 +48066,14 @@ items:
dynamic: false
allowNull: false
- id: epVKrw136iFuoQmFvJp4p2
- name: Conversion Adjustment
+ name: Conversion Adjustment V2
slug: uploadConversionAdjustment2
description: Send a conversion adjustment to the Google Ads API.
platform: CLOUD
hidden: false
defaultTrigger: null
fields:
- - id: dL4j2QjYZLER8endL7Psg5
+ - id: wv2fmXPxWUnXQAya1ssWNy
sortOrder: 0
fieldKey: conversion_action
label: Conversion Action ID
@@ -45973,7 +48085,7 @@ items:
choices: null
dynamic: true
allowNull: false
- - id: atJY3yoxctDUfFjypwpB45
+ - id: 4SXzQevUh9MaHoqZaqdqEw
sortOrder: 1
fieldKey: adjustment_type
label: Adjustment Type
@@ -45998,7 +48110,7 @@ items:
value: ENHANCEMENT
dynamic: false
allowNull: false
- - id: nryMqTRgviW6Rf3gyMLDN1
+ - id: ougScSBgFCnAsNjLSxqKso
sortOrder: 2
fieldKey: adjustment_timestamp
label: Adjustment Timestamp
@@ -46016,7 +48128,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: qiqNDSrdiXpeZqWUbuEZvv
+ - id: Bj6sRxgAqdjPT7LRqvnwZ
sortOrder: 3
fieldKey: order_id
label: Order ID
@@ -46039,7 +48151,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: ny1JHwYgCGLJ2S7UwWx39M
+ - id: wku9fxHgQnWC8YKVEJBgXK
sortOrder: 4
fieldKey: gclid
label: GCLID
@@ -46053,7 +48165,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: nH1NoE8RddZsP3c7UWRoi3
+ - id: a5KZ8qb8Rg5FNk9Uh7o5gk
sortOrder: 5
fieldKey: conversion_timestamp
label: Conversion Timestamp
@@ -46069,7 +48181,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 8K5icpfj4WDcPLGoAYVZMM
+ - id: axSjXdpV5sg1yA9nwR52to
sortOrder: 6
fieldKey: restatement_value
label: Restatement Value
@@ -46085,7 +48197,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: uNUx4gZLfrzLfPe7JLmkev
+ - id: 3znmvX5tLCgu8vWqZ1uZuz
sortOrder: 7
fieldKey: restatement_currency_code
label: Restatement Currency Code
@@ -46101,7 +48213,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: aQxL3hPY1VKUsTnarcBZZi
+ - id: o5JBov5R6yQ7Dx5qfXcp4t
sortOrder: 8
fieldKey: email_address
label: Email Address
@@ -46123,7 +48235,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 2AGU1JmNQRsXbXGyaS35gD
+ - id: 6GnLGst6K7ykaKLXiWwZBE
sortOrder: 9
fieldKey: phone_number
label: Phone Number
@@ -46146,7 +48258,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: oaaPPr7Q4XGaRkAPkr1Uw2
+ - id: 9W9xCxNhDhSabw8ekynijy
sortOrder: 10
fieldKey: first_name
label: First Name
@@ -46168,7 +48280,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: d4DVbLu7FNzXkorTVyMsLE
+ - id: vzHaU1jcRUsDwKEU5XA1JN
sortOrder: 11
fieldKey: last_name
label: Last Name
@@ -46190,7 +48302,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: oKgcH5UuMswqsz3jKCYKt5
+ - id: k5X1EobbWcQWDdd5T6Uz7m
sortOrder: 12
fieldKey: city
label: City
@@ -46210,7 +48322,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: sjJ88CwdURwxEnHrhLGRPg
+ - id: cfBwQx3XvphottcFh8hahM
sortOrder: 13
fieldKey: state
label: State
@@ -46230,7 +48342,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: rBoPHGcHsF36ruzuzBCxKb
+ - id: gMDe61BKWHiWSMgJkSPC98
sortOrder: 14
fieldKey: country
label: Country
@@ -46252,7 +48364,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: dSShRGieRrWUD9Y7yiumiS
+ - id: 3tsFCUUjbrQDxtKxWYyAWC
sortOrder: 15
fieldKey: postal_code
label: Postal Code
@@ -46272,7 +48384,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: o2yRVsYRP4GPaTHALXviwK
+ - id: nuFTmFULEbidx7kYH37Wg1
sortOrder: 16
fieldKey: street_address
label: Street Address
@@ -46294,7 +48406,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 9G4EZLNfXxCfwAJpFRbunQ
+ - id: oid6JhiiSaFpvkx6L3LoHi
sortOrder: 17
fieldKey: user_agent
label: User Agent
@@ -46314,14 +48426,14 @@ items:
dynamic: false
allowNull: false
- id: pAMZTGDc7yKTW5ZGecP8Df
- name: Click Conversion
+ name: Click Conversion V2
slug: uploadClickConversion2
description: Send an offline click conversion to the Google Ads API.
platform: CLOUD
hidden: false
defaultTrigger: null
fields:
- - id: wdu7cK9GUcUVHKgwmcyJyg
+ - id: 3ipP36wEa7XZ3zNaYKF37B
sortOrder: 0
fieldKey: conversion_action
label: Conversion Action ID
@@ -46333,7 +48445,7 @@ items:
choices: null
dynamic: true
allowNull: false
- - id: cuae3CNRUvuSZA4kkADB67
+ - id: aMFsZ7zdM8amX1hBrvumw5
sortOrder: 1
fieldKey: gclid
label: GCLID
@@ -46345,7 +48457,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 25r8SUJcWRFWj6zr3YspxK
+ - id: s82b1H6vhjUR8QWRFknARt
sortOrder: 2
fieldKey: gbraid
label: GBRAID
@@ -46359,7 +48471,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 5q4WgGUNUgibtBNGVXmBhs
+ - id: oeoYE3hS56HZeUtDePSucJ
sortOrder: 3
fieldKey: wbraid
label: WBRAID
@@ -46373,7 +48485,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: guHH6Qv8bM9mLnWf4vwQy4
+ - id: 21Ur67nkLdopCkfKDbCrem
sortOrder: 4
fieldKey: conversion_timestamp
label: Conversion Timestamp
@@ -46390,7 +48502,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 2MQ7QToZnPAjSHTZDu1hVx
+ - id: s4biW1c8Yrr8256m6pmbiv
sortOrder: 5
fieldKey: email_address
label: Email Address
@@ -46412,7 +48524,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: x8Pgj8UEiwrLNxjTQ4NbBQ
+ - id: d1riRDfZqrdanobe5gLT2A
sortOrder: 6
fieldKey: phone_number
label: Phone Number
@@ -46435,7 +48547,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: tuTr1xKMebQPAX9CXdjLH3
+ - id: hYxTMqnwf7EStBKgWw8q7i
sortOrder: 7
fieldKey: order_id
label: Order ID
@@ -46457,7 +48569,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: qHY9KioQWhJvGPAmoSvXKW
+ - id: 7UKYiByC1PdSo2JAY71JfA
sortOrder: 8
fieldKey: value
label: Value
@@ -46471,7 +48583,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: pnZj5WYtHvUds2ux2sCv3J
+ - id: jmvznwanpZApBHxRY9km8E
sortOrder: 9
fieldKey: currency
label: Currency
@@ -46487,7 +48599,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: w21ZTapYgBPZLDC5Tie53t
+ - id: wgZfAKzzfQdX4yM9BrjPrE
sortOrder: 10
fieldKey: conversion_environment
label: Conversion Environment
@@ -46509,7 +48621,7 @@ items:
value: UNSPECIFIED
dynamic: false
allowNull: false
- - id: sxAch31kzXVH2CFmXNMi6y
+ - id: akrmSDpF9DzZxw1iBARm7v
sortOrder: 11
fieldKey: merchant_id
label: Merchant Center ID
@@ -46521,7 +48633,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: eJqqcxLYKjVmdRDYm1WASV
+ - id: 39ePHgutWGmGSBKz5UR8Pi
sortOrder: 12
fieldKey: merchant_country_code
label: Merchant Center Feed Country Code
@@ -46535,7 +48647,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: gV8MrPoohZkzewCtJHZ5iF
+ - id: 9qMLzxF8eiNZSLFr3pBXcM
sortOrder: 13
fieldKey: merchant_language_code
label: Merchant Center Feed Language Code
@@ -46549,7 +48661,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: iEiYoXoWdLsjH3vkmh59AS
+ - id: ofEnJQAF393xVqzawyjAqh
sortOrder: 14
fieldKey: local_cost
label: Local Transaction Cost
@@ -46563,7 +48675,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: oYipPjm4TmFmCqRhDKB4Fc
+ - id: psiDt52nGdPiYsbokj84rJ
sortOrder: 15
fieldKey: items
label: Items
@@ -46584,7 +48696,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: a5NVAd2hf7rQ9dA3tjTz1M
+ - id: i2BbP5m4ntJkgEgQ5XYyWx
sortOrder: 16
fieldKey: custom_variables
label: Custom Variables
@@ -46602,7 +48714,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: wtFijTM7RrEZxy3pnYKB18
+ - id: q5k7nZ4PmujzEXPQeC1iZW
sortOrder: 17
fieldKey: ad_user_data_consent_state
label: Ad User Data Consent State
@@ -46623,7 +48735,7 @@ items:
value: UNSPECIFIED
dynamic: false
allowNull: false
- - id: 6mZBatgt3KyieiA8QLM3nB
+ - id: 4DR1HM5zfjPHo9EFwx2uZ7
sortOrder: 18
fieldKey: ad_personalization_consent_state
label: Ad Personalization Consent State
@@ -55027,7 +57139,7 @@ items:
hidden: false
defaultTrigger: event = "updated" or event = "new"
fields:
- - id: uSLTyGgi43U9QF4ip5MVM8
+ - id: ob9uczev9JQwvr2qn1pwos
sortOrder: 0
fieldKey: record_identifier
label: Record Identifier
@@ -55042,7 +57154,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: voYsAvpCtRwpdf4Xzo1sZQ
+ - id: iYHn1zLcAXefPcDmYSbrWG
sortOrder: 2
fieldKey: spreadsheet_id
label: Spreadsheet ID
@@ -55059,7 +57171,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: 3nxKazU6pd561T7APqYCf7
+ - id: gEtw7nseVKHXHRULB3oLSY
sortOrder: 3
fieldKey: spreadsheet_name
label: Spreadsheet Name
@@ -55076,7 +57188,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: gg8RAwSero8nooPGTKM98i
+ - id: iAsmY9nGZtHtHJ4fXvrpck
sortOrder: 4
fieldKey: data_format
label: Data Format
@@ -55100,7 +57212,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: goowWMG2QcMTYVeCCguQow
+ - id: wmCfxsUh1piWcugvvKoxwT
sortOrder: 5
fieldKey: fields
label: Fields
@@ -55123,7 +57235,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: vmTpJH9eDnaZh8QQFYUdz1
+ - id: ryHB4sxoEtCpNFER38u74V
sortOrder: 6
fieldKey: enable_batching
label: Batch Data to Google Sheets
@@ -55140,14 +57252,14 @@ items:
allowNull: false
hidden: false
- id: uubTyoJCQgG6yJNoRbxqdS
- name: Post Sheet
+ name: Post Sheet V2
slug: postSheet2
description: Write values to a Google Sheets spreadsheet.
platform: CLOUD
hidden: false
defaultTrigger: event = "updated" or event = "new"
fields:
- - id: dshpmqj388mSSQDmaPXXii
+ - id: 5tSMqy3ehomxjp4i3Kz7BA
sortOrder: 0
fieldKey: record_identifier
label: Record Identifier
@@ -55161,7 +57273,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: p7N3LfZW9MoiAyajiKuvCe
+ - id: hWxt1cyMckuVMUkZffVSuT
sortOrder: 1
fieldKey: spreadsheet_id
label: Spreadsheet ID
@@ -55177,7 +57289,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: iKFz21yRnq5hmc6uiiMeED
+ - id: wchxabRTr1Fgax8XTQqccb
sortOrder: 2
fieldKey: spreadsheet_name
label: Spreadsheet Name
@@ -55193,7 +57305,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: nTrE3SGLXUCuesbR6qafeZ
+ - id: gFWZLekb2CFfzL9vz46X9v
sortOrder: 3
fieldKey: data_format
label: Data Format
@@ -55216,7 +57328,7 @@ items:
value: USER_ENTERED
dynamic: false
allowNull: false
- - id: tmoAxzUHXpXKAjMTfntZFC
+ - id: wcMpHcrYSo1yWeCF8YtT4U
sortOrder: 4
fieldKey: fields
label: Fields
@@ -55238,7 +57350,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 9XxjYMWCWq6TJbHtYjsgz6
+ - id: 8Z6jGQ82uyVjtGbjf2NzPn
sortOrder: 5
fieldKey: enable_batching
label: Batch Data to Google Sheets
@@ -56688,7 +58800,7 @@ items:
hidden: false
defaultTrigger: type = "track"
fields:
- - id: goqo9bJikPS5u85pAETd9a
+ - id: bdP65buKAm47gumo3giXpC
sortOrder: 0
fieldKey: eventName
label: Event Name
@@ -56706,7 +58818,7 @@ items:
choices: null
dynamic: true
allowNull: false
- - id: qvKYEx5fdg6CdXVbeLRC9x
+ - id: j4G2wQBuUR3EtZkWiaxodr
sortOrder: 1
fieldKey: occurredAt
label: Event Timestamp
@@ -56722,7 +58834,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: ntHCCBzRJyXKonrJrVJeRU
+ - id: 9zZJCoanVLKtiUafmues6N
sortOrder: 2
fieldKey: email
label: Email Address
@@ -56744,7 +58856,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: e9Uzv57B2xwxVvJ44a1SHH
+ - id: sBRaKHkXSESz345sAAVbfc
sortOrder: 3
fieldKey: utk
label: User Token
@@ -56758,7 +58870,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: fKXafF6uzgj3poQTE87M4K
+ - id: dNLsoSRt9aXa6HFwaN8tA5
sortOrder: 4
fieldKey: objectId
label: Object ID
@@ -56773,7 +58885,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: g2YvaRara6ocxwdUUG7VXN
+ - id: jJFPKpkep7eAsxUysVekXg
sortOrder: 5
fieldKey: properties
label: Event Properties
@@ -56798,7 +58910,7 @@ items:
hidden: false
defaultTrigger: null
fields:
- - id: tHi3DEWd9eezG7s8kprp2b
+ - id: hcucFBiEgMCECjJfPLJEQ4
sortOrder: 0
fieldKey: createNewCustomRecord
label: Create Custom Object Record if Not Found
@@ -56815,7 +58927,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: cu8EBC9rAcwxW4dyfdKhZz
+ - id: 7KU1pkoi3ShJUDs67eevT9
sortOrder: 1
fieldKey: customObjectSearchFields
label: Custom Object Search Fields
@@ -56830,7 +58942,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: e13naqL2SfzL9q5H2qGTkX
+ - id: 7KGcGgdNyUd8Wa1sqo4nLS
sortOrder: 2
fieldKey: objectType
label: Object Type
@@ -56848,7 +58960,7 @@ items:
choices: null
dynamic: true
allowNull: false
- - id: vLcksd53cSCzoDv7ySxfHq
+ - id: 3otM6PDBzi8vGuwC63hVD4
sortOrder: 3
fieldKey: properties
label: Properties
@@ -56866,7 +58978,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: qM1W5aNxAuNxYRx22Wjowk
+ - id: 6LN21bLfUnhJcqbba2josy
sortOrder: 4
fieldKey: searchFieldsToAssociateCustomObjects
label: Search Fields to Associate custom Object
@@ -56882,7 +58994,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: eX8CjarBBgVvnkG76BVr9u
+ - id: 4KRhUvLRCVo2r3t6yQNZaa
sortOrder: 5
fieldKey: toObjectType
label: ObjectType to associate
@@ -56900,7 +59012,7 @@ items:
choices: null
dynamic: true
allowNull: false
- - id: edFyoRSbKFStJuiPMYf6gz
+ - id: mjeFiejStfJBPPyzs44J1t
sortOrder: 6
fieldKey: associationLabel
label: Association Label
@@ -56920,7 +59032,7 @@ items:
hidden: false
defaultTrigger: type = "identify"
fields:
- - id: 3ppDrG8JXiRdd9CVWKMKoB
+ - id: 7hcWbXeZNJRXk3XPSuu6XJ
sortOrder: 0
fieldKey: email
label: Email
@@ -56938,7 +59050,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 8PokZBdwBGiUJMqCAWudU9
+ - id: nJZRkb4bB4xkDdvwZeh73s
sortOrder: 1
fieldKey: company
label: Company Name
@@ -56952,7 +59064,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 2WEYmTph6DaUNa4z2H3Auk
+ - id: vQpTmXLd1jc6rbVhmB6xrZ
sortOrder: 2
fieldKey: firstname
label: First Name
@@ -56972,7 +59084,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: gf1NYi5zcsghNEyMrUkH6r
+ - id: z3jib5SH5HSusty1ZGSuv
sortOrder: 3
fieldKey: lastname
label: Last Name
@@ -56992,7 +59104,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: dddRh6UZ7ANWrfT3GeyvjY
+ - id: esPuSManaRVMNw2iCSAXMT
sortOrder: 4
fieldKey: phone
label: Phone
@@ -57006,7 +59118,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 8sVjPBerjtDz3AVQUdFRzD
+ - id: sjfg2qJWYykUh9f1oaSTeE
sortOrder: 5
fieldKey: address
label: Street Address
@@ -57020,7 +59132,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: oq7mamtJ2TZ7tBzRYyPftd
+ - id: gTqMwdiwE9CxmrtwBjhdsZ
sortOrder: 6
fieldKey: city
label: City
@@ -57034,7 +59146,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 9sF4JKxsin3Rea7af5LJxv
+ - id: 5wsniTwu2VxNuhy43ZmzB6
sortOrder: 7
fieldKey: state
label: State
@@ -57048,7 +59160,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 7wTrowWuX1962boLUEi7Jr
+ - id: oMM1cqZqQz4gKeCHrFQhtw
sortOrder: 8
fieldKey: country
label: Country
@@ -57062,7 +59174,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: NdSdj8jbADU9Ut3bvPUDX
+ - id: bvbRi24XkYy2M7XJYCeC5T
sortOrder: 9
fieldKey: zip
label: Postal Code
@@ -57082,7 +59194,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: sE7ipc8aSR5V6x8jnKbHNA
+ - id: b7cuaNx4qSDjojLHnNK81W
sortOrder: 10
fieldKey: website
label: Website
@@ -57096,7 +59208,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: tNFi78wMu71ttWHcBiFMEf
+ - id: xj2zaAgttfhUphy7MpMZVq
sortOrder: 11
fieldKey: lifecyclestage
label: Lifecycle Stage
@@ -57112,7 +59224,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: cHbUg9wyTF641UA27xrFLH
+ - id: cvMNMgjW6WjurEchBv8nZN
sortOrder: 12
fieldKey: properties
label: Other properties
@@ -57130,7 +59242,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: evBDyZHs9AVqEdXB5mzK1a
+ - id: kVwAVu13b2FxDhpdgnBX55
sortOrder: 13
fieldKey: enable_batching
label: Send Batch Data to HubSpot
@@ -57155,7 +59267,7 @@ items:
hidden: false
defaultTrigger: type = "group"
fields:
- - id: ooh21Ej7ov1MDzgwAwNgEX
+ - id: vfL2uNSrsAYtgHqP7UFeuL
sortOrder: 0
fieldKey: groupid
label: Unique Company Identifier
@@ -57179,7 +59291,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: PrgBWF1kXodhvrVUgdRqb
+ - id: rU1rW627jrptLPVpz6DPjw
sortOrder: 1
fieldKey: createNewCompany
label: Create Company if Not Found
@@ -57196,7 +59308,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 7jVU6dkkKghpeWSue8gSNi
+ - id: 3H5YHGG87tHQdsgA1CHH5S
sortOrder: 2
fieldKey: associateContact
label: Associate Contact with Company
@@ -57215,7 +59327,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 2ptfC94xnkLhD5oqwFKzrs
+ - id: jWQQWwuhtBqwVGPNES4MiY
sortOrder: 3
fieldKey: companysearchfields
label: Company Search Fields
@@ -57232,7 +59344,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: tqPb47zm5BrNsoXe8WivBV
+ - id: 36vnAVMv1kVNJGHp3Ff3fW
sortOrder: 4
fieldKey: name
label: Company Name
@@ -57246,7 +59358,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: t6HcUDdBpzSwifaC7n7SuA
+ - id: tD7uLeMBXz6moKrHfrFjZc
sortOrder: 5
fieldKey: description
label: Company Description
@@ -57260,7 +59372,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: okSuEYWzQJiPoTLwdGVp8e
+ - id: n9DpLGnxssLcCv6XmgYDiX
sortOrder: 6
fieldKey: address
label: Street Address
@@ -57274,7 +59386,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: e4UKr9s6U7KbTaDbu2eTMQ
+ - id: 89df6WSQHHC7HtMDZedjyL
sortOrder: 7
fieldKey: city
label: City
@@ -57288,7 +59400,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: ehvSRMp63QrqpF6gmkSCNV
+ - id: czww5LkZzK961Wn6dWJPCC
sortOrder: 8
fieldKey: state
label: State
@@ -57302,7 +59414,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 2qrLM4jw8y3mHMZeVGDMn
+ - id: 31atMSbX8Cy7egcnojBfG2
sortOrder: 9
fieldKey: zip
label: Postal Code
@@ -57322,7 +59434,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: szD94LZpDsRiJrFQMY1cRd
+ - id: mkaPuPxtoDKKZDKxZKm5xf
sortOrder: 10
fieldKey: domain
label: Domain
@@ -57336,7 +59448,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 9tDinDpbeavuAgoJ7o1Y3e
+ - id: aiyuJi8WUHyGWfpf8wGPMf
sortOrder: 11
fieldKey: phone
label: Phone
@@ -57350,7 +59462,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 7HtmK4djcSTPTLcGcaDiXp
+ - id: 99iadF5vDjtHeRa2VMeb6Y
sortOrder: 12
fieldKey: numberofemployees
label: Number of Employees
@@ -57364,7 +59476,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 7hTxvGYH5d3XJRg4adSVrd
+ - id: oW8v9CtBjNqmhE9bN9VBS4
sortOrder: 13
fieldKey: industry
label: Industry
@@ -57378,7 +59490,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: nf2e7XWDT9rmWg27VTEhta
+ - id: um1mzk7bHqWEX1AndRzYzC
sortOrder: 14
fieldKey: lifecyclestage
label: Lifecycle Stage
@@ -57394,7 +59506,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: csPRT1eVEZGSzmtTBxZzga
+ - id: 9e3Gj8xiUmTJnKad3ntk2h
sortOrder: 15
fieldKey: properties
label: Other Properties
@@ -57415,7 +59527,7 @@ items:
dynamic: false
allowNull: false
- id: dMYued7r3VjK4c2gBWUTZi
- name: Custom Object
+ name: Custom Object V2
slug: upsertObject
description: >-
Add, create or update records of any Object type to HubSpot, and
@@ -57424,7 +59536,7 @@ items:
hidden: false
defaultTrigger: null
fields:
- - id: 6odrrSgobAdQ8C5A8U8Qq4
+ - id: 6onNRaNFypRAZYYGLdGcMh
sortOrder: 0
fieldKey: object_details
label: Object Details
@@ -57436,7 +59548,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 7gGGci4wTn99EZsHUDUeTA
+ - id: neit3KHMYRK4barKnqgsGG
sortOrder: 1
fieldKey: properties
label: Properties
@@ -57448,7 +59560,7 @@ items:
choices: null
dynamic: true
allowNull: false
- - id: q9mS896SkoWsnGH88ZcUPh
+ - id: fgCoGZ6dJsJtwS9L2zyYKH
sortOrder: 2
fieldKey: sensitive_properties
label: Sensitive Properties
@@ -57460,7 +59572,7 @@ items:
choices: null
dynamic: true
allowNull: false
- - id: qb5iFNjTzby8QJq6K9V2v8
+ - id: 2NzrfV6g9Q3vYitYSd7Euv
sortOrder: 3
fieldKey: association_sync_mode
label: Associated Record Sync Mode
@@ -57480,7 +59592,7 @@ items:
value: read
dynamic: false
allowNull: false
- - id: 5RNdr51F8XqvW86wMJhztd
+ - id: 3xw89jjDecGhxRbs5HRoKA
sortOrder: 4
fieldKey: associations
label: Associations
@@ -57493,14 +59605,14 @@ items:
dynamic: false
allowNull: false
- id: mRG4EEHrTjKLyAfzbKhUZ9
- name: Custom Event
+ name: Custom Event V2
slug: customEvent
description: Send Custom Events to HubSpot
platform: CLOUD
hidden: false
defaultTrigger: null
fields:
- - id: 3SvBqvvv9kxCAw5Z1gfHpp
+ - id: 5f3aU3UJaPSCsKebg9rgUX
sortOrder: 0
fieldKey: event_name
label: Event Name
@@ -57512,7 +59624,7 @@ items:
choices: null
dynamic: true
allowNull: false
- - id: jGoyiXExNnfXxQXc4vuWm1
+ - id: 4T7uF24G7W69fTTnWqHLu
sortOrder: 1
fieldKey: record_details
label: Associated Record Details
@@ -57524,7 +59636,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 9GiVnDxuGAxp5ntkhrvTDt
+ - id: mEdo3jCu1x7CuuztvfTxGQ
sortOrder: 2
fieldKey: properties
label: Properties
@@ -57536,7 +59648,7 @@ items:
choices: null
dynamic: true
allowNull: false
- - id: kwJmA7mh3vseCEvieuNxhT
+ - id: 2YNqwrKaM51n8cWyYUySWz
sortOrder: 3
fieldKey: occurred_at
label: Event Timestamp
@@ -64898,7 +67010,7 @@ items:
hidden: false
defaultTrigger: type = "track" and event != "Order Completed" and event != "Cart Updated"
fields:
- - id: h3LtsAdSXtCPPnUrVeN8dF
+ - id: uzVzLELw15PD4XjtEV3muA
sortOrder: 0
fieldKey: email
label: Email Address
@@ -64919,7 +67031,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: xymGtAHpaxGQ1aUV2zxC7a
+ - id: 99bP2z87kape9XULfj8tDE
sortOrder: 1
fieldKey: userId
label: User ID
@@ -64934,7 +67046,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: wu1nhgvqJZunK3Ps7JXKRC
+ - id: uGVVnvUfyGDM4HTi9DJpuR
sortOrder: 2
fieldKey: eventName
label: Event name
@@ -64949,7 +67061,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: kX3oVdHCQNHCzoYCGFs5Vb
+ - id: 5pLTg2rNR2FikU8TM7aHPY
sortOrder: 3
fieldKey: dataFields
label: Event Data Fields
@@ -64964,7 +67076,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: 5DfeLXuXbQ1BPwV78Y8epH
+ - id: oZ7eE11zSM9HR4pEbyKH76
sortOrder: 4
fieldKey: id
label: Event ID
@@ -64979,7 +67091,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: cuDR6uokrEkGSTfjyJZZxS
+ - id: bt6unGQvAqfjpANDGgw2Wz
sortOrder: 5
fieldKey: createdAt
label: Timestamp
@@ -64994,7 +67106,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: cPVTgiybaDgWT2Ndi4CfiN
+ - id: uJBPgiQMYs9Z8psAiokLFo
sortOrder: 6
fieldKey: campaignId
label: Campaign ID
@@ -65009,7 +67121,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: m6VWporL6u5gLqXxsMBxsP
+ - id: 6DZLjcZCbDNLBndRVUoCsR
sortOrder: 7
fieldKey: templateId
label: Template ID
@@ -65032,7 +67144,7 @@ items:
hidden: false
defaultTrigger: type = "track" and event == "Cart Updated"
fields:
- - id: 3cwG8qetmfJ7DXAtJEj2kh
+ - id: 2wYY3Yb9viuMMoYKXjoqzG
sortOrder: 0
fieldKey: user
label: User Data
@@ -65061,7 +67173,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: mKJ18sizAKyVFFmB1VQbQH
+ - id: kpSxYdS77E6cnnUUzRVCRu
sortOrder: 1
fieldKey: items
label: Cart items
@@ -65105,7 +67217,7 @@ items:
hidden: false
defaultTrigger: type = "track" and event == "Order Completed"
fields:
- - id: i48Xb3AWZaoqCy51coWWSR
+ - id: upJXyw5ByGT8QDJ9Cei6D1
sortOrder: 0
fieldKey: id
label: Order ID
@@ -65124,7 +67236,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: fMaCHP4cLKTLXv3rHRJDwD
+ - id: 7NYHvXFwEEXfgmpq6asT2G
sortOrder: 1
fieldKey: user
label: User Data
@@ -65153,7 +67265,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: cWEyLBK7zxXtr4k7pQNpV4
+ - id: jrKRegnj7xDAaX4357aAyH
sortOrder: 2
fieldKey: dataFields
label: Event Data Fields
@@ -65168,7 +67280,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: uF78EHrvLTzyunJe5Vproe
+ - id: 2VRN6ivMbG4JU3CjThjnUg
sortOrder: 3
fieldKey: items
label: Cart items
@@ -65204,7 +67316,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: aH8WrzzQhqh7EBXnpybwu9
+ - id: eYDbVkcHNCEj4yftLhkcYu
sortOrder: 4
fieldKey: total
label: Total
@@ -65219,7 +67331,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: cQcqwYu7A7fPbDjkdrYimG
+ - id: hhZfz4etCngqpYyPeQe4hz
sortOrder: 5
fieldKey: createdAt
label: Timestamp
@@ -65234,7 +67346,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: cqdcFYiUkozTYBQLfcScJZ
+ - id: 67HUZvaNu9JwsX3DvK4ZMf
sortOrder: 6
fieldKey: campaignId
label: Campaign ID
@@ -65249,7 +67361,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: imNjZaQN1TQy2zLos2G4au
+ - id: ax3srMCVyyyaAGJhMHWxto
sortOrder: 7
fieldKey: templateId
label: Template ID
@@ -65272,7 +67384,7 @@ items:
hidden: false
defaultTrigger: type = "identify"
fields:
- - id: 3CVTPExfpFxBhwewTQGk43
+ - id: 6LFdomb8axwFkz2HkxzGSg
sortOrder: 0
fieldKey: email
label: Email Address
@@ -65287,7 +67399,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: mi6mFvF4ySgwTom3LrTR74
+ - id: 7vHXkKDCmnicsqH98M6Xf5
sortOrder: 1
fieldKey: userId
label: User ID
@@ -65302,7 +67414,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: t9csoRow3tCf5cnDnn3wMu
+ - id: xbxRZp69WuBEnpU79MGtDk
sortOrder: 2
fieldKey: dataFields
label: User Data Fields
@@ -65317,7 +67429,7 @@ items:
dynamic: false
allowNull: false
hidden: false
- - id: sUrPffLkhBJ6z3QS7rBqky
+ - id: 5owxxgcxWsEAZY2qYUuh1K
sortOrder: 3
fieldKey: phoneNumber
label: User Phone Number
@@ -65334,7 +67446,7 @@ items:
dynamic: false
allowNull: true
hidden: false
- - id: 5c6GA9o1wH8T22gavQHiLu
+ - id: rRz4yiJxn13e7ny6zP1hob
sortOrder: 4
fieldKey: mergeNestedObjects
label: Merge Nested Objects
@@ -65351,20 +67463,20 @@ items:
dynamic: false
allowNull: false
hidden: false
+ - id: vSbYkh937zPkUzDEWeG8fG
+ sortOrder: 5
+ fieldKey: enable_batching
+ label: Enable Batching
+ type: BOOLEAN
+ description: When enabled, Segment will send data to Iterable in batches of up to 500
+ placeholder: ''
+ defaultValue: false
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
presets:
- - actionId: ifeXsLqNNjJ5HJdRKSJwea
- name: Identify Calls
- fields:
- email:
- '@path': $.traits.email
- userId:
- '@path': $.userId
- dataFields:
- '@path': $.traits
- phoneNumber:
- '@path': $.traits.phone
- mergeNestedObjects: false
- trigger: type = "identify"
- actionId: hgu8jn8qk4wt7VZD4P67uV
name: Order Completed Calls
fields:
@@ -65418,6 +67530,21 @@ items:
templateId:
'@path': $.properties.templateId
trigger: type = "track" and event = "Order Completed"
+ - actionId: ifeXsLqNNjJ5HJdRKSJwea
+ name: Identify Calls
+ fields:
+ email:
+ '@path': $.traits.email
+ userId:
+ '@path': $.userId
+ dataFields:
+ '@path': $.traits
+ phoneNumber:
+ '@path': $.traits.phone
+ mergeNestedObjects: false
+ enable_batching: false
+ batch_size: 1001
+ trigger: type = "identify"
- actionId: 3MrS3Se3PAaxL4wpQN93gA
name: Track Calls
fields:
@@ -65621,6 +67748,68 @@ items:
'@path': $.traits
trigger: type = "identify"
partnerOwned: true
+- id: 6294dd197382c750f0fe1e2d
+ display_name: Jimo
+ name: Jimo
+ slug: jimo
+ hidden: false
+ endpoints:
+ - US
+ regions:
+ - us-west-2
+ - eu-west-1
+ url: connections/destinations/catalog/jimo
+ previous_names:
+ - Jimo
+ website: https://www.usejimo.com
+ status: PUBLIC
+ categories:
+ - Customer Success
+ - Enrichment
+ - Marketing Automation
+ - Surveys
+ logo:
+ url: https://cdn-devcenter.segment.com/455db91f-495e-403f-aeec-88eb62e460a2.svg
+ mark:
+ url: https://cdn-devcenter.segment.com/b3caa7cd-af5a-4033-ac20-d10ac1067857.svg
+ methods:
+ track: true
+ identify: true
+ group: false
+ alias: false
+ screen: false
+ page: false
+ platforms:
+ browser: true
+ mobile: true
+ server: true
+ warehouse: false
+ cloudAppObject: false
+ components: []
+ browserUnbundlingSupported: false
+ browserUnbundlingPublic: false
+ replay: false
+ connection_modes:
+ device:
+ web: false
+ mobile: false
+ server: false
+ cloud:
+ web: true
+ mobile: true
+ server: true
+ settings:
+ - name: apiKey
+ type: string
+ defaultValue: ''
+ description: >-
+ You can find your API key in your integrations page after you linked
+ Segment to your Jimo account
+ required: true
+ label: API Key
+ actions: []
+ presets: []
+ partnerOwned: true
- id: 652d4cf5e00c0147e6eaf5e7
display_name: Jimo (Actions)
name: Jimo (Actions)
diff --git a/src/_data/catalog/destinations_private.yml b/src/_data/catalog/destinations_private.yml
index d046bd0488..70cfdaf92c 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 2024-09-03
+# destination data last updated 2024-09-10
items:
- id: 54521fd925e721e32a72eee1
display_name: Pardot
diff --git a/src/_data/catalog/source_categories.yml b/src/_data/catalog/source_categories.yml
index b60544acbd..7cf9caeb79 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 2024-09-03
+# source categories last updated 2024-09-10
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 36436993c1..9d2ef44c53 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 2024-09-03
+# sources last updated 2024-09-10
items:
- id: 8HWbgPTt3k
display_name: .NET
diff --git a/src/connections/destinations/actions.md b/src/connections/destinations/actions.md
index 6681fb62b6..1497d0df8c 100644
--- a/src/connections/destinations/actions.md
+++ b/src/connections/destinations/actions.md
@@ -185,7 +185,6 @@ If necessary, click **New Mapping** to create a new, blank action.
6. When you're satisfied with the mapping, click **Save**. Segment returns you to the Mappings table.
7. In the Mappings table **Status** column, verify that the **Enabled** toggle is on for the mapping you just customized.
-
> info ""
> The required fields for a destination mapping appear automatically. Click the + sign to see optional fields.
diff --git a/src/connections/destinations/catalog/actions-1flow/index.md b/src/connections/destinations/catalog/actions-1flow/index.md
index 72fe57e8b1..0f3fe68ff4 100644
--- a/src/connections/destinations/catalog/actions-1flow/index.md
+++ b/src/connections/destinations/catalog/actions-1flow/index.md
@@ -19,7 +19,7 @@ When you use the 1Flow Web (Actions) Destination, Segment loads the [1Flow SDK](
2. Search for and select **1Flow Web (Actions) Destination**.
3. Select the web source that will send data to 1Flow web (Actions) and follow the steps to name your destination. The web source chosen must use [Analytics.js 2.0](/docs/connections/source/catalog/libraries/website/javascript).
4. On the **Settings** tab, input your 1Flow **PROJECT API KEY** and other destinations settings.
-5. Follow the step in the Destinations Actions docs to [customizing mappings](/docs/connections/destinations/action/#customizing-mappings).
+5. Follow the step in the Destinations Actions docs to [customize your mappings](/docs/connections/destinations/action/#customize-mappings).
6. Enable the destination and configured mappings.
{% include components/actions-fields.html %}
diff --git a/src/connections/destinations/catalog/actions-adobe-target-cloud/index.md b/src/connections/destinations/catalog/actions-adobe-target-cloud/index.md
index d17cdeb9b2..901f1558ba 100644
--- a/src/connections/destinations/catalog/actions-adobe-target-cloud/index.md
+++ b/src/connections/destinations/catalog/actions-adobe-target-cloud/index.md
@@ -23,7 +23,7 @@ The Adobe Target Cloud Mode destination sends user information to the Adobe Targ
3. Click **Configure Adobe Target Cloud Mode** in the top-right corner of the screen.
4. Select the source that will send data to Adobe Target Cloud Mode and follow the steps to name your destination.
5. On the **Settings** tab, input your Adobe Target destination settings.
-6. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customizing-mappings).
+6. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings).
7. Enable the destination and configured mappings.
{% include components/actions-fields.html %}
diff --git a/src/connections/destinations/catalog/actions-adobe-target-web/index.md b/src/connections/destinations/catalog/actions-adobe-target-web/index.md
index f08742cdb5..aee557867d 100644
--- a/src/connections/destinations/catalog/actions-adobe-target-web/index.md
+++ b/src/connections/destinations/catalog/actions-adobe-target-web/index.md
@@ -23,7 +23,7 @@ The Adobe Target Web destination loads Adobe's `at.js` script for you in order t
3. Click **Configure Adobe Target Web** in the top-right corner of the screen.
4. Select the web source that will send data to Adobe Target Web and follow the steps to name your destination. The web source chosen must use [Analytics.js 2.0](/docs/connections/sources/catalog/libraries/website/javascript/).
5. On the **Settings** tab, input your Adobe Target destination settings.
-6. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customizing-mappings).
+6. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings).
7. Enable the destination and configured mappings.
{% include components/actions-fields.html %}
diff --git a/src/connections/destinations/catalog/actions-amplitude/index.md b/src/connections/destinations/catalog/actions-amplitude/index.md
index e543879bf8..62cb81fb0f 100644
--- a/src/connections/destinations/catalog/actions-amplitude/index.md
+++ b/src/connections/destinations/catalog/actions-amplitude/index.md
@@ -33,7 +33,7 @@ Amplitude (Actions) provides the following benefits over the classic Amplitude d
4. Click the "Amplitude" item to select it and click **Configure**.
5. Choose which of your sources to connect the destination to. (You can connect more sources to the destination later.)
-Once you have a mapping, you can follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customizing-mappings).
+Once you have a mapping, you can follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings).
### Log Purchases in existing destination instances
@@ -208,7 +208,7 @@ To use Amplitude's groups with Segment, you must enable the following Action set
Keep the following in mind if you plan to move to Amplitude (Actions) from a classic Amplitude destination.
> info ""
-> In some cases, Amplitude Classic uses different default mappings than Amplitude (Actions). For example, the `Viewed Home Page` event in Amplitude Classic will be `Viewed Home` in Amplitude Actions, unless you configure it as `Viewed Home Page`. Be sure to follow the steps in the Destination Actions documentation to [customize your mappings](/docs/connections/destinations/actions/#customizing-mappings). Review how events appear in each destination, and configure the Actions' mappings properly to maintain continuity between Classic and Actions destinations.
+> In some cases, Amplitude Classic uses different default mappings than Amplitude (Actions). For example, the `Viewed Home Page` event in Amplitude Classic will be `Viewed Home` in Amplitude Actions, unless you configure it as `Viewed Home Page`. Be sure to follow the steps in the Destination Actions documentation to [customize your mappings](/docs/connections/destinations/actions/#customize-mappings). Review how events appear in each destination, and configure the Actions' mappings properly to maintain continuity between Classic and Actions destinations.
### Amplitude (Actions) uses Amplitude's HTTP API v2
diff --git a/src/connections/destinations/catalog/actions-blackbaud-raisers-edge-nxt/index.md b/src/connections/destinations/catalog/actions-blackbaud-raisers-edge-nxt/index.md
index 12891893d3..b93cf22327 100644
--- a/src/connections/destinations/catalog/actions-blackbaud-raisers-edge-nxt/index.md
+++ b/src/connections/destinations/catalog/actions-blackbaud-raisers-edge-nxt/index.md
@@ -20,7 +20,7 @@ your Blackbaud Developer account.
6. Visit the Blackbaud ["My subscriptions"](https://developer.blackbaud.com/subscriptions/){:target="_blank"}
page, copy your **Primary access key**, and paste the value into the **Blackbaud API Subscription Key** field.
7. Follow the steps in the Destinations Actions documentation on
-[Customizing mappings](/docs/connections/destinations/actions/#customizing-mappings). You must select which
+[Customizing mappings](/docs/connections/destinations/actions/#customize-mappings). You must select which
Event Types and/or Event Names will trigger each mapping.
8. Enable the destination and configured mappings.
diff --git a/src/connections/destinations/catalog/actions-dynamic-yield-audiences/index.md b/src/connections/destinations/catalog/actions-dynamic-yield-audiences/index.md
index 7c8770a470..9a52364ff4 100644
--- a/src/connections/destinations/catalog/actions-dynamic-yield-audiences/index.md
+++ b/src/connections/destinations/catalog/actions-dynamic-yield-audiences/index.md
@@ -16,6 +16,13 @@ This destination is maintained by Dynamic Yield by Mastercard. For any issues wi
**Dynamic Yield by Mastercard Audiences** is an Audience Destination which must be first connected to an Engage Space before it can be connected to individual Engage Audiences. The steps below outline how to connect the Destination to an Engage Space and then to an Audience.
+### Enable IP allowlisting
+Dynamic Yield requires that data sent by Segment originate from a fixed IP range. As a prerequisite to using the **Dynamic Yield by Mastercard Audiences** Destination, Segment Business Tier customers must enable the **IP Allowlisting** feature on their workspace. This feature is only available for Segment Business Tier customers.
+
+To enable IP allowlisting:
+1. Navigate to **Settings > Workspace Settings > Destination IP Settings** in your Segment workspace.
+2. Click **Enable IP allowlisting** to enable the feature.
+
### Create an instance of the Dynamic Yield Destination
1. From your Segment workspace, navigate to **Connections > Catalog**.
diff --git a/src/connections/destinations/catalog/actions-facebook-conversions-api/index.md b/src/connections/destinations/catalog/actions-facebook-conversions-api/index.md
index 313e6514a9..a745137faf 100644
--- a/src/connections/destinations/catalog/actions-facebook-conversions-api/index.md
+++ b/src/connections/destinations/catalog/actions-facebook-conversions-api/index.md
@@ -60,7 +60,7 @@ Set up your Pixel to work with the Facebook Conversions API (Actions) destinatio
3. Click **Configure Facebook Conversions API (Actions)** in the top-right corner of the screen.
4. Select the source that will send data to Facebook Conversions API and follow the steps to name your destination.
5. On the **Settings** tab, enter in your Pixel ID and click **Save**.
-6. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customizing-mappings).
+6. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings).
{% include components/actions-fields.html %}
diff --git a/src/connections/destinations/catalog/actions-google-analytics-4-web/index.md b/src/connections/destinations/catalog/actions-google-analytics-4-web/index.md
index 1252047838..b76120d11a 100644
--- a/src/connections/destinations/catalog/actions-google-analytics-4-web/index.md
+++ b/src/connections/destinations/catalog/actions-google-analytics-4-web/index.md
@@ -28,7 +28,7 @@ To connect the Google Analytics 4 Web destination:
3. Click **Configure Google Analytics 4 Web**.
4. Select the web source that will send data to Google Analytics 4 and follow the steps to name your destination. The web source chosen must use [Analytics.js 2.0](/docs/connections/sources/catalog/libraries/website/javascript/). For mobile source tracking, view the [Firebase Destination](/docs/connections/destinations/catalog/firebase/).
5. On the **Settings** tab, under **Basic Settings**, enter in the [Measurement ID](https://support.google.com/analytics/answer/9539598){:target='_blank'} associated with your GA4 web stream.
-6. Set up your event mappings by following the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customizing-mappings).
+6. Set up your event mappings by following the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings).
7. Analytics.js requires an initial Page call to send data to Google Analytics 4 Web. The [Segment snippet](/docs/connections/sources/catalog/libraries/website/javascript/quickstart/#step-2-add-the-segment-snippet) includes this initial call by default.
8. For GA4 to accept events on page, enable Set Configuration Mapping triggered by the first Segment event called after analytics.load(). Set Configuration Mapping calls the gtag(‘config’) command to enable tracking to your GA4 Measurement ID.
diff --git a/src/connections/destinations/catalog/actions-google-analytics-4/index.md b/src/connections/destinations/catalog/actions-google-analytics-4/index.md
index b5def32221..56fc932513 100644
--- a/src/connections/destinations/catalog/actions-google-analytics-4/index.md
+++ b/src/connections/destinations/catalog/actions-google-analytics-4/index.md
@@ -44,7 +44,7 @@ To add the Google Analytics 4 Cloud destination:
3. Click **Configure Google Analytics 4 Cloud** in the top-right corner of the screen.
4. Select the source that will send data to Google Analytics 4 and follow the steps to name your destination.
5. On the **Settings** tab, enter in the [Measurement ID](https://support.google.com/analytics/answer/9539598){:target='_blank'} for web streams or the [Firebase App ID](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference?client_type=firebase#payload_query_parameters){:target='_blank'} for mobile streams. Next, enter in the API Secret associated with your GA4 stream and click **Save**. To create a new API Secret, navigate in the Google Analytics UI to Admin > Data Streams > choose your stream > Measurement Protocol > Create.
-6. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customizing-mappings).
+6. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings).
{% include components/actions-fields.html %}
diff --git a/src/connections/destinations/catalog/actions-google-enhanced-conversions/index.md b/src/connections/destinations/catalog/actions-google-enhanced-conversions/index.md
index 14ada365cd..96fb82a4d6 100644
--- a/src/connections/destinations/catalog/actions-google-enhanced-conversions/index.md
+++ b/src/connections/destinations/catalog/actions-google-enhanced-conversions/index.md
@@ -17,19 +17,101 @@ hide_action:
name: 'Upload Enhanced Conversion (Legacy)'
---
-The Google Ads Conversions destination enables you to upload offline conversions and conversion adjustments to Google Ads in a privacy safe way. With this server-side destination, you can upload conversions to the [Google Ads API](https://developers.google.com/google-ads/api/docs/conversions/overview){:target="_blank"} and tie them to a user's online click or phone call. In addition, you can improve the accuracy of your conversion measurement by sending conversion enhancements, restatements, and retractions.
+The Google Ads destination allows users to upload [conversions](https://developers.google.com/google-ads/api/docs/conversions/upload-clicks){:target="_blank"}, [conversion adjustments](https://developers.google.com/google-ads/api/docs/conversions/upload-adjustments){:target="_blank"}, and [customer match lists](https://developers.google.com/google-ads/api/docs/remarketing/audience-segments/customer-match/get-started){:target="_blank"} in a privacy-safe manner. Marketers can use this integration to re-engage users across Search, Shopping, Gmail, YouTube, and Display by combining conversion data with customer match lists for more effective targeting.
> info "Consent mode"
> Google enforced consent on March 6, 2024 for European Economic Area (EEA) users. Learn more about [consent mode](/docs/connections/destinations/catalog/actions-google-enhanced-conversions/#consent-mode) and how to set it up.
## Getting started
-1. From the Segment web app, click **Catalog**, then click **Destinations**.
-2. Search for “Google Ads Conversions” in the Destinations Catalog, and select the destination.
-3. Click **Configure Google Ads Conversions** in the top-right corner of the screen.
-4. Select the source that will send data to Google Ads Conversions and follow the steps to name your destination.
-5. On the **Settings** tab, enter your account-level Conversion ID and/or Customer ID and click **Save**.
-6. On the **Settings** tab, authenticate with Google using OAuth. Click **Connect to Google Ads Conversions**. Follow the prompts to authenticate using OAuth, with a Google account that is a member of your Google Ads account.
-7. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customizing-mappings).
+
+> info ""
+> You can connect the Google Ads Conversions Destination to an event source, Reverse ETL source, or Engage space.
+
+### Prerequisites
+* A Google Ads account and the account ID of your Google Ads Account. This should be 10-digits and in XXX-XXX-XXXX format.
+* For sending data to a Google [Customer Match list](https://developers.google.com/google-ads/api/docs/remarketing/audience-segments/customer-match/get-started){:target="_blank"}, you will either need
+ * An [Engage Audience](/docs/engage/audiences/) configured which you can connect to this destination
+ * A Reverse ETL source already set up. If you don’t yet have a Reverse ETL source, follow the instructions in Segment’s [Reverse ETL documentation](/docs/connections/reverse-etl/setup/).
+
+### Connect to Google Ads
+1. From the Segment web app, navigate to **Catalog > Destinations**.
+2. Search for “Google Ads Conversions” in the Destinations Catalog and select the destination.
+3. Click **Add destination**.
+4. Select the source that will send data to Google Ads Conversions.
+ * If you select an Engage space, you'll be redirected to Engage to complete the following steps.
+ * If you select a Reverse ETL source, you must enter a name for your destination and click **Create destination**.
+5. On the **Settings** tab for your Google Ads Conversions destination:
+ * Enter your account-level Conversion ID and/or Customer ID and click **Save**.
+ * Click **Connect to Google Ads Conversions** to authenticate with Google. Follow the prompts to authenticate using OAuth, with a Google account that is a member of your Google Ads account.
+7. Follow the steps in the Destinations Actions documentation to [customize your mappings](/docs/connections/destinations/actions/#customize-mappings).
+
+
+### Connect to Google Ads Customer Match lists
+
+Segment users can send data to [Google Ads Customer Match](https://developers.google.com/google-ads/api/docs/remarketing/audience-types/customer-match){:target="_blank"} lists using [Engage Audiences](#connect-engage-audiences-to-google-ads-customer-match) or [Reverse ETL](#connect-reverse-etl-to-google-ads-customer-match).
+
+#### Connect Engage Audiences to Google Ads Customer Match
+
+1. Navigate to the Engage Audience you'd like to connect to Google Ads and click **Add destination**.
+2. Select the instance of Google Ads you added to your Engage space.
+3. Complete your Audience settings.
+4. Disable **Send Identify** and enable **Send Track**.
+ _Optional_: Configure your event settings and opt in to [Trait Enrichment](/docs/engage/trait-activation/trait-enrichment/).
+6. Click **Save**.
+7. Navigate to the destination’s mappings tab and click **View all destination settings**.
+8. Navigate to the Mappings tab.
+9. Click **+ New Mapping**.
+10. Configure your mappings and use the **Show test record** preview toggle to verify your mappings.
+11. Click **Save** and enable your mapping.
+
+#### Connect Reverse ETL to Google Ads Customer Match
+
+After you’ve connected your Google Ads destination to Segment, set up [Reverse ETL mappings](/docs/connections/reverse-etl/setup/#step-4-create-mappings) to sync to a Google Customer Match List.
+
+##### Add users to your Google Customer Match User List
+1. From your Segment workspace, navigate to your Reverse ETL source.
+2. Select the Reverse ETL model you'd like to sync with Google Ads.
+3. Click **Add Mapping**.
+4. Select the Google Ads Conversions destination and click **Next**.
+5. Select the **Customer Match User List** action and the **Adds users to the connected Google Customer Match User List** sync mode.
+6. Select an existing List ID or provide a name for the list that Segment creates for you.
+7. Select an External ID Type, configure your mappings, and click **Next**.
+8. Enter a name for your mapping, set your sync schedule, and click **Save**.
+9. On the mapping's overview page, set the Status toggle to **Enabled**.
+
+##### Remove users from the connected Google Customer Match User List
+1. From your Segment workspace, navigate to your Reverse ETL source.
+2. Select the Reverse ETL model you'd like to sync with Google Ads.
+3. Click **Add Mapping**.
+4. Select the Google Ads Conversions destination and click **Next**.
+4. Select the **Customer Match User List** action and the **Remove users from the connected Google Customer Match User List** sync mode.
+5. Select the List ID that you configured when you set up the [Add users to your Google Customer Match User List](#add-users-to-your-google-customer-match-user-list) mapping.
+6. Select an External ID Type, configure your mappings, and click **Next**.
+9. Enter a name for your mapping, set your sync schedule, and click **Save**.
+10. On the mapping's overview page, set the Status toggle to **Enabled**.
+
+## Data normalization
+
+To improve match rates, Segment built in normalization and hashing for common fields to align with Google's best practices outlined in Google's [Prepare data for upload](https://developers.google.com/google-ads/api/docs/conversions/enhanced-conversions/leads#prepare-data){:target="_blank"} and [Add customer data](https://developers.google.com/google-ads/api/docs/remarketing/audience-segments/customer-match/get-started#add-user){:target="_blank"} documentation.
+
+### Normalization
+
+Segment automatically strips whitespace and converts the following fields to lowercase:
+ * Email
+ * First name
+ * Last name
+
+Segment normalizes the Phone field by removing any non-numeric symbols. Segment also converts each phone number to [E.164](https://en.wikipedia.org/wiki/E.164){:target="_blank"} format before hashing. E.164 format represents a phone number as a number up to fifteen digits in length starting with a + sign.
+
+### Hashing
+
+Google requires you to hash all PII before sending it to the Google API.
+
+Segment automatically hashes any of the following fields that are not already hashed at egress:
+ * Email
+ * Phone number
+ * First name
+ * Last name
{% include components/actions-fields.html settings="true"%}
diff --git a/src/connections/destinations/catalog/actions-hubspot-web/index.md b/src/connections/destinations/catalog/actions-hubspot-web/index.md
index 40e4dcb665..eca750f76f 100644
--- a/src/connections/destinations/catalog/actions-hubspot-web/index.md
+++ b/src/connections/destinations/catalog/actions-hubspot-web/index.md
@@ -32,7 +32,7 @@ HubSpot Web (Actions) provides the following benefits over the classic HubSpot d
3. Click **Configure HubSpot Web (Actions)**.
4. Select the web source that will send data to HubSpot Web (Actions) and follow the steps to name your destination. The web source chosen must use [Analytics.js 2.0](/docs/connections/sources/catalog/libraries/website/javascript/).
5. On the **Settings** tab, input your HubSpot Hub ID and configure the other destination settings.
-6. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customizing-mappings).
+6. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings).
7. Enable the destination and configured mappings.
{% include components/actions-fields.html settings="true"%}
diff --git a/src/connections/destinations/catalog/actions-intercom-web/index.md b/src/connections/destinations/catalog/actions-intercom-web/index.md
index bcbd869c67..f57cbbc62d 100644
--- a/src/connections/destinations/catalog/actions-intercom-web/index.md
+++ b/src/connections/destinations/catalog/actions-intercom-web/index.md
@@ -51,7 +51,7 @@ To access the Intercom Messaging Box, you'll need to configure and connect the I
3. Click **Configure Intercom Web (Actions)**.
4. Select the web source that will send data to Intercom Web (Actions) and follow the steps to name your destination. The web source chosen must use [Analytics.js 2.0](/docs/connections/sources/catalog/libraries/website/javascript/).
5. On the **Settings** tab, input your Intercom App ID and other destination settings.
-6. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customizing-mappings).
+6. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings).
7. Enable the destination and configured mappings.
> info "Regional Data Hosting in the EU and Australia"
diff --git a/src/connections/destinations/catalog/actions-pardot/index.md b/src/connections/destinations/catalog/actions-pardot/index.md
index 73d0d29705..dc312f2de8 100644
--- a/src/connections/destinations/catalog/actions-pardot/index.md
+++ b/src/connections/destinations/catalog/actions-pardot/index.md
@@ -34,7 +34,7 @@ To get started using Pardot with Segment:
4. Accept the Beta terms.
5. Select the source that will send data to Pardot (Actions) and follow the steps to name your destination.
6. On the **Settings** tab, authenticate with Salesforce Pardot using OAuth. Input the Pardot Business Unit ID associated with your Pardot Account, and click **Save**.
-7. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customizing-mappings).
+7. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings).
8. Enable the destination and configured mappings.
{% include components/actions-fields.html %}
diff --git a/src/connections/destinations/catalog/actions-salesforce-marketing-cloud/index.md b/src/connections/destinations/catalog/actions-salesforce-marketing-cloud/index.md
index 3d34244d78..18e13a6bb4 100644
--- a/src/connections/destinations/catalog/actions-salesforce-marketing-cloud/index.md
+++ b/src/connections/destinations/catalog/actions-salesforce-marketing-cloud/index.md
@@ -53,7 +53,7 @@ Once you save the API integration and add permissions, you will see a Summary pa
3. Click **Configure Salesforce Marketing Cloud (Actions)** in the top-right corner of the screen.
4. Select the source that will send data to SFMC and follow the steps to name your destination.
5. On the **Settings** tab, input your SFMC Account ID (MID). In the Installed Package you created above, locate your Subdomain, Client ID, and Client Secret and input these settings. Your Subdomain can be found under "REST Base URI." Your Subdomain should be a 28-character string starting with the letters `mc`. Do not include the `.rest.marketingcloudapis.com` part of the URL.
-6. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customizing-mappings).
+6. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings).
7. Enable the destination and configured mappings.
{% include components/actions-fields.html settings="true"%}
diff --git a/src/connections/destinations/catalog/actions-salesforce/index.md b/src/connections/destinations/catalog/actions-salesforce/index.md
index 14b99750ae..ae3e9b4ff0 100644
--- a/src/connections/destinations/catalog/actions-salesforce/index.md
+++ b/src/connections/destinations/catalog/actions-salesforce/index.md
@@ -33,7 +33,7 @@ Before you connect Segment to Salesforce, please ensure you have a Salesforce ac
3. Click **Configure Salesforce** in the top-right corner of the screen.
4. Select the source that will send data to Salesforce, follow the steps to name your destination, and select **Actions** as the destination framework.
5. On the **Settings** tab, authenticate with Salesforce using OAuth.
-6. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customizing-mappings). You must select which Event Types and/or Event Names will trigger each mapping.
+6. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings). You must select which Event Types and/or Event Names will trigger each mapping.
7. Enable the destination and configured mappings.
> info "Salesforce (Actions) authentication limitations"
diff --git a/src/connections/destinations/catalog/actions-snap-conversions/index.md b/src/connections/destinations/catalog/actions-snap-conversions/index.md
index 0ef7f67187..15b55d104a 100644
--- a/src/connections/destinations/catalog/actions-snap-conversions/index.md
+++ b/src/connections/destinations/catalog/actions-snap-conversions/index.md
@@ -24,7 +24,7 @@ The Snapchat Conversions API destination provides the following benefits:
5. On the **Settings** tab, authenticate with Snap using OAuth. Click **Connect to Snapchat Conversions API**. Follow the prompts to authenticate using OAuth, with a Snapchat login that is a member of the Snapchat Ads account you want to connect.
6. Add your [Snap Pixel ID](https://businesshelp.snapchat.com/s/article/pixel-website-install?language=en_US){:target="_blank"} *if you plan to send web or offline events*. *If you plan to send app events,* add your [Snap App ID](https://businesshelp.snapchat.com/s/article/snap-app-id?language=en_US){:target="_blank"} and App ID.
7. Enable the destination and click **Save**.
-8. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customizing-mappings).
+8. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings).
> warning ""
> To send events to Snap, you **must** add a Pixel ID for web and offline conversions or a Snap App ID and App ID for mobile conversions. If missing, events will fail.
diff --git a/src/connections/destinations/catalog/actions-sprig-web/index.md b/src/connections/destinations/catalog/actions-sprig-web/index.md
deleted file mode 100644
index 4d8f507dce..0000000000
--- a/src/connections/destinations/catalog/actions-sprig-web/index.md
+++ /dev/null
@@ -1,52 +0,0 @@
----
-# The end name should be similar to `Slack (Actions) Destination`
-title: Sprig (Actions) Destination
-hide-boilerplate: true
-hide-dossier: false
-hidden: true
----
-
-
-
-{% include content/plan-grid.md name="actions" %}
-
-[Sprig (formerly UserLeap)](https://sprig.com/?&utm_source=segmentio&utm_medium=docs_actions&utm_campaign=integration){:target="_blank"} is an in-context user research platform that makes it fast and effortless for product teams to learn from their actual customers in real-time, through microsurveys, concept tests, and video questions.
-
-Sprig maintains this destination. For any issues with the destination, consult [Sprig's documentation](https://docs.sprig.com/docs/segment-web){:target="_blank”} or contact [support@sprig.com](mailto:support@sprig.com).
-
-
-
-
-> success ""
-> **Good to know**: This page is about the [Actions-framework](/docs/connections/destinations/actions/) Sprig Segment destination. There's also a page about the [non-Actions Sprig Cloud (formerly UserLeap) destination](/docs/connections/destinations/catalog/userleap/). Both of these destinations receive data from Segment.
-
-
-
-## Benefits of Sprig (Actions) vs Sprig Classic
-
-Sprig (Actions) provides the following benefits over the classic Sprig destination:
-
-- **Trigger microsurveys**. Because Sprig (Actions) hooks into your browser-based, JavaScript Segment source, it can be used to trigger Sprig microsurveys.
-- **Code-free Sprig installation**. The Sprig (Actions) destination can install the Sprig SDK onto your website, without you having to update any code.
-
-
-
-## Getting started
-
-1. From the Segment web app, click **Catalog**, then click **Destinations**.
-2. Use the navigation on the left to locate and select Sprig (Actions).
-3. Click **Configure Sprig (Actions)**.
-4. Select an existing JavaScript website source to connect to Sprig (Actions).
-5. Find your Environment ID on [Sprig Dashboard > Connect > JavaScript](https://app.sprig.com/connect){:target="_blank"}. Use the Development Environment ID for a testing environment, and the Production Environment ID for your live website environment. When you configure the destination, input the appropriate Environment ID.
-6. Select **Quick Setup** to start with pre-populated subscriptions, or **Customized Setup** to configure each action from scratch. Click **Configure Actions** to complete setup.
-
-
-
-{% include components/actions-fields.html %}
-
-
-## Migration from the classic Sprig destination
-
-To prevent duplicate events being created in Sprig, ensure that for each Segment source, this destination and the Sprig Cloud destination are not both enabled at the same time.
-
-
diff --git a/src/connections/destinations/catalog/actions-stackadapt-cloud/index.md b/src/connections/destinations/catalog/actions-stackadapt-cloud/index.md
index d95a4ecbeb..66018f714a 100644
--- a/src/connections/destinations/catalog/actions-stackadapt-cloud/index.md
+++ b/src/connections/destinations/catalog/actions-stackadapt-cloud/index.md
@@ -3,7 +3,6 @@ title: StackAdapt Destination
hide-boilerplate: true
hide-dossier: true
id: 61d8859be4f795335d5c677c
-hidden: true
redirect_from: '/connections/destinations/catalog/actions-stackadapt/'
---
diff --git a/src/connections/destinations/catalog/bucket-web/index.md b/src/connections/destinations/catalog/bucket-web/index.md
index 160d6ef160..ca124ace94 100644
--- a/src/connections/destinations/catalog/bucket-web/index.md
+++ b/src/connections/destinations/catalog/bucket-web/index.md
@@ -1,6 +1,7 @@
---
title: 'Bucket Web (Actions) Destination'
id: 656dc9330d1863a8870bacd1
+hidden: true
versions:
- name: "Bucket (Classic)"
link: '/docs/connections/destinations/catalog/bucket'
diff --git a/src/connections/destinations/catalog/bucket/index.md b/src/connections/destinations/catalog/bucket/index.md
index bdd0cc87d3..158b8d0134 100644
--- a/src/connections/destinations/catalog/bucket/index.md
+++ b/src/connections/destinations/catalog/bucket/index.md
@@ -2,9 +2,6 @@
title: Bucket Destination
rewrite: true
id: 5fabc0b00f88248bbce4db48
-versions:
- - name: "Bucket Web (Actions)"
- link: '/docs/connections/destinations/catalog/bucket-web'
---
[Bucket](https://bucket.co/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="blank"} is feature-focused analytics. Bucket empowers software teams with a repeatable approach to shipping features that customers crave.
diff --git a/src/connections/destinations/catalog/jimo/index.md b/src/connections/destinations/catalog/jimo/index.md
index a64628ab29..630a34300b 100644
--- a/src/connections/destinations/catalog/jimo/index.md
+++ b/src/connections/destinations/catalog/jimo/index.md
@@ -1,7 +1,6 @@
---
title: Jimo Destination
id: 6294dd197382c750f0fe1e2d
-hidden: true
---
[Jimo](https://yourintegration.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="\_blank"} enables product teams to connect with end-users in any step of the product lifecycle from ideas, shaping to release, multiplying by 5 users’ engagement and loyalty over a product.
diff --git a/src/connections/destinations/catalog/tiktok-conversions/index.md b/src/connections/destinations/catalog/tiktok-conversions/index.md
index b7671dfa06..5781a88ea5 100644
--- a/src/connections/destinations/catalog/tiktok-conversions/index.md
+++ b/src/connections/destinations/catalog/tiktok-conversions/index.md
@@ -38,7 +38,7 @@ The TikTok Conversions destination is configured to use the TikTok Events API. T
3. Click **Configure TikTok Conversions**.
4. Select the source that will send data to TikTok Conversions and follow the steps to name your destination.
5. On the Settings tab, enter in your TikTok Access Token and Pixel Code and click **Save**.
-6. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customizing-mappings).
+6. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings).
{% include components/actions-fields.html %}
diff --git a/src/connections/destinations/index.md b/src/connections/destinations/index.md
index 1ecd024464..17d6a1fede 100644
--- a/src/connections/destinations/index.md
+++ b/src/connections/destinations/index.md
@@ -107,6 +107,18 @@ The first place to look is the individual destination documentation. Each one in
In order to override the default, check the destination settings pane in the Segment web App either for a **Connection Mode** toggle or instructions on bundling any additional mobile components required.
+## Sync modes
+
+Sync mode allows users to define how changes in the source should send downstream to your destination. Depending on which destinations you set up in Segment, you may need to choose a sync mode for your data. This configuration determines how Segment updates your destination based on the source data.
+
+The available sync modes can vary based on the destination, integration type, and actions within the destination. For example, if you sync customer data, you might have the option to Insert, Update, or Upsert records.
+
+Available sync modes include:
+- **Update**: Modify existing records in the destination without adding new ones.
+- **Upsert**: Update existing records and add new ones, if necessary.
+- **Add**: Add records to a list, segment, or journey.
+- **Remove**: Remove records from a list, audience, or journey.
+
## Add a destination
To add a Destination:
diff --git a/src/connections/oauth.md b/src/connections/oauth.md
index 567b921b84..219b99ea67 100644
--- a/src/connections/oauth.md
+++ b/src/connections/oauth.md
@@ -105,7 +105,7 @@ To obtain the access token:
EXP | The expiry time in seconds. This is expected to be valid only for a short duration under a minute.
JTI | The unique identifer for the token.
-2. Send a form-url-encoded `POST` request to the regional authorization server with the following parameters:
+2. Send a form-url-encoded `POST` request to the regional authorization server's `\token` route with the following parameters:
```
grant_type=client_credentials
diff --git a/src/connections/reverse-etl/index.md b/src/connections/reverse-etl/index.md
index 3088c38153..8c3ba4250e 100644
--- a/src/connections/reverse-etl/index.md
+++ b/src/connections/reverse-etl/index.md
@@ -6,14 +6,14 @@ redirect_from:
- '/reverse-etl/'
---
-Reverse ETL (Extract, Transform, Load) extracts data from a data warehouse using a query you provide and syncs the data to your third party destinations.
+Reverse ETL (Extract, Transform, Load) extracts data from a warehouse using a query you provide and syncs this warehouse data to your third party destinations.
Use Reverse ETL when you want to:
-* **Enable your marketing teams**: Sync audiences and other data built in the warehouse to Braze, Hubspot, or Salesforce Marketing Cloud for personalized marketing campaigns.
-* **Enrich your customer profiles**: Sync enriched data to Mixpanel for a more complete view of the customer, or enrich Segment Unify with data from your warehouse.
+* **Elevate marketing campaigns**: Sync audiences and other data built in the warehouse to multi-channel marketing tools, like Braze, Hubspot, or Salesforce Marketing Cloud, to personalize marketing campaigns.
+* **Enrich your customer profiles**: Sync enriched data to destinations like Mixpanel for a more complete view of the customer, or enrich Segment Profiles with data from your warehouse.
* **Activate data in Twilio Engage**: Send data in the warehouse back into Segment as events that can be activated in all supported destinations, including Twilio Engage destinations.
* **Strengthen your conversion events**: Pass offline or enriched data to conversion APIs like Facebook, Google Ads, TikTok, or Snapchat.
-* **Empower business teams**: Connect Google Sheets to a view in the warehouse to create up-to-date reports for other business teams.
+* **Make warehouse data accessible to business teams**: Connect destinations like Google Sheets to a view in the warehouse to allow business teams to access up-to-date reports.
> info "Reverse ETL supports event and object data"
> Event and object data includes customer profile data, subscriptions, product tables, shopping cart tables, and more.
@@ -26,14 +26,14 @@ Use Reverse ETL when you want to:
href="/docs/connections/reverse-etl/setup"
icon="getting-started.svg"
title="Set up Reverse ETL"
- description="Add a Reverse ETL source, set up a model, add a destination, and create mappings to transfer data from your warehouse to your downstream destinations."
+ description="Set up the infrastructure you need to sync data from your warehouse to your downstream destinations."
%}
{% include components/reference-button.html
href="/docs/connections/reverse-etl/manage-retl"
icon="reverse-etl.svg"
title="Manage Reverse ETL Syncs"
- description="View your sync history, gain insights into sync statuses, and restart or replay failed or partially successful syncs."
+ description="View your sync history, reset your syncs, or subscribe to alerts."
%}
@@ -53,7 +53,7 @@ Learn more about the system that powers Reverse ETL, supported destinations, and
{% include components/reference-button.html
href="/docs/connections/reverse-etl/reverse-etl-catalog"
title="Destination catalog"
- description="View the 30+ destinations with native Reverse ETL support and learn how to send data to the rest of the Segment catalog using Segment Connections."
+ description="View the destinations you can connect to your Reverse ETL sources."
%}
@@ -79,6 +79,6 @@ Learn more about the system that powers Reverse ETL, supported destinations, and
icon="projects.svg"
href="https://segment.com/customers/mongodb/"
title="Customer story: MongoDB"
- description="Learn how MongoDB used Reverse ETL to connect the work of analytics teams to downstream marketing and sales tools to deliver just-in-time communicates that increased customer satisfaction and engagement."
+ description="Learn how MongoDB used Reverse ETL to connect the work of analytics teams to downstream marketing and sales tools to deliver just-in-time communications that increased customer satisfaction and engagement."
%}
diff --git a/src/connections/reverse-etl/manage-retl.md b/src/connections/reverse-etl/manage-retl.md
index 63f68cd90b..33f6b96a3b 100644
--- a/src/connections/reverse-etl/manage-retl.md
+++ b/src/connections/reverse-etl/manage-retl.md
@@ -3,28 +3,19 @@ title: Manage Reverse ETL Syncs
beta: false
---
-View your sync history, gain insights into sync statuses, and restart or replay failed or partially successful syncs.
+View your sync history, reset your syncs, or subscribe to alerts.
## Sync overview
-On the Reverse ETL sync overview tab for your destination, you can see information about your recent Reverse ETL syncs at a glance, search for recent syncs, and quickly access the mappings and models that power Reverse ETL.
+The Reverse ETL sync overview tab, located under **Connections > Destinations**, gives you an overview of your latest Reverse ETL syncs.
![A screenshot of the sync overview page, which includes one failed sync and three successful syncs.](images/sync-overview.png)
You can view the following information about each sync:
-- **Latest sync**: The progress of your latest sync: syncs can either be **In progress**, **Successful**, or **Failed**. Also included is the timestamp of the sync start time.
-- **Mapping**: The named mapping that powered the sync and a hyperlink to the mapping's overview page.
-- **Model**: The name that you gave the SQL query used to withdraw information from your warehouse, with a hyperlink to the model overview page. Below the model name, you can see the warehouse source that Segment extracts information from.
-- **Action**: The Action that your destination uses to map information from your warehouse to your downstream destination.
-- **Mapping status**: The status of your mapping: either **Enabled** or **Disabled**.
-
-You can also filter the sync overview table to return only the syncs that match your criteria.
-
-You can filter for the following sync attributes:
-- **Sync status**: The status of your sync: In progress, Successful, Partially successful, or Failed.
-- **Start time**: Select a predefined time period, or create a custom date range.
-- **Model**: The model connected to your sync.
-- **Destination**: Select one or more of your connected destinations.
-- **Mapping status**: The status of your mapping: either **Enabled** or **Disabled**.
+- **Latest sync**: The status of your latest sync. Syncs can either be **In progress**, **Successful**, or **Failed**.
+- **Mapping**: The named mapping.
+- **Model**: The model that extracts data from your warehouse.
+- **Action**: The action that your destination uses to map information from your warehouse to your downstream destination.
+- **Mapping status**: The status of your mapping - either **Enabled** or **Disabled**.
## Sync history
Check the status of your data extractions and see details of your syncs. Click into failed records to view additional details on the error, sample payloads to help you debug the issue, and recommended actions.
@@ -44,7 +35,7 @@ To check the status of your extractions:
> Segment retries events for 14 days following a total or partial sync failure. Before loading the failed records on a subsequent sync, Segment checks for the latest changes in your data to ensure the data loaded into your warehouse isn't stale. If the error causing the load failure is coming from an upstream tool, you can fix the error in the upstream tool to ensure the record loads on the next sync. --->
## Reset syncs
-You can reset your syncs so that your data is synced from the beginning. This means that Segment resyncs your entire dataset for the model. During the next sync, all records extracted by the model are sent to your destination, not just the records that changed since the last sync.
+Reverse ETL uses the Unique Identifier column to detect data changes, like new, updated, and deleted records. If you encounter an error, you can reset Segment’s tracking of this column and force Segment to manually add all records from your dataset.
To reset a sync:
1. Select the three dots next to **Sync now**.
@@ -72,70 +63,3 @@ To subscribe to alerts:
> success ""
> If you opted to receive notifications by email, you can click **View active email addresses** to see the email addresses that are currently signed up to receive notifications.
-
-## Supported object and arrays
-
-When you set up destination actions in Reverse ETL, depending on the destination, some [mapping fields](/docs/connections/reverse-etl/setup/#step-4-create-mappings) may require data as an [object](/docs/connections/reverse-etl/manage-retl/#object-mapping) or [array](/docs/connections/reverse-etl/manage-retl/#array-mapping).
-
-### Object mapping
-You can send data to a mapping field that requires object data. An example of object mapping is an `Order completed` model with a `Products` column that’s in object format.
-
-Example:
-
-```json
- {
- "product": {
- "id": 0001,
- "color": "pink",
- "name": "tshirt",
- "revenue": 20,
- "inventory": 500
- }
- }
-```
-
-To send data to a mapping field that requires object data, you can choose between these two options:
-
-Option | Details
------- | --------
-Customize object | This enables you to manually set up the mapping fields with any data from the model. If the model contains some object data, you can select properties within the object to set up the mappings as well.
-Select object | This enables you to send all nested properties within an object. The model needs to provide data in the format of the object.
-
-> success ""
-> Certain object mapping fields have a fixed list of properties they can accept. If the names of the nested properties in your object don't match with the destination properties, the data won't send. Segment recommends you to use **Customize Object** to ensure your mapping is successful.
-
-
-### Array mapping
-To send data to a mapping field that requires array data, the model must provide data in the format of an array of objects. An example is an `Order completed` model with a `Product purchased` column that’s in an array format.
-
-Example:
-
-```json
- [
- {
- "currency": "USD",
- "price": 40,
- "productName": "jacket",
- "purchaseTime": "2021-12-17 23:43:47.102",
- "quantity": 1
- },
- {
- "currency": "USD",
- "price": 5,
- "productName": "socks",
- "quantity": 2
- }
- ]
-```
-
-To send data to a mapping field that requires array data, you can choose between these two options:
-
-Option | Details
------- | --------
-Customize array | This enables you to select the specific nested properties to send to the destination.
-Select array | This enables you to send all nested properties within the array.
-
-> success ""
-> Certain array mapping fields have a fixed list of properties they can accept. If the names of the nested properties in your array don't match the destination properties, the data won't send. Segment recommends you to use the **Customize array** option to ensure your mapping is successful.
-
-Objects in an array don't need to have the same properties. If a user selects a missing property in the input object for a mapping field, the output object will miss the property.
diff --git a/src/connections/reverse-etl/reverse-etl-catalog.md b/src/connections/reverse-etl/reverse-etl-catalog.md
index 0cde14d1e4..00309eb16a 100644
--- a/src/connections/reverse-etl/reverse-etl-catalog.md
+++ b/src/connections/reverse-etl/reverse-etl-catalog.md
@@ -3,7 +3,7 @@ title: Reverse ETL Catalog
beta: false
---
-Reverse ETL supports the entire Segment destination catalog - 30+ Actions destinations are natively supported and all other destinations are supported through the [Segment Connections](#segment-connections-destination) destination.
+Reverse ETL supports the Actions destinations listed in this catalog. Most destinations not listed here are supported through the [Segment Connections](#segment-connections-destination) destination.
> success ""
> Twilio Engage Premier Subscriptions users can use the [Segment Profiles](/docs/connections/destinations/catalog/actions-segment-profiles/) destination to enrich their warehouse data.
diff --git a/src/connections/reverse-etl/setup.md b/src/connections/reverse-etl/setup.md
index a2c8e89474..95dd35ac3c 100644
--- a/src/connections/reverse-etl/setup.md
+++ b/src/connections/reverse-etl/setup.md
@@ -14,7 +14,7 @@ Follow these 4 steps to set up Reverse ETL:
4. [Create mappings](#step-4-create-mappings)
## Step 1: Add a source
-A source is where your data originates from. Traditionally in Segment, a [source](/docs/connections/sources/#what-is-a-source) is a website, server library, mobile SDK, or cloud application which can send data into Segment. In Reverse ETL, your data warehouse is the source.
+In Reverse ETL, a source is your data warehouse.
> warning ""
> You need to be a user that has both read and write access to the warehouse.
@@ -24,7 +24,7 @@ To add your warehouse as a source:
1. Navigate to **Connections > Sources** and select the **Reverse ETL** tab in the Segment app.
2. Click **+ Add Reverse ETL source**.
3. Select the source you want to add.
-4. Follow the corresponding setup guide for your Reverse ETL source:
+4. Follow the corresponding guide to set up the required permissions for your Reverse ETL source:
- [Azure Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/azure-setup)
- [BigQuery Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/bigquery-setup)
- [Databricks Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/databricks-setup)
@@ -32,42 +32,28 @@ To add your warehouse as a source:
- [Redshift Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/redshift-setup)
- [Snowflake Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/snowflake-setup)
-After you add your data warehouse as a source, you can [add a model](#step-2-add-a-model) to your source.
-
## Step 2: Add a model
-Models are SQL queries that define sets of data you want to synchronize to your Reverse ETL destinations. After you add your source, you can add a model.
-
-> info "Use Segment's dbt extension to centralize model management and versioning"
-> Users who set up a BigQuery, Databricks, Postgres, Redshift, or Snowflake source can use Segment's [dbt extension](/docs/segment-app/extensions/dbt/) to centralize model management and versioning, reduce redundancies, and run CI checks to prevent breaking changes.
->
-> Extensions is currently in public beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. During Public Beta, Extensions is available for Team and Developer plans only. [Reach out to Segment](mailto:friends@segment.com) if you're on a Business Tier plan and would like to participate in the Public Beta.
+Models define sets of data you want to sync to your Reverse ETL destinations. A source can have multiple models. Segment supports [SQL models](/docs/connections/reverse-etl/setup/#step-4-create-mappings) and [dbt models](/docs/segment-app/extensions/dbt/).
-To add your first model:
+### SQL editor
1. Navigate to **Connections > Sources** and select the **Reverse ETL** tab. Select your source and click **Add Model**.
2. Click **SQL Editor** as your modeling method. (Segment will add more modeling methods in the future.)
-3. Enter the SQL query that’ll define your model. Your model is used to map data to your Reverse ETL destinations.
+3. Enter the SQL query that’ll define your model. Your model is used to map data to your Reverse ETL destination(s).
4. Choose a column to use as the unique identifier for each record in the **Unique Identifier column** field.
* The Unique Identifier should be a column with unique values per record to ensure checkpointing works as expected. It can potentially be a primary key. This column is used to detect new, updated, and deleted records.
5. Click **Preview** to see a preview of the results of your SQL query. The data from the preview is extracted from the first 10 records of your warehouse.
- * Segment caches preview queries and result sets in the UI, and stores the preview cache at the source level. If you make two queries for the same source, Segment returns identical preview results. However, during the next synchronization, the latest data will be sent to the connected destinations.
+ * Segment caches preview queries and result sets in the UI, and stores the preview cache at the source level.
6. Click **Next**.
7. Enter your **Model Name**.
8. Click **Create Model**.
-To add multiple models to your source, repeat steps 1-8 above.
-
-### Edit your model
-
-To edit your model:
-1. Navigate to **Connections > Destinations** and select the **Reverse ETL** tab.
-2. Select the source and the model you want to edit.
-3. On the overview tab, click **Edit** to edit your query.
-4. Click the **Settings** tab to edit the model name or change the schedule settings.
+### dbt model
+Use Segment's dbt extension to centralize model management and versioning. Users who set up a BigQuery, Databricks, Postgres, Redshift, or Snowflake source can use Segment's [dbt extension](/docs/segment-app/extensions/dbt/) to centralize model management and versioning, reduce redundancies, and run CI checks to prevent breaking changes.
## Step 3: Add a destination
-Once you’ve added a model, you need to add a destination. In Reverse ETL, destinations are the business tools or apps you use that Segment syncs the data from your warehouse to.
+In Reverse ETL, destinations are the business tools or apps you use that Segment syncs the data from your warehouse to. A model can have multiple destinations.
-Reverse ETL supports 30+ destinations: see all destinations listed in the [Reverse ETL catalog](/docs/connections/reverse-etl/reverse-etl-catalog/). If the destination you want to send data to is not listed in the Reverse ETL catalog, use the [Segment Connections Destination](/docs/connections/reverse-etl/reverse-etl-catalog/#segment-connections-destination) to send data from your Reverse ETL warehouse to your destination.
+Reverse ETL supports the destinations in the [Reverse ETL catalog](/docs/connections/reverse-etl/reverse-etl-catalog/). If the destination you want to send data to is not listed in the Reverse ETL catalog, use the [Segment Connections Destination](/docs/connections/reverse-etl/reverse-etl-catalog/#segment-connections-destination) to send data from your Reverse ETL warehouse to your destination.
Engage users can use the [Segment Profiles Destination](/docs/connections/destinations/catalog/actions-segment-profiles/) to create and update [Profiles](/docs/unify/) that can then be accessed through [Profile API](/docs/unify/profile-api/) and activated within [Twilio Engage](/docs/engage).
@@ -84,41 +70,127 @@ To add your first destination:
7. Navigate to the destination settings tab and enable the destination. If the destination is disabled, then Segment won't be able to start a sync.
## Step 4: Create mappings
-After you’ve added a destination, you can create mappings from your warehouse to the destination. Mappings enable you to map the data you extract from your warehouse to the fields in your destination.
+Mappings enable you to map the data you extract from your warehouse to the fields in your destination. A destination can have multiple mappings.
To create a mapping:
1. Navigate to **Connections > Destinations** and select the **Reverse ETL** tab.
2. Select the destination that you want to create a mapping for.
3. Click **Add Mapping**.
4. Select the model to sync from.
-5. Select the **Action** you want to sync and click **Next**.
- * Actions determine the information sent to the destination. The list of Actions will be unique to each destination.
-6. Add the mapping's name. The initial name will default to the Action's name (for example, 'Track Event') but is completely customizable. It will allow you to identify the mapping amongst others.
-7. In the **Select record to map and send** section, select which records to send to your destination after Segment completes extracting data based on your model. You can choose from:
- * Added records
- * Updated records
- * Added or updated records
- * Deleted records
-8. Select a test record to preview the fields that you can map to your destination in the **Add test record** field.
-9. Select the Schedule type for the times you want the model’s data to be extracted from your warehouse. You can choose from:
- * **Interval**: Extractions perform based on a selected time cycle.
+5. In the **Define sync behavior** section, select the **Action** you want to sync.
+ * Actions determine the information sent to the destination. The list of Actions are unique to each destination.
+6. Select which records to send to your destination after Segment completes extracting data based on your model.
+ * Some destinations have [sync modes](/docs/connections/destinations/#sync-modes), which let you specify how Segment should send data to the destination. Sync modes are unique to each destination.
+ * Destinations without sync modes let you select from the following options:
+ * Added records
+ * Updated records
+ * Added or updated records
+ * Deleted records
+7. In the **Map fields** section, define how to map the record columns from your model to your destination. Map the fields that come from your source to fields that the destination expects to find. Fields on the destination side depend on the type of Action selected.
+ * If you’re setting up a Destination Action, some mapping fields might require data to be in the form of an object or array. See the [supported objects and arrays for mapping](/docs/connections/reverse-etl/manage-retl/#supported-object-and-arrays) for more information.
+
+8. In the **Send test record section**, select a test record to preview the fields that you mapped to your destination. When you've verified that the records appear as expected, click **Next**.
+9. Enter a name for your mapping. The name initially defaults to the Action's name, for example, `Track Event`, but you can make changes to this default name.
+10. Select how often you want Segment to sync your data under **Schedule configuration**.
+ * **Interval**: Extractions perform based on a selected time cycle. Select one of the following options: 15 minutes, 30 minutes, 1 hour, 2 hours, 4 hours, 6 hours, 8 hours, 12 hours, 1 day.
* **Day and time**: Extractions perform at specific times on selected days of the week.
-10. Select how often you want the schedule to sync in **Schedule configuration**.
- * For an **Interval** schedule type, you can choose from: 15 minutes, 30 minutes, 1 hour, 2 hours, 4 hours, 6 hours, 8 hours, 12 hours, 1 day.
- * 15 minutes is considered real-time for warehouse syncs
- * For a **Day and time** schedule type, you can choose the day(s) you’d like the schedule to sync as well as the time.
- * You can only choose to start the extraction at the top of the hour.
- * Scheduling multiple extractions to start at the same time inside the same data warehouse causes extraction errors.
-11. Define how to map the record columns from your model to your destination in the **Select Mappings** section.
- * You map the fields that come from your source to fields that the destination expects to find. Fields on the destination side depend on the type of action selected.
- * If you're setting up a destination action, depending on the destination, some mapping fields may require data to be in the form of an object or array. See the [supported objects and arrays for mapping](/docs/connections/reverse-etl/manage-retl/#supported-object-and-arrays).
-12. *(Optional)* Send a test record to verify the mappings correctly send to your destination.
-13. Click **Create Mapping**.
-14. Select the destination you’d like to enable on the **My Destinations** page under **Reverse ETL > Destinations**.
-15. Turn the toggle on for the **Mapping Status**. Events that match the trigger condition in the mapping will be sent to the destination.
+11. Select the destination you’d like to enable on the **My Destinations** page under **Reverse ETL > Destinations**.
+12. Turn the toggle on for the **Mapping Status**. Events that match the trigger condition in the mapping will be sent to the destination.
* If you disable the mapping state to the destination, events that match the trigger condition in the mapping won’t be sent to the destination.
-To add multiple mappings from your warehouse to your destination, repeat steps 1-13 above.
+## Initial sync for a given mapping
+After you've set up your source, model, destination, and mappings for Reverse ETL, your data will extract and sync to your destination(s) right away if you chose an interval schedule. If you set your data to extract at a specific day and time, the extraction will take place then.
+
+## Edit Reverse ETL syncs
+### Edit your model
+
+To edit your model:
+1. Navigate to **Connections > Destinations** and select the **Reverse ETL** tab.
+2. Select the source and the model you want to edit.
+3. On the overview tab, click **Edit** to edit your query.
+4. Click the **Settings** tab to edit the model name or change the schedule settings.
+
+### Supported object and arrays
+
+When you set up destination actions in Reverse ETL, depending on the destination, some [mapping fields](/docs/connections/reverse-etl/setup/#step-4-create-mappings) may require data as an [object](/docs/connections/reverse-etl/manage-retl/#object-mapping) or [array](/docs/connections/reverse-etl/manage-retl/#array-mapping).
+
+#### Object mapping
+You can send data to a mapping field that requires object data. An example of object mapping is an `Order completed` model with a `Products` column that’s in object format.
+
+Example:
+
+```json
+ {
+ "product": {
+ "id": 0001,
+ "color": "pink",
+ "name": "tshirt",
+ "revenue": 20,
+ "inventory": 500
+ }
+ }
+```
+
+To send data to a mapping field that requires object data, you can choose between these two options:
+
+Option | Details
+------ | --------
+Customize object | This enables you to manually set up the mapping fields with any data from the model. If the model contains some object data, you can select properties within the object to set up the mappings as well.
+Select object | This enables you to send all nested properties within an object. The model needs to provide data in the format of the object.
+
+> success ""
+> Certain object mapping fields have a fixed list of properties they can accept. If the names of the nested properties in your object don't match with the destination properties, the data won't send. Segment recommends you to use **Customize Object** to ensure your mapping is successful.
+
+
+#### Array mapping
+To send data to a mapping field that requires array data, the model must provide data in the format of an array of objects. An example is an `Order completed` model with a `Product purchased` column that’s in an array format.
+
+Example:
+
+```json
+ [
+ {
+ "currency": "USD",
+ "price": 40,
+ "productName": "jacket",
+ "purchaseTime": "2021-12-17 23:43:47.102",
+ "quantity": 1
+ },
+ {
+ "currency": "USD",
+ "price": 5,
+ "productName": "socks",
+ "quantity": 2
+ }
+ ]
+```
+
+To send data to a mapping field that requires array data, you can choose between these two options:
+
+Option | Details
+------ | --------
+Customize array | This enables you to select the specific nested properties to send to the destination.
+Select array | This enables you to send all nested properties within the array.
+
+> success ""
+> Certain array mapping fields have a fixed list of properties they can accept. If the names of the nested properties in your array don't match the destination properties, the data won't send. Segment recommends you to use the **Customize array** option to ensure your mapping is successful.
+
+Objects in an array don't need to have the same properties. If a user selects a missing property in the input object for a mapping field, the output object will miss the property.
+
+### Null value management
+You can choose to exclude null values from optional mapping fields in your syncs to some destinations. Excluding null values helps you maintain data integrity in your downstream destinations, as syncing a null value for an optional field may overwrite an existing value in your downstream tool.
+
+For example, if you opt to sync null values with your destination and an end user fills out a form but chooses to leave an optional telephone number field blank, the existing telephone number you have on file in your destination could be overwritten with the null value. By opting out of null values for your downstream destination, you would preserve the existing telephone number in your destination.
+
+By default, Segment syncs null values from mapped fields to your downstream destinations. Some destinations do not allow the syncing of null values, and will reject requests that contain them. Segment disables the option to opt out of syncing null values for these destinations.
+
+To opt out of including null values in your downstream syncs:
+1. Navigate to Connections > Destinations and select the Reverse ETL tab.
+2. Select the destination and the mapping you want to edit.
+3. Click Edit mapping.
+4. Under **Optional fields**, select the field you want to edit.
+5. In the field dropdown selection, disable the **Sync null values** toggle.
+
### Edit your mapping
@@ -126,6 +198,3 @@ To edit your mapping:
1. Navigate to **Connections > Destinations** and select the **Reverse ETL** tab.
2. Select the destination and the mapping you want to edit.
3. Select the **...** three dots and click **Edit mapping**. If you want to delete your mapping, select **Delete**.
-
-## Using Reverse ETL
-After you've set up your source, model, destination, and mappings for Reverse ETL, your data will extract and sync to your destination(s) right away if you chose an interval schedule. If you set your data to extract at a specific day and time, the extraction will take place then.
\ No newline at end of file
diff --git a/src/connections/reverse-etl/system.md b/src/connections/reverse-etl/system.md
index faf35fbe0c..0dba30f9d0 100644
--- a/src/connections/reverse-etl/system.md
+++ b/src/connections/reverse-etl/system.md
@@ -48,8 +48,12 @@ The extract phase is the time spent connecting to your database, executing the m
Name | Details | Limit
----- | ------- | ------
-Record count | The maximum number of records a single sync will process. Note: This is the number of records extracted from the warehouse not the limit for the number of records loaded to the destination (for example, new/update/deleted). | 30 million records
+Record count | The maximum number of records a single sync will process. If a sync would contain more than 150 million records, Segment separates the data into multiple syncs, each containing no more than 150 million records
Note: This is the number of records extracted from the warehouse, not the limit for the number of records loaded to the destination (for example, new/update/deleted). | *150 million records
Column count | The maximum number of columns a single sync will process. | 512 columns
Column name length | The maximum length of a record column. | 128 characters
Record JSON size | The maximum size for a record when converted to JSON (some of this limit is used by Segment). | 512 KiB
Column JSON size | The maximum size of any single column value. | 128 KiB
+
+*: _If Segment identifies a sync would be larger than 150 million records, Segment extracts 150 million of the records in the initial sync and syncs any additional records during the next scheduled or manual sync._
+
+_For example, if a sync would contain 700 million records, Segment would run an initial 150 million record sync, and during the next three scheduled or manual syncs, would sync 150 million records. The fifth scheduled or manual sync would contain the remaining 100 million records._
\ No newline at end of file
diff --git a/src/connections/sources/catalog/libraries/mobile/apple/destination-plugins/amplitude-swift.md b/src/connections/sources/catalog/libraries/mobile/apple/destination-plugins/amplitude-swift.md
index 291c2366b6..91f3e099b4 100644
--- a/src/connections/sources/catalog/libraries/mobile/apple/destination-plugins/amplitude-swift.md
+++ b/src/connections/sources/catalog/libraries/mobile/apple/destination-plugins/amplitude-swift.md
@@ -13,7 +13,7 @@ strat: swift
4. Click the "Amplitude" item to select it and click **Configure**.
5. Choose which of your sources to connect the destination to. (You can connect more sources to the destination later.)
-Once you have a mapping, you can follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customizing-mappings).
+Once you have a mapping, you can follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings).
The Amplitude Swift plugin doesn't send events to Amplitude from the client side. It instead adds Amplitude session data and then sends it server side from the Amplitude Actions destination.
diff --git a/src/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/amplitude-kotlin-android.md b/src/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/amplitude-kotlin-android.md
index cc791696d6..2ae13db570 100644
--- a/src/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/amplitude-kotlin-android.md
+++ b/src/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/amplitude-kotlin-android.md
@@ -14,7 +14,7 @@ perform, you can gain a better understanding to drive retention, engagement, and
4. Click the "Amplitude" item to select it and click **Configure**.
5. Choose which of your sources to connect the destination to. (You can connect more sources to the destination later.)
-Once you have a mapping, you can follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customizing-mappings).
+Once you have a mapping, you can follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings).
The Amplitude Kotlin plugin doesn't send events to Amplitude from the client side. It instead adds Amplitude session data and then sends it server side from the Amplitude Actions destination.
diff --git a/src/connections/sources/catalog/libraries/mobile/react-native/destination-plugins/amplitude-react-native.md b/src/connections/sources/catalog/libraries/mobile/react-native/destination-plugins/amplitude-react-native.md
index 0b53e0b2ad..092a8faa86 100644
--- a/src/connections/sources/catalog/libraries/mobile/react-native/destination-plugins/amplitude-react-native.md
+++ b/src/connections/sources/catalog/libraries/mobile/react-native/destination-plugins/amplitude-react-native.md
@@ -13,7 +13,7 @@ strat: react-native
4. Click the "Amplitude" item to select it and click **Configure**.
5. Choose which of your sources to connect the destination to. (You can connect more sources to the destination later.)
-Once you have a mapping, you can follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customizing-mappings).
+Once you have a mapping, you can follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/customize-mappings).
The Amplitude React Native plugin doesn't send events to Amplitude from the client side. It instead adds Amplitude session data and then sends it server side from the Amplitude Actions destination.
diff --git a/src/connections/sources/catalog/libraries/server/python/index.md b/src/connections/sources/catalog/libraries/server/python/index.md
index 8e00f08b37..8e7b9590af 100644
--- a/src/connections/sources/catalog/libraries/server/python/index.md
+++ b/src/connections/sources/catalog/libraries/server/python/index.md
@@ -404,9 +404,9 @@ There is a maximum of `500KB` per batch request and `32KB` per call.
If the module detects that it can't flush faster than it's receiving messages, it'll simply stop accepting messages. This means your program will never crash because of a backed up analytics queue. The default `max_queue_size` is `10000`.
-### How do I flush right now?!
+### Flush
-You can also flush on demand. For example, at the end of your program, you'll want to flush to make sure there's nothing left in the queue. Just call the `flush` method:
+You can call the `flush` method at the end of your program to make sure there's nothing left in the queue:
```python
analytics.flush()
diff --git a/src/connections/sources/catalog/libraries/website/javascript/troubleshooting.md b/src/connections/sources/catalog/libraries/website/javascript/troubleshooting.md
index a0364afa82..2f6cb74cfc 100644
--- a/src/connections/sources/catalog/libraries/website/javascript/troubleshooting.md
+++ b/src/connections/sources/catalog/libraries/website/javascript/troubleshooting.md
@@ -30,6 +30,18 @@ var writeKey;
ENV === 'production' ? writeKey = 'A' : writeKey = 'B';
```
+## How do I resolve the 'Failed to Load Analytics.js ChunkLoadError'?
+
+The error can occur for different reasons:
+
+* Snippet syntax: Ensure you correctly added the Segment snippet to the page. Check for any missing or extra characters. Follow [this guide](/docs/connections/sources/catalog/libraries/website/javascript/quickstart/#step-2-install-segment-to-your-site).
+
+* NPM package: If you're using Segment through NPM, refer to [this guide](/docs/connections/sources/catalog/libraries/website/javascript/quickstart/#step-2b-install-segment-as-a-npm-package).
+
+* Browser cache: Clear the browser cache, as this is a common cause for `ChunkLoadError`.
+
+* Cloudflare caching: If you use Cloudflare to proxy Segment, disable caching for the Segment JS file.
+
## Do you see events appear in your debugger?
When you reload the page, does your debugger show a new [`page`](/docs/connections/spec/page)? You can also check the JavaScript console in the browser and manually fire an event, like an Identify call, which would show up in the debugger.
diff --git a/src/connections/storage/data-lakes/data-lakes-manual-setup.md b/src/connections/storage/data-lakes/data-lakes-manual-setup.md
index 70b741e2b8..cba3a03216 100644
--- a/src/connections/storage/data-lakes/data-lakes-manual-setup.md
+++ b/src/connections/storage/data-lakes/data-lakes-manual-setup.md
@@ -138,6 +138,7 @@ Add a policy to the role created above to give Segment access to the relevant Gl
"elasticmapreduce:DescribeCluster",
"elasticmapreduce:CancelSteps",
"elasticmapreduce:AddJobFlowSteps"
+ "elasticmapredue:AddTags"
],
"Effect": "Allow",
"Resource": "*",
diff --git a/src/privacy/faq.md b/src/privacy/faq.md
index 4ec5c9535d..760492fb7a 100644
--- a/src/privacy/faq.md
+++ b/src/privacy/faq.md
@@ -79,5 +79,6 @@ Segment supports the following regulation types:
- **DELETE_INTERNAL**: Deletes user data from within Segment archives only and not from any connected destinations.
- **DELETE_ONLY**: Deletes user data from Segment and your connected warehouses. Also sends a deletion request to your downstream destinations.
-> info ""
+
+> info ""
> Using **SUPPRESS_WITH_DELETE** or **DELETE_ONLY** regulation types might lead to additional charges levied by your destination providers.
diff --git a/src/privacy/user-deletion-and-suppression.md b/src/privacy/user-deletion-and-suppression.md
index 0a398f11e9..9e5bf66caf 100644
--- a/src/privacy/user-deletion-and-suppression.md
+++ b/src/privacy/user-deletion-and-suppression.md
@@ -31,7 +31,8 @@ The following regulation types are available:
- **SUPPRESS_WITH_DELETE_INTERNAL:** Suppress new data and delete from Segment internals only
- **DELETE_ONLY:** Delete existing data without suppressing any new data
-> info ""
+
+> info ""
> Using **SUPPRESS_WITH_DELETE** or **DELETE_ONLY** regulation types might lead to additional charges levied by your destination providers.
## Suppression Support and the Right to Revoke Consent