diff --git a/src/_data/catalog/destination_categories.yml b/src/_data/catalog/destination_categories.yml
index 441c6386a3..f55528453a 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-01-25
+# destination categories last updated 2024-01-30
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 b7c28d152d..fdc52f60b4 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-01-25
+# destination data last updated 2024-01-30
items:
- id: 637e8d185e2dec264895ea89
display_name: 1Flow
@@ -1417,6 +1417,106 @@ items:
choices: null
dynamic: false
allowNull: false
+ - id: uVzPR9SSpfLqF3zoPok99Q
+ name: Create or Update Organization
+ slug: createUpdateOrganization
+ description: Update an organization in Pipedrive or create it if it doesn't exist yet.
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: type = "group"
+ fields:
+ - id: nznNWZoW5kvUSGCnBDLYBS
+ sortOrder: 0
+ fieldKey: match_field
+ label: Match field
+ type: STRING
+ description: >-
+ If present, used instead of field in settings to find existing
+ organization in Pipedrive.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: true
+ allowNull: false
+ - id: 4c5Cx3sWr8dVVS3EhwU1tP
+ sortOrder: 1
+ fieldKey: match_value
+ label: Match value
+ type: STRING
+ description: Value to find existing organization by
+ placeholder: ''
+ defaultValue:
+ '@path': $.groupId
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: iSrMkR6BhxVK4VdAtaQHBX
+ sortOrder: 2
+ fieldKey: name
+ label: Organization Name
+ type: STRING
+ description: Name of the organization
+ placeholder: ''
+ defaultValue:
+ '@path': $.traits.name
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: scPNjZXULsdZbuEqzDT2FU
+ sortOrder: 3
+ fieldKey: visible_to
+ label: Visible To
+ type: STRING
+ description: >-
+ Visibility of the Organization. If omitted, visibility will be set to
+ the default visibility setting of this item type for the authorized
+ user. 'Owner's visibility group and sub-groups' and 'Entire company'
+ options only available with Professional or Enterprise plans
+ placeholder: ''
+ required: false
+ multiple: false
+ choices:
+ - label: Owner & followers (private)
+ value: '1'
+ - label: Entire company (shared)
+ value: '3'
+ - label: Owner's visibility group and sub-groups
+ value: '5'
+ - label: Entire company
+ value: '7'
+ dynamic: false
+ allowNull: false
+ - id: fNVTV988tHJWVp7PvgNenj
+ sortOrder: 4
+ fieldKey: add_time
+ label: Created At
+ type: DATETIME
+ description: >-
+ If the organization is created, use this timestamp as the creation
+ timestamp. Format: YYY-MM-DD HH:MM:SS
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: aZBoKiJV7JAhgUPYKKXe36
+ sortOrder: 5
+ fieldKey: custom_fields
+ label: Custom fields
+ type: OBJECT
+ description: New values for custom fields.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
- id: dGDsZPqKXXCQNrgDcr1oKb
name: Create or update an Activity
slug: createUpdateActivity
@@ -2263,106 +2363,6 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: uVzPR9SSpfLqF3zoPok99Q
- name: Create or Update Organization
- slug: createUpdateOrganization
- description: Update an organization in Pipedrive or create it if it doesn't exist yet.
- platform: CLOUD
- hidden: false
- defaultTrigger: type = "group"
- fields:
- - id: nznNWZoW5kvUSGCnBDLYBS
- sortOrder: 0
- fieldKey: match_field
- label: Match field
- type: STRING
- description: >-
- If present, used instead of field in settings to find existing
- organization in Pipedrive.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: true
- allowNull: false
- - id: 4c5Cx3sWr8dVVS3EhwU1tP
- sortOrder: 1
- fieldKey: match_value
- label: Match value
- type: STRING
- description: Value to find existing organization by
- placeholder: ''
- defaultValue:
- '@path': $.groupId
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: iSrMkR6BhxVK4VdAtaQHBX
- sortOrder: 2
- fieldKey: name
- label: Organization Name
- type: STRING
- description: Name of the organization
- placeholder: ''
- defaultValue:
- '@path': $.traits.name
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: scPNjZXULsdZbuEqzDT2FU
- sortOrder: 3
- fieldKey: visible_to
- label: Visible To
- type: STRING
- description: >-
- Visibility of the Organization. If omitted, visibility will be set to
- the default visibility setting of this item type for the authorized
- user. 'Owner's visibility group and sub-groups' and 'Entire company'
- options only available with Professional or Enterprise plans
- placeholder: ''
- required: false
- multiple: false
- choices:
- - label: Owner & followers (private)
- value: '1'
- - label: Entire company (shared)
- value: '3'
- - label: Owner's visibility group and sub-groups
- value: '5'
- - label: Entire company
- value: '7'
- dynamic: false
- allowNull: false
- - id: fNVTV988tHJWVp7PvgNenj
- sortOrder: 4
- fieldKey: add_time
- label: Created At
- type: DATETIME
- description: >-
- If the organization is created, use this timestamp as the creation
- timestamp. Format: YYY-MM-DD HH:MM:SS
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: aZBoKiJV7JAhgUPYKKXe36
- sortOrder: 5
- fieldKey: custom_fields
- label: Custom fields
- type: OBJECT
- description: New values for custom fields.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
presets:
- actionId: dGDsZPqKXXCQNrgDcr1oKb
name: Create or Update an Activity
@@ -3318,81 +3318,6 @@ items:
required: true
label: ATJS Version
actions:
- - id: 243uULZreXS5yYFvMBm4NW
- name: Trigger View
- slug: triggerView
- description: Send page-level data to Adobe Target.
- platform: WEB
- hidden: false
- defaultTrigger: type = "page"
- fields:
- - id: 2RpiJTMb1TNDJhq7evLyXS
- sortOrder: 0
- fieldKey: viewName
- label: View Name
- type: STRING
- description: Name of the view or page.
- placeholder: ''
- defaultValue:
- '@path': $.name
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: fDC4U3RD1VHQsW2nauiQrA
- sortOrder: 1
- fieldKey: pageParameters
- label: Page Parameters
- type: OBJECT
- description: Parameters specific to the view or page.
- placeholder: ''
- defaultValue:
- '@path': $.properties
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: tDmLN2mguNCvHdcyu6VPCk
- sortOrder: 2
- fieldKey: sendNotification
- label: Send Notifications to Adobe Target.
- type: BOOLEAN
- description: >-
- By default, notifications are sent to the Adobe Target backend for
- incrementing impression count. If false, notifications are not sent for
- incrementing impression count.
- placeholder: ''
- defaultValue: true
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: cEhLsbMFjmvjJp9KbKnaHC
- sortOrder: 3
- fieldKey: userId
- label: Mbox 3rd Party ID
- type: STRING
- description: >-
- A user’s unique visitor ID. Setting an Mbox 3rd Party ID allows for
- updates via the Adobe Target Cloud Mode Destination. For more
- information, please see our Adobe Target Destination documentation.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.userId
- then:
- '@path': $.userId
- else:
- '@path': $.anonymousId
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- id: 6Koj6XjcBpQUfjQ25sAdG3
name: Upsert Profile
slug: upsertProfile
@@ -3438,6 +3363,81 @@ items:
choices: null
dynamic: false
allowNull: false
+ - id: 243uULZreXS5yYFvMBm4NW
+ name: Trigger View
+ slug: triggerView
+ description: Send page-level data to Adobe Target.
+ platform: WEB
+ hidden: false
+ defaultTrigger: type = "page"
+ fields:
+ - id: 2RpiJTMb1TNDJhq7evLyXS
+ sortOrder: 0
+ fieldKey: viewName
+ label: View Name
+ type: STRING
+ description: Name of the view or page.
+ placeholder: ''
+ defaultValue:
+ '@path': $.name
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: fDC4U3RD1VHQsW2nauiQrA
+ sortOrder: 1
+ fieldKey: pageParameters
+ label: Page Parameters
+ type: OBJECT
+ description: Parameters specific to the view or page.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: tDmLN2mguNCvHdcyu6VPCk
+ sortOrder: 2
+ fieldKey: sendNotification
+ label: Send Notifications to Adobe Target.
+ type: BOOLEAN
+ description: >-
+ By default, notifications are sent to the Adobe Target backend for
+ incrementing impression count. If false, notifications are not sent for
+ incrementing impression count.
+ placeholder: ''
+ defaultValue: true
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: cEhLsbMFjmvjJp9KbKnaHC
+ sortOrder: 3
+ fieldKey: userId
+ label: Mbox 3rd Party ID
+ type: STRING
+ description: >-
+ A user’s unique visitor ID. Setting an Mbox 3rd Party ID allows for
+ updates via the Adobe Target Cloud Mode Destination. For more
+ information, please see our Adobe Target Destination documentation.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.userId
+ then:
+ '@path': $.userId
+ else:
+ '@path': $.anonymousId
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
- id: iRgHnBnvnsa7vFSvCeyvmY
name: Track Event
slug: trackEvent
@@ -3740,7 +3740,7 @@ items:
- Raw Data
- Analytics
logo:
- url: https://cdn-devcenter.segment.com/886284de-022d-434b-8e45-b054964c7479.svg
+ url: https://cdn-devcenter.segment.com/8012932e-eaa6-4224-b4ab-e48a5a815f93.svg
mark:
url: https://cdn-devcenter.segment.com/b106e36f-d5e8-4307-8174-ac3c5ad432f5.svg
methods:
@@ -4117,6 +4117,107 @@ items:
choices: null
dynamic: false
allowNull: false
+ - id: tx1U1iQjRFNAXgmfLWwEpi
+ name: Set Attributes
+ slug: setAttributes
+ description: >-
+ Set user attributes in Airship with data from Segment. Some common user
+ attributes are predefined in the attributes field, however note that all
+ must be created in Airship before use. More information here:
+ https://docs.airship.com/guides/messaging/user-guide/audience/segmentation/attributes/project/#adding-attributes
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: type = "identify"
+ fields:
+ - id: diid9CFKzZbQRmd7Tod5DE
+ sortOrder: 0
+ fieldKey: named_user_id
+ label: Airship Named User ID
+ type: STRING
+ description: The identifier assigned in Airship as the Named User
+ placeholder: ''
+ defaultValue:
+ '@path': $.userId
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: te5V7Y5SRNLJFQzuL4eXfA
+ sortOrder: 1
+ fieldKey: occurred
+ label: Occurred
+ type: DATETIME
+ description: When the Trait was set
+ placeholder: ''
+ defaultValue:
+ '@path': $.timestamp
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: sPbn8P2hyM1cQUSHb5uF1q
+ sortOrder: 2
+ fieldKey: attributes
+ label: Attributes
+ type: OBJECT
+ description: >-
+ User Attributes. Attributes should exist in Airship in order to be set,
+ including the predifined ones defaulted here.
+ placeholder: ''
+ defaultValue:
+ title:
+ '@path': $.traits.title
+ first_name:
+ '@path': $.traits.first_name
+ last_name:
+ '@path': $.traits.last_name
+ full_name:
+ '@path': $.traits.full_name
+ gender:
+ '@path': $.traits.gender
+ zipcode:
+ '@path': $.traits.address.postalCode
+ city:
+ '@path': $.traits.address.city
+ region:
+ '@path': $.traits.address.region
+ country:
+ '@path': $.traits.address.country
+ birthdate:
+ '@path': $.traits.birthday
+ age:
+ '@path': $.traits.age
+ mobile_phone:
+ '@path': $.traits.phone
+ home_phone:
+ '@path': $.traits.home_phone
+ work_phone:
+ '@path': $.traits.work_phone
+ loyalty_tier:
+ '@path': $.traits.loyalty_tier
+ company:
+ '@path': $.traits.company_name
+ username:
+ '@path': $.traits.username
+ account_creation:
+ '@path': $.traits.account_creation
+ email:
+ '@path': $.traits.email
+ altitude:
+ '@path': $.traits.altitude
+ latitude:
+ '@path': $.traits.latitude
+ longitude:
+ '@path': $.traits.longitude
+ advertising_id:
+ '@path': $.context.device.advertisingId
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
- id: pSRMTY1CEMfvuNeRVVqatk
name: Register And Associate
slug: registerAndAssociate
@@ -4254,107 +4355,6 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: tx1U1iQjRFNAXgmfLWwEpi
- name: Set Attributes
- slug: setAttributes
- description: >-
- Set user attributes in Airship with data from Segment. Some common user
- attributes are predefined in the attributes field, however note that all
- must be created in Airship before use. More information here:
- https://docs.airship.com/guides/messaging/user-guide/audience/segmentation/attributes/project/#adding-attributes
- platform: CLOUD
- hidden: false
- defaultTrigger: type = "identify"
- fields:
- - id: diid9CFKzZbQRmd7Tod5DE
- sortOrder: 0
- fieldKey: named_user_id
- label: Airship Named User ID
- type: STRING
- description: The identifier assigned in Airship as the Named User
- placeholder: ''
- defaultValue:
- '@path': $.userId
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: te5V7Y5SRNLJFQzuL4eXfA
- sortOrder: 1
- fieldKey: occurred
- label: Occurred
- type: DATETIME
- description: When the Trait was set
- placeholder: ''
- defaultValue:
- '@path': $.timestamp
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: sPbn8P2hyM1cQUSHb5uF1q
- sortOrder: 2
- fieldKey: attributes
- label: Attributes
- type: OBJECT
- description: >-
- User Attributes. Attributes should exist in Airship in order to be set,
- including the predifined ones defaulted here.
- placeholder: ''
- defaultValue:
- title:
- '@path': $.traits.title
- first_name:
- '@path': $.traits.first_name
- last_name:
- '@path': $.traits.last_name
- full_name:
- '@path': $.traits.full_name
- gender:
- '@path': $.traits.gender
- zipcode:
- '@path': $.traits.address.postalCode
- city:
- '@path': $.traits.address.city
- region:
- '@path': $.traits.address.region
- country:
- '@path': $.traits.address.country
- birthdate:
- '@path': $.traits.birthday
- age:
- '@path': $.traits.age
- mobile_phone:
- '@path': $.traits.phone
- home_phone:
- '@path': $.traits.home_phone
- work_phone:
- '@path': $.traits.work_phone
- loyalty_tier:
- '@path': $.traits.loyalty_tier
- company:
- '@path': $.traits.company_name
- username:
- '@path': $.traits.username
- account_creation:
- '@path': $.traits.account_creation
- email:
- '@path': $.traits.email
- altitude:
- '@path': $.traits.altitude
- latitude:
- '@path': $.traits.latitude
- longitude:
- '@path': $.traits.longitude
- advertising_id:
- '@path': $.context.device.advertisingId
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
presets:
- actionId: eNkhQGgqJHnQg5vuAHXmQY
name: Custom Events
@@ -4913,37 +4913,33 @@ items:
value: click
dynamic: false
allowNull: false
- - id: amxZNcsLHjUhJTRP5YHwaE
- name: Product List Filtered Events
- slug: productListFilteredEvents
- description: When a product list is filtered within an Algolia Search
+ - id: etbKXm8QsQyQAo83znMszn
+ name: Product Clicked Events
+ slug: productClickedEvents
+ description: >-
+ When a product is clicked within an Algolia Search, Recommend or Predict
+ result
platform: CLOUD
hidden: false
- defaultTrigger: type = "track" and event = "Product List Filtered"
+ defaultTrigger: type = "track" and event = "Product Clicked"
fields:
- - id: ccgRk8zXUY9V6jy6ZLiYGh
+ - id: asEUjD7eLhtLFG3sCRcc5L
sortOrder: 0
- fieldKey: filters
- label: Filters
- type: OBJECT
+ fieldKey: objectID
+ label: Product ID
+ type: STRING
description: >-
- Populates the filters field in the Algolia Insights API, a list of up to
- 10 facet filters. Field should be an array of strings with format
- ${attribute}:${value}.
+ Populates the ObjectIds field in the Algolia Insights API. Product ID of
+ the clicked item.
placeholder: ''
defaultValue:
- '@arrayPath':
- - $.properties.filters
- - attribute:
- '@path': $.attribute
- value:
- '@path': $.value
+ '@path': $.properties.product_id
required: true
- multiple: true
+ multiple: false
choices: null
dynamic: false
allowNull: false
- - id: qVSDrHCBVk3Zs3zBpH3RKu
+ - id: rBw4EiVN8onoT5YZYVuzWo
sortOrder: 1
fieldKey: index
label: Index
@@ -4957,7 +4953,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 6j9ZSUEPubgGvJqUem24J2
+ - id: bxD97Qz5TFQHXKAH1fae6H
sortOrder: 2
fieldKey: queryID
label: Query ID
@@ -4977,8 +4973,22 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 5R3qCkyD4GdJom9iYJurx2
+ - id: KwSqxPyNkErNsJifmJMwz
sortOrder: 3
+ fieldKey: position
+ label: Position
+ type: INTEGER
+ description: Position of the click in the list of Algolia search results.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.position
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: oRMJcsiUjZugaiqYSkNEtU
+ sortOrder: 4
fieldKey: userToken
label: userToken
type: STRING
@@ -4997,8 +5007,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 9mDJTwsNP93iMQ2633rgVf
- sortOrder: 4
+ - id: q9ZnvR1rCRaZULmu8sgaiT
+ sortOrder: 5
fieldKey: timestamp
label: timestamp
type: STRING
@@ -5011,8 +5021,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 6oHpBVj2MXnY71TvVYsjGo
- sortOrder: 5
+ - id: cPWccWCLBY4qnXRmy5YyMU
+ sortOrder: 6
fieldKey: extraProperties
label: extraProperties
type: OBJECT
@@ -5027,23 +5037,23 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: jtyYKKEoFaGhgUZpFnmmC7
- sortOrder: 6
+ - id: p8WPZUHB9zFzgHqUKmEFb2
+ sortOrder: 7
fieldKey: eventName
label: Event Name
type: STRING
description: >-
- The name of the event to be send to Algolia. Defaults to 'Product List
- Filtered'
+ The name of the event to be send to Algolia. Defaults to 'Product
+ Clicked'
placeholder: ''
- defaultValue: Product List Filtered
+ defaultValue: Product Clicked
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: ribMbuwGThWcV1UtmcEoYX
- sortOrder: 7
+ - id: qyBbnF6YfqYjdyFy7GiNdt
+ sortOrder: 8
fieldKey: eventType
label: Event Type
type: STRING
@@ -5061,33 +5071,37 @@ items:
value: click
dynamic: false
allowNull: false
- - id: etbKXm8QsQyQAo83znMszn
- name: Product Clicked Events
- slug: productClickedEvents
- description: >-
- When a product is clicked within an Algolia Search, Recommend or Predict
- result
+ - id: amxZNcsLHjUhJTRP5YHwaE
+ name: Product List Filtered Events
+ slug: productListFilteredEvents
+ description: When a product list is filtered within an Algolia Search
platform: CLOUD
hidden: false
- defaultTrigger: type = "track" and event = "Product Clicked"
+ defaultTrigger: type = "track" and event = "Product List Filtered"
fields:
- - id: asEUjD7eLhtLFG3sCRcc5L
+ - id: ccgRk8zXUY9V6jy6ZLiYGh
sortOrder: 0
- fieldKey: objectID
- label: Product ID
- type: STRING
+ fieldKey: filters
+ label: Filters
+ type: OBJECT
description: >-
- Populates the ObjectIds field in the Algolia Insights API. Product ID of
- the clicked item.
+ Populates the filters field in the Algolia Insights API, a list of up to
+ 10 facet filters. Field should be an array of strings with format
+ ${attribute}:${value}.
placeholder: ''
defaultValue:
- '@path': $.properties.product_id
+ '@arrayPath':
+ - $.properties.filters
+ - attribute:
+ '@path': $.attribute
+ value:
+ '@path': $.value
required: true
- multiple: false
+ multiple: true
choices: null
dynamic: false
allowNull: false
- - id: rBw4EiVN8onoT5YZYVuzWo
+ - id: qVSDrHCBVk3Zs3zBpH3RKu
sortOrder: 1
fieldKey: index
label: Index
@@ -5101,7 +5115,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: bxD97Qz5TFQHXKAH1fae6H
+ - id: 6j9ZSUEPubgGvJqUem24J2
sortOrder: 2
fieldKey: queryID
label: Query ID
@@ -5121,22 +5135,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: KwSqxPyNkErNsJifmJMwz
+ - id: 5R3qCkyD4GdJom9iYJurx2
sortOrder: 3
- fieldKey: position
- label: Position
- type: INTEGER
- description: Position of the click in the list of Algolia search results.
- placeholder: ''
- defaultValue:
- '@path': $.properties.position
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: oRMJcsiUjZugaiqYSkNEtU
- sortOrder: 4
fieldKey: userToken
label: userToken
type: STRING
@@ -5155,8 +5155,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: q9ZnvR1rCRaZULmu8sgaiT
- sortOrder: 5
+ - id: 9mDJTwsNP93iMQ2633rgVf
+ sortOrder: 4
fieldKey: timestamp
label: timestamp
type: STRING
@@ -5169,8 +5169,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: cPWccWCLBY4qnXRmy5YyMU
- sortOrder: 6
+ - id: 6oHpBVj2MXnY71TvVYsjGo
+ sortOrder: 5
fieldKey: extraProperties
label: extraProperties
type: OBJECT
@@ -5185,23 +5185,23 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: p8WPZUHB9zFzgHqUKmEFb2
- sortOrder: 7
+ - id: jtyYKKEoFaGhgUZpFnmmC7
+ sortOrder: 6
fieldKey: eventName
label: Event Name
type: STRING
description: >-
- The name of the event to be send to Algolia. Defaults to 'Product
- Clicked'
+ The name of the event to be send to Algolia. Defaults to 'Product List
+ Filtered'
placeholder: ''
- defaultValue: Product Clicked
+ defaultValue: Product List Filtered
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: qyBbnF6YfqYjdyFy7GiNdt
- sortOrder: 8
+ - id: ribMbuwGThWcV1UtmcEoYX
+ sortOrder: 7
fieldKey: eventType
label: Event Type
type: STRING
@@ -7147,31 +7147,16 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: cRSyn3B292uKfxrpKwHRDY
- name: Log Purchase
- slug: logPurchase
+ - id: gA673j6ij2yCB8n9Fztpj9
+ name: Log Event
+ slug: logEvent
description: Send an event to Amplitude.
platform: CLOUD
hidden: false
defaultTrigger: type = "track"
fields:
- - id: qTp2DkxXPfxSnf3imKgMS3
+ - id: mgC6jjPp7L27YtdnAW8s8i
sortOrder: 0
- fieldKey: trackRevenuePerProduct
- label: Track Revenue Per Product
- type: BOOLEAN
- description: >-
- When enabled, track revenue with each product within the event. When
- disabled, track total revenue once for the event.
- placeholder: ''
- defaultValue: false
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: dUeS3hRzDHzEqNF4qdZhMA
- sortOrder: 1
fieldKey: user_id
label: User ID
type: STRING
@@ -7188,8 +7173,8 @@ items:
choices: null
dynamic: false
allowNull: true
- - id: 7PTWYa8ubcJkfz9338eDbV
- sortOrder: 2
+ - id: p3LAkaAHedvygLW9Fpjynj
+ sortOrder: 1
fieldKey: device_id
label: Device ID
type: STRING
@@ -7211,8 +7196,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: db8gzFnKkmVRvCpzuRTW4J
- sortOrder: 3
+ - id: 2JWLhu86Hx4h4SbXhMHtnu
+ sortOrder: 2
fieldKey: event_type
label: Event Type
type: STRING
@@ -7225,8 +7210,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 388LoT5p3vx32cyZYoVt67
- sortOrder: 4
+ - id: 96AHLaazt9vqcuzEW6jXqW
+ sortOrder: 3
fieldKey: session_id
label: Session ID
type: DATETIME
@@ -7242,8 +7227,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 8nd5qs6wurqc7ttLpc2gPY
- sortOrder: 5
+ - id: 4hzmW22Z3bnDFTbWjE7c5U
+ sortOrder: 4
fieldKey: time
label: Timestamp
type: DATETIME
@@ -7258,8 +7243,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: iKZicEyy88ctEFaVNWSn2R
- sortOrder: 6
+ - id: v6cWkDpDVsC561o8diBYHZ
+ sortOrder: 5
fieldKey: event_properties
label: Event Properties
type: OBJECT
@@ -7277,8 +7262,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 5ci3pc6taAomgDd8XnRd6J
- sortOrder: 7
+ - id: kSj5BSqX6UfYw9CrsgKzv6
+ sortOrder: 6
fieldKey: user_properties
label: User Properties
type: OBJECT
@@ -7295,8 +7280,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: neHHCdAjsm6VZtpRYbr3uX
- sortOrder: 8
+ - id: qHWHhYtkVQ9xF6gtbXHngW
+ sortOrder: 7
fieldKey: groups
label: Groups
type: OBJECT
@@ -7310,8 +7295,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: m1dLyjh5JZzzyqwDnzSGjP
- sortOrder: 9
+ - id: gYrndC28WfsWCqTkCoeuNT
+ sortOrder: 8
fieldKey: app_version
label: App Version
type: STRING
@@ -7324,8 +7309,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 5QxqpoKx5Dy4JyVKKuLC7a
- sortOrder: 10
+ - id: rCVbaqENDSajER3G6TQmMj
+ sortOrder: 9
fieldKey: platform
label: Platform
type: STRING
@@ -7338,8 +7323,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: U4YKhKeAtzGyPa7Hgp6SB
- sortOrder: 11
+ - id: pqubr6qeWFkPBK4Pzfnk3Y
+ sortOrder: 10
fieldKey: os_name
label: OS Name
type: STRING
@@ -7354,8 +7339,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: hFigxxRd1dfqMXEwFkBTjD
- sortOrder: 12
+ - id: 534VP7Yx7ZBZ5yTLp7pEvh
+ sortOrder: 11
fieldKey: os_version
label: OS Version
type: STRING
@@ -7368,8 +7353,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: k6LETcS3usg2tRdTnwGAJE
- sortOrder: 13
+ - id: 69WtyicvY3N4D1zPCZfzkg
+ sortOrder: 12
fieldKey: device_brand
label: Device Brand
type: STRING
@@ -7382,8 +7367,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: pwaffWhTbNZ4PVFCVyar9V
- sortOrder: 14
+ - id: cDsPB8YsT2hudvZ9QA5zfk
+ sortOrder: 13
fieldKey: device_manufacturer
label: Device Manufacturer
type: STRING
@@ -7396,8 +7381,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: dgi7tgVXctM2tyqctbtqkm
- sortOrder: 15
+ - id: a8SAnHJjH4iNrxDJnZoZCh
+ sortOrder: 14
fieldKey: device_model
label: Device Model
type: STRING
@@ -7410,8 +7395,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 9rXwAfmB4ABFpcHac6v7vj
- sortOrder: 16
+ - id: ufVQtz2YkCBwfVJAWhY74K
+ sortOrder: 15
fieldKey: carrier
label: Carrier
type: STRING
@@ -7424,8 +7409,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: k3bsxdAtKRJvPVdLZz7BEj
- sortOrder: 17
+ - id: 9TvyBwLk25NPdg8ofMrvm8
+ sortOrder: 16
fieldKey: country
label: Country
type: STRING
@@ -7438,8 +7423,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: ps9VtVfDmrzgpeUynWpb2P
- sortOrder: 18
+ - id: tDUeZVrUtYTKVxRLzfQCFH
+ sortOrder: 17
fieldKey: region
label: Region
type: STRING
@@ -7452,8 +7437,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: m3vA66fV2mHxc5UCR21N1L
- sortOrder: 19
+ - id: bWNuCVRv7fhyN7wNBDfsuV
+ sortOrder: 18
fieldKey: city
label: City
type: STRING
@@ -7466,8 +7451,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: vxkHs2xsAnZ1WmgqYmE71Q
- sortOrder: 20
+ - id: b8YaL4gxZ6QY2BMC895wzf
+ sortOrder: 19
fieldKey: dma
label: Designated Market Area
type: STRING
@@ -7478,8 +7463,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: nryS3iZxApLWX9oHK1cC96
- sortOrder: 21
+ - id: afusyWR7RrbPDnNSAhWFYA
+ sortOrder: 20
fieldKey: language
label: Language
type: STRING
@@ -7492,8 +7477,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: iX9461sKc1mMMMgYTGMsZi
- sortOrder: 22
+ - id: 9BjvuthN1EUsjKt6nPsYfb
+ sortOrder: 21
fieldKey: price
label: Price
type: NUMBER
@@ -7509,8 +7494,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: dQFgXqF8wPJarVb6bTVVXx
- sortOrder: 23
+ - id: fyAYy7KkJyCUXxcTKS47uF
+ sortOrder: 22
fieldKey: quantity
label: Quantity
type: INTEGER
@@ -7523,8 +7508,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 99vZjwNy1CXRcxqH96jXfA
- sortOrder: 24
+ - id: mXxwwsM1ojuAwj71NEBo7x
+ sortOrder: 23
fieldKey: revenue
label: Revenue
type: NUMBER
@@ -7541,8 +7526,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: b716ikYUmhwB1kWp5MboVv
- sortOrder: 25
+ - id: 2DWCjasz6TBAgUCyqiZkAx
+ sortOrder: 24
fieldKey: productId
label: Product ID
type: STRING
@@ -7557,8 +7542,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 8WtnXattMtJNaHurT2Gxrj
- sortOrder: 26
+ - id: 7PsLzPKG7cxZNdiNjcWjF8
+ sortOrder: 25
fieldKey: revenueType
label: Revenue Type
type: STRING
@@ -7573,8 +7558,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: iedT1E9FukYgiiXLrxjKXY
- sortOrder: 27
+ - id: nitrvZ4xCXzGK7uxJP9xdg
+ sortOrder: 26
fieldKey: location_lat
label: Latitude
type: NUMBER
@@ -7587,8 +7572,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: f5Z5jd7J6Wri8MZyMuXSPP
- sortOrder: 28
+ - id: pWM1vXV1wQ3zS8c5pEBALc
+ sortOrder: 27
fieldKey: location_lng
label: Longtitude
type: NUMBER
@@ -7601,8 +7586,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: tG67o543iyv4gVHEZGTDmD
- sortOrder: 29
+ - id: 26CvCZ6is981pFi7giaRT8
+ sortOrder: 28
fieldKey: ip
label: IP Address
type: STRING
@@ -7621,8 +7606,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 9RqLM8Pb7aTf2Lr1XvK1C8
- sortOrder: 30
+ - id: gfmg4oLJbPZoNZ9HDwQVSu
+ sortOrder: 29
fieldKey: idfa
label: Identifier For Advertiser (IDFA)
type: STRING
@@ -7641,8 +7626,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: amTjk2fykf2rBZjzBEHY3G
- sortOrder: 31
+ - id: cmvjmVpfXuResuQmSuphzv
+ sortOrder: 30
fieldKey: idfv
label: Identifier For Vendor (IDFV)
type: STRING
@@ -7655,8 +7640,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: i2RfyPGj5GCEjA5cotZQun
- sortOrder: 32
+ - id: 8sMqtbFMzyD24r1QVMspV9
+ sortOrder: 31
fieldKey: adid
label: Google Play Services Advertising ID
type: STRING
@@ -7675,8 +7660,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: s6tRowdqATKwoDpqqKSe8b
- sortOrder: 33
+ - id: p6DJAPVv9Jw5BHUT8WmNuE
+ sortOrder: 32
fieldKey: android_id
label: Android ID
type: STRING
@@ -7687,8 +7672,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: tS9ihyFKPixJKntgJ6sVhw
- sortOrder: 34
+ - id: w86WV9BeNFJbh5rR8u7hJ3
+ sortOrder: 33
fieldKey: event_id
label: Event ID
type: INTEGER
@@ -7703,8 +7688,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: roEGxAeZBGvGYSGMiRtSy3
- sortOrder: 35
+ - id: snxXDJoAZaFFfSFfj6orTQ
+ sortOrder: 34
fieldKey: insert_id
label: Insert ID
type: STRING
@@ -7719,8 +7704,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: doDRjMC8jJtF9gZFZVs9oe
- sortOrder: 36
+ - id: rNW4BZBn48objWYe6VeLhH
+ sortOrder: 35
fieldKey: library
label: Library
type: STRING
@@ -7733,8 +7718,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 7TFddBeDARA3K3nq25mJBu
- sortOrder: 37
+ - id: gdEdAspSsF7id8qgqAtTiU
+ sortOrder: 36
fieldKey: products
label: Products
type: OBJECT
@@ -7758,8 +7743,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: sSLuqoMqub2PYeTzhXzY6C
- sortOrder: 38
+ - id: vc7TPzatvdRguuB69asKEH
+ sortOrder: 37
fieldKey: use_batch_endpoint
label: Use Batch Endpoint
type: BOOLEAN
@@ -7776,8 +7761,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: ncV1ZoGgyYC28VrGz2f4h4
- sortOrder: 39
+ - id: 3SACdjZDHxWQT5SYcVWwHj
+ sortOrder: 38
fieldKey: userAgent
label: User Agent
type: STRING
@@ -7790,8 +7775,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: tBeLQBDYYL9GgRTW2MbDGp
- sortOrder: 40
+ - id: 8UhBjG1XKPwVuLd6jGCrCy
+ sortOrder: 39
fieldKey: userAgentParsing
label: User Agent Parsing
type: BOOLEAN
@@ -7806,8 +7791,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: o4GUeMDG4qagfhr3AcHeZd
- sortOrder: 41
+ - id: uTKBj5tQYc5oirs7ucHF7n
+ sortOrder: 40
fieldKey: utm_properties
label: UTM Properties
type: OBJECT
@@ -7829,8 +7814,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: asuixHjtg8pHHDfLJHQvuM
- sortOrder: 42
+ - id: wSag6Uv2qzWziysN1iURZh
+ sortOrder: 41
fieldKey: referrer
label: Referrer
type: STRING
@@ -7845,8 +7830,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 54EuTuFC68oHSon8MzfX51
- sortOrder: 43
+ - id: pNrxEVfMYCBRnbGQLd1uxj
+ sortOrder: 42
fieldKey: min_id_length
label: Minimum ID Length
type: INTEGER
@@ -7860,8 +7845,8 @@ items:
choices: null
dynamic: false
allowNull: true
- - id: 4bqbuNXnCj5aiBS7e2CKLe
- sortOrder: 44
+ - id: 2yJjf8UoPP9nk2duG42w9W
+ sortOrder: 43
fieldKey: userAgentData
label: User Agent Data
type: OBJECT
@@ -7877,16 +7862,190 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: gA673j6ij2yCB8n9Fztpj9
- name: Log Event
- slug: logEvent
+ - id: hMC2cGnxZanH97kGbGUNQM
+ name: Group Identify User
+ slug: groupIdentifyUser
+ description: >-
+ Set or update properties of particular groups. Note that these updates
+ will only affect events going forward.
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: type = "group"
+ fields:
+ - id: hEhZKNSeKDiKw5BGKk8LLx
+ sortOrder: 0
+ fieldKey: user_id
+ label: User ID
+ type: STRING
+ description: >-
+ A UUID (unique user ID) specified by you. **Note:** If you send a
+ request with a user ID that is not in the Amplitude system yet, then the
+ user tied to that ID will not be marked new until their first event.
+ Required unless device ID is present.
+ placeholder: ''
+ defaultValue:
+ '@path': $.userId
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: true
+ - id: 9AuRjrMVKSqznAV3fJ98ym
+ sortOrder: 1
+ fieldKey: device_id
+ label: Device ID
+ type: STRING
+ description: >-
+ A device specific identifier, such as the Identifier for Vendor (IDFV)
+ on iOS. Required unless user ID is present.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.context.device.id
+ then:
+ '@path': $.context.device.id
+ else:
+ '@path': $.anonymousId
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: UorjtyFyaccRRY4S5VDeS
+ sortOrder: 2
+ fieldKey: insert_id
+ label: Insert ID
+ type: STRING
+ description: >-
+ Amplitude will deduplicate subsequent events sent with this ID we have
+ already seen before within the past 7 days. Amplitude recommends
+ generating a UUID or using some combination of device ID, user ID, event
+ type, event ID, and time.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 4PUENnAZVrTSRvxZPUWy6Q
+ sortOrder: 3
+ fieldKey: time
+ label: Timestamp
+ type: STRING
+ description: >-
+ The timestamp of the event. If time is not sent with the event, it will
+ be set to the request upload time.
+ placeholder: ''
+ defaultValue:
+ '@path': $.timestamp
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 3kYCpd1pSjQm9kPEcVXCEY
+ sortOrder: 4
+ fieldKey: group_properties
+ label: Group Properties
+ type: OBJECT
+ description: Additional data tied to the group in Amplitude.
+ placeholder: ''
+ defaultValue:
+ '@path': $.traits
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: tj2oSLjWx4LUoNa5Biq7z3
+ sortOrder: 5
+ fieldKey: group_type
+ label: Group Type
+ type: STRING
+ description: The type of the group
+ placeholder: ''
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: sf1TMkv52VRekB3vcUx6Um
+ sortOrder: 6
+ fieldKey: group_value
+ label: Group Value
+ type: STRING
+ description: The value of the group
+ placeholder: ''
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: qNNnDhwEUJsgXReCQoDWci
+ sortOrder: 7
+ fieldKey: min_id_length
+ label: Minimum ID Length
+ type: INTEGER
+ description: >-
+ Amplitude has a default minimum id lenght of 5 characters for user_id
+ and device_id fields. This field allows the minimum to be overridden to
+ allow shorter id lengths.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: true
+ - id: nhJa95SA9MXa3hi2Vm2acC
+ name: Session Plugin
+ slug: sessionId
+ description: >-
+ Generates a Session ID and attaches it to every Amplitude browser based
+ event.
+ platform: WEB
+ hidden: true
+ defaultTrigger: >-
+ type = "track" or type = "identify" or type = "group" or type = "page" or
+ type = "alias"
+ fields:
+ - id: d2jCnhoq7gBmg1TPU7NedM
+ sortOrder: 0
+ fieldKey: sessionLength
+ label: Session Length
+ type: NUMBER
+ description: Time in milliseconds to be used before considering a session stale.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: cRSyn3B292uKfxrpKwHRDY
+ name: Log Purchase
+ slug: logPurchase
description: Send an event to Amplitude.
platform: CLOUD
hidden: false
defaultTrigger: type = "track"
fields:
- - id: mgC6jjPp7L27YtdnAW8s8i
+ - id: qTp2DkxXPfxSnf3imKgMS3
sortOrder: 0
+ fieldKey: trackRevenuePerProduct
+ label: Track Revenue Per Product
+ type: BOOLEAN
+ description: >-
+ When enabled, track revenue with each product within the event. When
+ disabled, track total revenue once for the event.
+ placeholder: ''
+ defaultValue: false
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: dUeS3hRzDHzEqNF4qdZhMA
+ sortOrder: 1
fieldKey: user_id
label: User ID
type: STRING
@@ -7903,8 +8062,8 @@ items:
choices: null
dynamic: false
allowNull: true
- - id: p3LAkaAHedvygLW9Fpjynj
- sortOrder: 1
+ - id: 7PTWYa8ubcJkfz9338eDbV
+ sortOrder: 2
fieldKey: device_id
label: Device ID
type: STRING
@@ -7926,8 +8085,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 2JWLhu86Hx4h4SbXhMHtnu
- sortOrder: 2
+ - id: db8gzFnKkmVRvCpzuRTW4J
+ sortOrder: 3
fieldKey: event_type
label: Event Type
type: STRING
@@ -7940,8 +8099,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 96AHLaazt9vqcuzEW6jXqW
- sortOrder: 3
+ - id: 388LoT5p3vx32cyZYoVt67
+ sortOrder: 4
fieldKey: session_id
label: Session ID
type: DATETIME
@@ -7957,8 +8116,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 4hzmW22Z3bnDFTbWjE7c5U
- sortOrder: 4
+ - id: 8nd5qs6wurqc7ttLpc2gPY
+ sortOrder: 5
fieldKey: time
label: Timestamp
type: DATETIME
@@ -7973,8 +8132,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: v6cWkDpDVsC561o8diBYHZ
- sortOrder: 5
+ - id: iKZicEyy88ctEFaVNWSn2R
+ sortOrder: 6
fieldKey: event_properties
label: Event Properties
type: OBJECT
@@ -7992,8 +8151,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: kSj5BSqX6UfYw9CrsgKzv6
- sortOrder: 6
+ - id: 5ci3pc6taAomgDd8XnRd6J
+ sortOrder: 7
fieldKey: user_properties
label: User Properties
type: OBJECT
@@ -8010,8 +8169,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: qHWHhYtkVQ9xF6gtbXHngW
- sortOrder: 7
+ - id: neHHCdAjsm6VZtpRYbr3uX
+ sortOrder: 8
fieldKey: groups
label: Groups
type: OBJECT
@@ -8025,8 +8184,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: gYrndC28WfsWCqTkCoeuNT
- sortOrder: 8
+ - id: m1dLyjh5JZzzyqwDnzSGjP
+ sortOrder: 9
fieldKey: app_version
label: App Version
type: STRING
@@ -8039,8 +8198,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: rCVbaqENDSajER3G6TQmMj
- sortOrder: 9
+ - id: 5QxqpoKx5Dy4JyVKKuLC7a
+ sortOrder: 10
fieldKey: platform
label: Platform
type: STRING
@@ -8053,8 +8212,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: pqubr6qeWFkPBK4Pzfnk3Y
- sortOrder: 10
+ - id: U4YKhKeAtzGyPa7Hgp6SB
+ sortOrder: 11
fieldKey: os_name
label: OS Name
type: STRING
@@ -8069,8 +8228,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 534VP7Yx7ZBZ5yTLp7pEvh
- sortOrder: 11
+ - id: hFigxxRd1dfqMXEwFkBTjD
+ sortOrder: 12
fieldKey: os_version
label: OS Version
type: STRING
@@ -8083,8 +8242,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 69WtyicvY3N4D1zPCZfzkg
- sortOrder: 12
+ - id: k6LETcS3usg2tRdTnwGAJE
+ sortOrder: 13
fieldKey: device_brand
label: Device Brand
type: STRING
@@ -8097,8 +8256,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: cDsPB8YsT2hudvZ9QA5zfk
- sortOrder: 13
+ - id: pwaffWhTbNZ4PVFCVyar9V
+ sortOrder: 14
fieldKey: device_manufacturer
label: Device Manufacturer
type: STRING
@@ -8111,8 +8270,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: a8SAnHJjH4iNrxDJnZoZCh
- sortOrder: 14
+ - id: dgi7tgVXctM2tyqctbtqkm
+ sortOrder: 15
fieldKey: device_model
label: Device Model
type: STRING
@@ -8125,8 +8284,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: ufVQtz2YkCBwfVJAWhY74K
- sortOrder: 15
+ - id: 9rXwAfmB4ABFpcHac6v7vj
+ sortOrder: 16
fieldKey: carrier
label: Carrier
type: STRING
@@ -8139,8 +8298,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 9TvyBwLk25NPdg8ofMrvm8
- sortOrder: 16
+ - id: k3bsxdAtKRJvPVdLZz7BEj
+ sortOrder: 17
fieldKey: country
label: Country
type: STRING
@@ -8153,8 +8312,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: tDUeZVrUtYTKVxRLzfQCFH
- sortOrder: 17
+ - id: ps9VtVfDmrzgpeUynWpb2P
+ sortOrder: 18
fieldKey: region
label: Region
type: STRING
@@ -8167,8 +8326,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: bWNuCVRv7fhyN7wNBDfsuV
- sortOrder: 18
+ - id: m3vA66fV2mHxc5UCR21N1L
+ sortOrder: 19
fieldKey: city
label: City
type: STRING
@@ -8181,8 +8340,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: b8YaL4gxZ6QY2BMC895wzf
- sortOrder: 19
+ - id: vxkHs2xsAnZ1WmgqYmE71Q
+ sortOrder: 20
fieldKey: dma
label: Designated Market Area
type: STRING
@@ -8193,8 +8352,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: afusyWR7RrbPDnNSAhWFYA
- sortOrder: 20
+ - id: nryS3iZxApLWX9oHK1cC96
+ sortOrder: 21
fieldKey: language
label: Language
type: STRING
@@ -8207,8 +8366,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 9BjvuthN1EUsjKt6nPsYfb
- sortOrder: 21
+ - id: iX9461sKc1mMMMgYTGMsZi
+ sortOrder: 22
fieldKey: price
label: Price
type: NUMBER
@@ -8224,8 +8383,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: fyAYy7KkJyCUXxcTKS47uF
- sortOrder: 22
+ - id: dQFgXqF8wPJarVb6bTVVXx
+ sortOrder: 23
fieldKey: quantity
label: Quantity
type: INTEGER
@@ -8238,8 +8397,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: mXxwwsM1ojuAwj71NEBo7x
- sortOrder: 23
+ - id: 99vZjwNy1CXRcxqH96jXfA
+ sortOrder: 24
fieldKey: revenue
label: Revenue
type: NUMBER
@@ -8256,8 +8415,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 2DWCjasz6TBAgUCyqiZkAx
- sortOrder: 24
+ - id: b716ikYUmhwB1kWp5MboVv
+ sortOrder: 25
fieldKey: productId
label: Product ID
type: STRING
@@ -8272,8 +8431,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 7PsLzPKG7cxZNdiNjcWjF8
- sortOrder: 25
+ - id: 8WtnXattMtJNaHurT2Gxrj
+ sortOrder: 26
fieldKey: revenueType
label: Revenue Type
type: STRING
@@ -8288,8 +8447,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: nitrvZ4xCXzGK7uxJP9xdg
- sortOrder: 26
+ - id: iedT1E9FukYgiiXLrxjKXY
+ sortOrder: 27
fieldKey: location_lat
label: Latitude
type: NUMBER
@@ -8302,8 +8461,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: pWM1vXV1wQ3zS8c5pEBALc
- sortOrder: 27
+ - id: f5Z5jd7J6Wri8MZyMuXSPP
+ sortOrder: 28
fieldKey: location_lng
label: Longtitude
type: NUMBER
@@ -8316,8 +8475,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 26CvCZ6is981pFi7giaRT8
- sortOrder: 28
+ - id: tG67o543iyv4gVHEZGTDmD
+ sortOrder: 29
fieldKey: ip
label: IP Address
type: STRING
@@ -8336,8 +8495,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: gfmg4oLJbPZoNZ9HDwQVSu
- sortOrder: 29
+ - id: 9RqLM8Pb7aTf2Lr1XvK1C8
+ sortOrder: 30
fieldKey: idfa
label: Identifier For Advertiser (IDFA)
type: STRING
@@ -8356,8 +8515,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: cmvjmVpfXuResuQmSuphzv
- sortOrder: 30
+ - id: amTjk2fykf2rBZjzBEHY3G
+ sortOrder: 31
fieldKey: idfv
label: Identifier For Vendor (IDFV)
type: STRING
@@ -8370,8 +8529,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 8sMqtbFMzyD24r1QVMspV9
- sortOrder: 31
+ - id: i2RfyPGj5GCEjA5cotZQun
+ sortOrder: 32
fieldKey: adid
label: Google Play Services Advertising ID
type: STRING
@@ -8390,8 +8549,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: p6DJAPVv9Jw5BHUT8WmNuE
- sortOrder: 32
+ - id: s6tRowdqATKwoDpqqKSe8b
+ sortOrder: 33
fieldKey: android_id
label: Android ID
type: STRING
@@ -8402,8 +8561,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: w86WV9BeNFJbh5rR8u7hJ3
- sortOrder: 33
+ - id: tS9ihyFKPixJKntgJ6sVhw
+ sortOrder: 34
fieldKey: event_id
label: Event ID
type: INTEGER
@@ -8418,8 +8577,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: snxXDJoAZaFFfSFfj6orTQ
- sortOrder: 34
+ - id: roEGxAeZBGvGYSGMiRtSy3
+ sortOrder: 35
fieldKey: insert_id
label: Insert ID
type: STRING
@@ -8434,8 +8593,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: rNW4BZBn48objWYe6VeLhH
- sortOrder: 35
+ - id: doDRjMC8jJtF9gZFZVs9oe
+ sortOrder: 36
fieldKey: library
label: Library
type: STRING
@@ -8448,8 +8607,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: gdEdAspSsF7id8qgqAtTiU
- sortOrder: 36
+ - id: 7TFddBeDARA3K3nq25mJBu
+ sortOrder: 37
fieldKey: products
label: Products
type: OBJECT
@@ -8473,8 +8632,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: vc7TPzatvdRguuB69asKEH
- sortOrder: 37
+ - id: sSLuqoMqub2PYeTzhXzY6C
+ sortOrder: 38
fieldKey: use_batch_endpoint
label: Use Batch Endpoint
type: BOOLEAN
@@ -8491,8 +8650,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 3SACdjZDHxWQT5SYcVWwHj
- sortOrder: 38
+ - id: ncV1ZoGgyYC28VrGz2f4h4
+ sortOrder: 39
fieldKey: userAgent
label: User Agent
type: STRING
@@ -8505,8 +8664,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 8UhBjG1XKPwVuLd6jGCrCy
- sortOrder: 39
+ - id: tBeLQBDYYL9GgRTW2MbDGp
+ sortOrder: 40
fieldKey: userAgentParsing
label: User Agent Parsing
type: BOOLEAN
@@ -8521,8 +8680,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: uTKBj5tQYc5oirs7ucHF7n
- sortOrder: 40
+ - id: o4GUeMDG4qagfhr3AcHeZd
+ sortOrder: 41
fieldKey: utm_properties
label: UTM Properties
type: OBJECT
@@ -8544,8 +8703,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: wSag6Uv2qzWziysN1iURZh
- sortOrder: 41
+ - id: asuixHjtg8pHHDfLJHQvuM
+ sortOrder: 42
fieldKey: referrer
label: Referrer
type: STRING
@@ -8560,8 +8719,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: pNrxEVfMYCBRnbGQLd1uxj
- sortOrder: 42
+ - id: 54EuTuFC68oHSon8MzfX51
+ sortOrder: 43
fieldKey: min_id_length
label: Minimum ID Length
type: INTEGER
@@ -8575,8 +8734,8 @@ items:
choices: null
dynamic: false
allowNull: true
- - id: 2yJjf8UoPP9nk2duG42w9W
- sortOrder: 43
+ - id: 4bqbuNXnCj5aiBS7e2CKLe
+ sortOrder: 44
fieldKey: userAgentData
label: User Agent Data
type: OBJECT
@@ -8592,165 +8751,6 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: hMC2cGnxZanH97kGbGUNQM
- name: Group Identify User
- slug: groupIdentifyUser
- description: >-
- Set or update properties of particular groups. Note that these updates
- will only affect events going forward.
- platform: CLOUD
- hidden: false
- defaultTrigger: type = "group"
- fields:
- - id: hEhZKNSeKDiKw5BGKk8LLx
- sortOrder: 0
- fieldKey: user_id
- label: User ID
- type: STRING
- description: >-
- A UUID (unique user ID) specified by you. **Note:** If you send a
- request with a user ID that is not in the Amplitude system yet, then the
- user tied to that ID will not be marked new until their first event.
- Required unless device ID is present.
- placeholder: ''
- defaultValue:
- '@path': $.userId
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: true
- - id: 9AuRjrMVKSqznAV3fJ98ym
- sortOrder: 1
- fieldKey: device_id
- label: Device ID
- type: STRING
- description: >-
- A device specific identifier, such as the Identifier for Vendor (IDFV)
- on iOS. Required unless user ID is present.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.context.device.id
- then:
- '@path': $.context.device.id
- else:
- '@path': $.anonymousId
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: UorjtyFyaccRRY4S5VDeS
- sortOrder: 2
- fieldKey: insert_id
- label: Insert ID
- type: STRING
- description: >-
- Amplitude will deduplicate subsequent events sent with this ID we have
- already seen before within the past 7 days. Amplitude recommends
- generating a UUID or using some combination of device ID, user ID, event
- type, event ID, and time.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 4PUENnAZVrTSRvxZPUWy6Q
- sortOrder: 3
- fieldKey: time
- label: Timestamp
- type: STRING
- description: >-
- The timestamp of the event. If time is not sent with the event, it will
- be set to the request upload time.
- placeholder: ''
- defaultValue:
- '@path': $.timestamp
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 3kYCpd1pSjQm9kPEcVXCEY
- sortOrder: 4
- fieldKey: group_properties
- label: Group Properties
- type: OBJECT
- description: Additional data tied to the group in Amplitude.
- placeholder: ''
- defaultValue:
- '@path': $.traits
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: tj2oSLjWx4LUoNa5Biq7z3
- sortOrder: 5
- fieldKey: group_type
- label: Group Type
- type: STRING
- description: The type of the group
- placeholder: ''
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: sf1TMkv52VRekB3vcUx6Um
- sortOrder: 6
- fieldKey: group_value
- label: Group Value
- type: STRING
- description: The value of the group
- placeholder: ''
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: qNNnDhwEUJsgXReCQoDWci
- sortOrder: 7
- fieldKey: min_id_length
- label: Minimum ID Length
- type: INTEGER
- description: >-
- Amplitude has a default minimum id lenght of 5 characters for user_id
- and device_id fields. This field allows the minimum to be overridden to
- allow shorter id lengths.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: true
- - id: nhJa95SA9MXa3hi2Vm2acC
- name: Session Plugin
- slug: sessionId
- description: >-
- Generates a Session ID and attaches it to every Amplitude browser based
- event.
- platform: WEB
- hidden: true
- defaultTrigger: >-
- type = "track" or type = "identify" or type = "group" or type = "page" or
- type = "alias"
- fields:
- - id: d2jCnhoq7gBmg1TPU7NedM
- sortOrder: 0
- fieldKey: sessionLength
- label: Session Length
- type: NUMBER
- description: Time in milliseconds to be used before considering a session stale.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- id: uhprCN3Pc9fjb89v4xDrfP
name: Log Event V2
slug: logEventV2
@@ -11934,249 +11934,760 @@ items:
required: true
label: Blackbaud API Subscription Key
actions:
- - id: 9A8CWrEJjNoW413cnwPUK
- name: Create Gift
- slug: createGift
- description: Create a Gift record in Raiser's Edge NXT.
+ - id: frvqRyY6zVF4JaTDyABuya
+ name: Create or Update Individual Constituent
+ slug: createOrUpdateIndividualConstituent
+ description: Create or update an Individual Constituent record in Raiser's Edge NXT.
platform: CLOUD
hidden: false
- defaultTrigger: type = "track" and event = "Donation Completed"
+ defaultTrigger: type = "identify"
fields:
- - id: p14EcHBu3dgmu2fVr1c83j
+ - id: uF9kJSd1nwYGFL6nmVKEBj
sortOrder: 0
- fieldKey: acknowledgement
- label: Acknowledgement
+ fieldKey: address
+ label: Address
type: OBJECT
- description: The gift acknowledgement.
+ description: The constituent's address.
placeholder: ''
defaultValue:
- date:
- '@path': $.properties.acknowledgement.date
- status:
- '@path': $.properties.acknowledgement.status
+ address_lines:
+ '@if':
+ exists:
+ '@path': $.traits.address.street
+ then:
+ '@path': $.traits.address.street
+ else:
+ '@path': $.properties.address.street
+ city:
+ '@if':
+ exists:
+ '@path': $.traits.address.city
+ then:
+ '@path': $.traits.address.city
+ else:
+ '@path': $.properties.address.city
+ country:
+ '@if':
+ exists:
+ '@path': $.traits.address.country
+ then:
+ '@path': $.traits.address.country
+ else:
+ '@path': $.properties.address.country
+ do_not_mail: ''
+ postal_code:
+ '@if':
+ exists:
+ '@path': $.traits.address.postalCode
+ then:
+ '@path': $.traits.address.postalCode
+ else:
+ '@path': $.properties.address.postalCode
+ primary: ''
+ state:
+ '@if':
+ exists:
+ '@path': $.traits.address.state
+ then:
+ '@path': $.traits.address.state
+ else:
+ '@path': $.properties.address.state
+ type: ''
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: phv6JfjR5fVipfgSo8RKdm
+ - id: 51yJdQPHGTcZUZVATozRVV
sortOrder: 1
- fieldKey: amount
- label: Gift Amount
- type: NUMBER
- description: The monetary amount of the gift in number format, e.g. 12.34
+ fieldKey: birthdate
+ label: Birthdate
+ type: DATETIME
+ description: The constituent's birthdate.
placeholder: ''
defaultValue:
- '@path': $.properties.revenue
- required: true
+ '@if':
+ exists:
+ '@path': $.traits.birthday
+ then:
+ '@path': $.traits.birthday
+ else:
+ '@path': $.properties.birthday
+ required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: FJrEReBwczBxnMbWZpNTB
+ - id: w2LBDs1zMyxU5Tw8kLb7Wv
sortOrder: 2
- fieldKey: batch_number
- label: Batch Number
+ fieldKey: birthplace
+ label: Birthplace
type: STRING
- description: >-
- The batch number of the gift up to 50 characters (including the batch
- prefix).
+ description: The birthplace of the constituent.
placeholder: ''
defaultValue:
- '@path': $.properties.batchNumber
+ '@if':
+ exists:
+ '@path': $.traits.birthplace
+ then:
+ '@path': $.traits.birthplace
+ else:
+ '@path': $.properties.birthplace
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: tgWBy54LVGgaGG1boZEPZN
+ - id: gv6wGUefGeepwjYTzfKTKM
sortOrder: 3
- fieldKey: batch_prefix
- label: Batch Prefix
+ fieldKey: constituent_id
+ label: Constituent ID
type: STRING
- description: >-
- The batch prefix of the gift. If provided, must include at least one
- letter. Required when Batch Number has a value, and defaults to "API" if
- no value is provided.
+ description: The ID of the constituent.
placeholder: ''
- defaultValue:
- '@path': $.properties.batchPrefix
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: aw6ywKYd7QuZg5iKhMGDPY
+ - id: mKZotNZShLKtP1dePKTQvD
sortOrder: 4
- fieldKey: check_date
- label: Check Date
- type: DATETIME
- description: The check date in ISO-8601 format.
+ fieldKey: email
+ label: Email
+ type: OBJECT
+ description: The constituent's email address.
placeholder: ''
defaultValue:
- '@path': $.properties.checkDate
+ address:
+ '@if':
+ exists:
+ '@path': $.traits.email
+ then:
+ '@path': $.traits.email
+ else:
+ '@path': $.properties.email
+ do_not_email: ''
+ primary: ''
+ type: ''
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: ryXm5cnzMENfaVDtLvFG49
+ - id: scxzistF5TjnMaHwtmrwAY
sortOrder: 5
- fieldKey: check_number
- label: Check Number
+ fieldKey: ethnicity
+ label: Ethnicity
type: STRING
- description: The check number in string format, e.g. "12345"
+ description: The ethnicity of the constituent.
placeholder: ''
defaultValue:
- '@path': $.properties.checkNumber
+ '@if':
+ exists:
+ '@path': $.traits.ethnicity
+ then:
+ '@path': $.traits.ethnicity
+ else:
+ '@path': $.properties.ethnicity
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: jAstsNKHaYCDW6jrodFXvp
+ - id: hZmJfzmGQjM5cLcWNM4NAK
sortOrder: 6
- fieldKey: constituency
- label: Constituency
+ fieldKey: first
+ label: First Name
type: STRING
- description: >-
- The constituency value of the gift. If no value is provided, the default
- constituency of the donor will be used.
+ description: The constituent's first name up to 50 characters.
placeholder: ''
defaultValue:
- '@path': $.properties.constituency
+ '@if':
+ exists:
+ '@path': $.traits.firstName
+ then:
+ '@path': $.traits.firstName
+ else:
+ '@path': $.properties.firstName
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: vTYBaMidXYhoAGThrGpSuf
+ - id: 4S8MKU4o61ekqVuzdG5iB6
sortOrder: 7
- fieldKey: date
- label: Gift Date
- type: DATETIME
- description: The gift date in ISO-8601 format.
+ fieldKey: former_name
+ label: Former Name
+ type: STRING
+ description: The constituent's former name up to 100 characters.
placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.traits.formerName
+ then:
+ '@path': $.traits.formerName
+ else:
+ '@path': $.properties.formerName
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: fF4QWvcxtGnnBvv1GjUgEc
+ - id: grogXhhRAN4y5tzcGQp6kn
sortOrder: 8
- fieldKey: default_fundraiser_credits
- label: Default Fundraiser Credits
- type: BOOLEAN
- description: Indicates whether to use default fundraiser credits.
+ fieldKey: gender
+ label: Gender
+ type: STRING
+ description: The constituent's gender.
placeholder: ''
defaultValue:
- '@path': $.properties.defaultFundraiserCredits
+ '@if':
+ exists:
+ '@path': $.traits.gender
+ then:
+ '@path': $.traits.gender
+ else:
+ '@path': $.properties.gender
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: izaANZBjNavBVRYSzyvptK
+ - id: 8R71jnwRcDevSi1Zsrowfu
sortOrder: 9
- fieldKey: default_soft_credits
- label: Default Soft Credits
+ fieldKey: gives_anonymously
+ label: Gives Anonymously
type: BOOLEAN
- description: Indicates whether to use default soft credits.
+ description: Indicates whether the constituent gives anonymously.
placeholder: ''
defaultValue:
- '@path': $.properties.defaultSoftCredits
+ '@if':
+ exists:
+ '@path': $.traits.givesAnonymously
+ then:
+ '@path': $.traits.givesAnonymously
+ else:
+ '@path': $.properties.givesAnonymously
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: ua8upsBkRGLK1V99zPcMpq
+ - id: vaty6aWFQ6HWkN3UZ372N
sortOrder: 10
- fieldKey: fund_id
- label: Fund ID
+ fieldKey: income
+ label: Income
type: STRING
- description: The ID of the fund associated with the gift.
+ description: The constituent's income.
placeholder: ''
defaultValue:
- '@path': $.properties.fundId
- required: true
+ '@if':
+ exists:
+ '@path': $.traits.income
+ then:
+ '@path': $.traits.income
+ else:
+ '@path': $.properties.income
+ required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: x91pjMZu32z2RAFK5vkWy2
+ - id: iJhiCtqCGDTYk5FNgCahUT
sortOrder: 11
- fieldKey: gift_code
- label: Gift Code
+ fieldKey: industry
+ label: Industry
type: STRING
- description: The gift code. Available values are the entries in the Gift Code table.
+ description: The constituent's industry.
placeholder: ''
defaultValue:
- '@path': $.properties.giftCode
+ '@if':
+ exists:
+ '@path': $.traits.industry
+ then:
+ '@path': $.traits.industry
+ else:
+ '@path': $.properties.industry
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: pUseRQNiVkdS2uAe3KTciJ
+ - id: 46h75ELsbG36KTr11aD6JY
sortOrder: 12
- fieldKey: gift_status
- label: Gift Status
+ fieldKey: last
+ label: Last Name
type: STRING
description: >-
- The status of the gift. Available values are "Active", "Held",
- "Terminated", "Completed", and "Cancelled".
+ The constituent's last name up to 100 characters. This is required to
+ create a constituent.
placeholder: ''
defaultValue:
- '@path': $.properties.giftStatus
+ '@if':
+ exists:
+ '@path': $.traits.lastName
+ then:
+ '@path': $.traits.lastName
+ else:
+ '@path': $.properties.lastName
required: false
multiple: false
- choices:
- - label: Active
- value: Active
- - label: Held
- value: Held
- - label: Terminated
- value: Terminated
- - label: Completed
- value: Completed
- - label: Cancelled
- value: Cancelled
+ choices: null
dynamic: false
allowNull: false
- - id: bx53ezqrmy3FVrYr3HBSp1
+ - id: oBvqnjoMrxLSxCGr4rwmTD
sortOrder: 13
- fieldKey: is_anonymous
- label: Is Anonymous
- type: BOOLEAN
- description: Indicates whether the gift is anonymous.
+ fieldKey: lookup_id
+ label: Lookup ID
+ type: STRING
+ description: The organization-defined identifier for the constituent.
placeholder: ''
- defaultValue:
- '@path': $.properties.isAnonymous
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: 5WNYgrUzd6eicnkN1tVjnG
+ - id: mbzpjFApc1XGkBGg5bTCtK
sortOrder: 14
- fieldKey: linked_gifts
- label: Linked Gifts
+ fieldKey: marital_status
+ label: Marital Status
type: STRING
description: >-
- The recurring gift associated with the payment being added. When adding
- a recurring gift payment, a linked_gifts field must be included as an
- array of strings with the ID of the recurring gift to which the payment
- is linked.
+ The constituent's marital status. Available values are the entries in
+ the Marital Status table.
placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.traits.maritalStatus
+ then:
+ '@path': $.traits.maritalStatus
+ else:
+ '@path': $.properties.maritalStatus
required: false
- multiple: true
+ multiple: false
choices: null
dynamic: false
allowNull: false
- - id: en4Ast3u9AoFyxf15tXiqm
+ - id: nH9J2uriHcuHEUNGV9ypfT
sortOrder: 15
- fieldKey: lookup_id
+ fieldKey: online_presence
+ label: Online Presence
+ type: OBJECT
+ description: The constituent's online presence.
+ placeholder: ''
+ defaultValue:
+ address:
+ '@if':
+ exists:
+ '@path': $.traits.website
+ then:
+ '@path': $.traits.website
+ else:
+ '@path': $.properties.website
+ primary: ''
+ type: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: cyy4Poxag4orLQZSRn8dw4
+ sortOrder: 16
+ fieldKey: phone
+ label: Phone
+ type: OBJECT
+ description: The constituent's phone number.
+ placeholder: ''
+ defaultValue:
+ do_not_call: ''
+ number:
+ '@if':
+ exists:
+ '@path': $.traits.phone
+ then:
+ '@path': $.traits.phone
+ else:
+ '@path': $.properties.phone
+ primary: ''
+ type: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 9CEjHzF6ZG3MyRTaiitzfX
+ sortOrder: 17
+ fieldKey: preferred_name
+ label: Preferred Name
+ type: STRING
+ description: The constituent's preferred name up to 50 characters.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.traits.preferredName
+ then:
+ '@path': $.traits.preferredName
+ else:
+ '@path': $.properties.preferredName
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 9uQ5iZ5omVD1JWpQmGao13
+ sortOrder: 18
+ fieldKey: religion
+ label: Religion
+ type: STRING
+ description: The religion of the constituent.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.traits.religion
+ then:
+ '@path': $.traits.religion
+ else:
+ '@path': $.properties.religion
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: nF9T8vJyL9NwnPHvVDyPrD
+ sortOrder: 19
+ fieldKey: suffix
+ label: Suffix
+ type: STRING
+ description: >-
+ The constituent's primary suffix. Available values are the entries in
+ the Suffixes table.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.traits.suffix
+ then:
+ '@path': $.traits.suffix
+ else:
+ '@path': $.properties.suffix
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: i9jJJ2X37tPHTBmq2cuR3L
+ sortOrder: 20
+ fieldKey: suffix_2
+ label: Secondary Suffix
+ type: STRING
+ description: >-
+ The constituent's secondary suffix. Available values are the entries in
+ the Suffixes table.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.traits.suffix2
+ then:
+ '@path': $.traits.suffix2
+ else:
+ '@path': $.properties.suffix2
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: sEF7X5HD47DrVNy2tdjCz8
+ sortOrder: 21
+ fieldKey: title
+ label: Title
+ type: STRING
+ description: >-
+ The constituent's primary title. Available values are the entries in the
+ Titles table.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.traits.title
+ then:
+ '@path': $.traits.title
+ else:
+ '@path': $.properties.title
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: sT8RCJ5PCMcr1Rh4vNXxth
+ sortOrder: 22
+ fieldKey: title_2
+ label: Secondary Title
+ type: STRING
+ description: >-
+ The constituent's secondary title. Available values are the entries in
+ the Titles table.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.traits.title2
+ then:
+ '@path': $.traits.title2
+ else:
+ '@path': $.properties.title2
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 9A8CWrEJjNoW413cnwPUK
+ name: Create Gift
+ slug: createGift
+ description: Create a Gift record in Raiser's Edge NXT.
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: type = "track" and event = "Donation Completed"
+ fields:
+ - id: p14EcHBu3dgmu2fVr1c83j
+ sortOrder: 0
+ fieldKey: acknowledgement
+ label: Acknowledgement
+ type: OBJECT
+ description: The gift acknowledgement.
+ placeholder: ''
+ defaultValue:
+ date:
+ '@path': $.properties.acknowledgement.date
+ status:
+ '@path': $.properties.acknowledgement.status
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: phv6JfjR5fVipfgSo8RKdm
+ sortOrder: 1
+ fieldKey: amount
+ label: Gift Amount
+ type: NUMBER
+ description: The monetary amount of the gift in number format, e.g. 12.34
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.revenue
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: FJrEReBwczBxnMbWZpNTB
+ sortOrder: 2
+ fieldKey: batch_number
+ label: Batch Number
+ type: STRING
+ description: >-
+ The batch number of the gift up to 50 characters (including the batch
+ prefix).
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.batchNumber
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: tgWBy54LVGgaGG1boZEPZN
+ sortOrder: 3
+ fieldKey: batch_prefix
+ label: Batch Prefix
+ type: STRING
+ description: >-
+ The batch prefix of the gift. If provided, must include at least one
+ letter. Required when Batch Number has a value, and defaults to "API" if
+ no value is provided.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.batchPrefix
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: aw6ywKYd7QuZg5iKhMGDPY
+ sortOrder: 4
+ fieldKey: check_date
+ label: Check Date
+ type: DATETIME
+ description: The check date in ISO-8601 format.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.checkDate
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: ryXm5cnzMENfaVDtLvFG49
+ sortOrder: 5
+ fieldKey: check_number
+ label: Check Number
+ type: STRING
+ description: The check number in string format, e.g. "12345"
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.checkNumber
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: jAstsNKHaYCDW6jrodFXvp
+ sortOrder: 6
+ fieldKey: constituency
+ label: Constituency
+ type: STRING
+ description: >-
+ The constituency value of the gift. If no value is provided, the default
+ constituency of the donor will be used.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.constituency
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: vTYBaMidXYhoAGThrGpSuf
+ sortOrder: 7
+ fieldKey: date
+ label: Gift Date
+ type: DATETIME
+ description: The gift date in ISO-8601 format.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: fF4QWvcxtGnnBvv1GjUgEc
+ sortOrder: 8
+ fieldKey: default_fundraiser_credits
+ label: Default Fundraiser Credits
+ type: BOOLEAN
+ description: Indicates whether to use default fundraiser credits.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.defaultFundraiserCredits
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: izaANZBjNavBVRYSzyvptK
+ sortOrder: 9
+ fieldKey: default_soft_credits
+ label: Default Soft Credits
+ type: BOOLEAN
+ description: Indicates whether to use default soft credits.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.defaultSoftCredits
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: ua8upsBkRGLK1V99zPcMpq
+ sortOrder: 10
+ fieldKey: fund_id
+ label: Fund ID
+ type: STRING
+ description: The ID of the fund associated with the gift.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.fundId
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: x91pjMZu32z2RAFK5vkWy2
+ sortOrder: 11
+ fieldKey: gift_code
+ label: Gift Code
+ type: STRING
+ description: The gift code. Available values are the entries in the Gift Code table.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.giftCode
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: pUseRQNiVkdS2uAe3KTciJ
+ sortOrder: 12
+ fieldKey: gift_status
+ label: Gift Status
+ type: STRING
+ description: >-
+ The status of the gift. Available values are "Active", "Held",
+ "Terminated", "Completed", and "Cancelled".
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.giftStatus
+ required: false
+ multiple: false
+ choices:
+ - label: Active
+ value: Active
+ - label: Held
+ value: Held
+ - label: Terminated
+ value: Terminated
+ - label: Completed
+ value: Completed
+ - label: Cancelled
+ value: Cancelled
+ dynamic: false
+ allowNull: false
+ - id: bx53ezqrmy3FVrYr3HBSp1
+ sortOrder: 13
+ fieldKey: is_anonymous
+ label: Is Anonymous
+ type: BOOLEAN
+ description: Indicates whether the gift is anonymous.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.isAnonymous
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 5WNYgrUzd6eicnkN1tVjnG
+ sortOrder: 14
+ fieldKey: linked_gifts
+ label: Linked Gifts
+ type: STRING
+ description: >-
+ The recurring gift associated with the payment being added. When adding
+ a recurring gift payment, a linked_gifts field must be included as an
+ array of strings with the ID of the recurring gift to which the payment
+ is linked.
+ placeholder: ''
+ required: false
+ multiple: true
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: en4Ast3u9AoFyxf15tXiqm
+ sortOrder: 15
+ fieldKey: lookup_id
label: Lookup ID
type: STRING
description: The organization-defined identifier for the gift.
@@ -13640,517 +14151,6 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: frvqRyY6zVF4JaTDyABuya
- name: Create or Update Individual Constituent
- slug: createOrUpdateIndividualConstituent
- description: Create or update an Individual Constituent record in Raiser's Edge NXT.
- platform: CLOUD
- hidden: false
- defaultTrigger: type = "identify"
- fields:
- - id: uF9kJSd1nwYGFL6nmVKEBj
- sortOrder: 0
- fieldKey: address
- label: Address
- type: OBJECT
- description: The constituent's address.
- placeholder: ''
- defaultValue:
- address_lines:
- '@if':
- exists:
- '@path': $.traits.address.street
- then:
- '@path': $.traits.address.street
- else:
- '@path': $.properties.address.street
- city:
- '@if':
- exists:
- '@path': $.traits.address.city
- then:
- '@path': $.traits.address.city
- else:
- '@path': $.properties.address.city
- country:
- '@if':
- exists:
- '@path': $.traits.address.country
- then:
- '@path': $.traits.address.country
- else:
- '@path': $.properties.address.country
- do_not_mail: ''
- postal_code:
- '@if':
- exists:
- '@path': $.traits.address.postalCode
- then:
- '@path': $.traits.address.postalCode
- else:
- '@path': $.properties.address.postalCode
- primary: ''
- state:
- '@if':
- exists:
- '@path': $.traits.address.state
- then:
- '@path': $.traits.address.state
- else:
- '@path': $.properties.address.state
- type: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 51yJdQPHGTcZUZVATozRVV
- sortOrder: 1
- fieldKey: birthdate
- label: Birthdate
- type: DATETIME
- description: The constituent's birthdate.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.birthday
- then:
- '@path': $.traits.birthday
- else:
- '@path': $.properties.birthday
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: w2LBDs1zMyxU5Tw8kLb7Wv
- sortOrder: 2
- fieldKey: birthplace
- label: Birthplace
- type: STRING
- description: The birthplace of the constituent.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.birthplace
- then:
- '@path': $.traits.birthplace
- else:
- '@path': $.properties.birthplace
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: gv6wGUefGeepwjYTzfKTKM
- sortOrder: 3
- fieldKey: constituent_id
- label: Constituent ID
- type: STRING
- description: The ID of the constituent.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: mKZotNZShLKtP1dePKTQvD
- sortOrder: 4
- fieldKey: email
- label: Email
- type: OBJECT
- description: The constituent's email address.
- placeholder: ''
- defaultValue:
- address:
- '@if':
- exists:
- '@path': $.traits.email
- then:
- '@path': $.traits.email
- else:
- '@path': $.properties.email
- do_not_email: ''
- primary: ''
- type: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: scxzistF5TjnMaHwtmrwAY
- sortOrder: 5
- fieldKey: ethnicity
- label: Ethnicity
- type: STRING
- description: The ethnicity of the constituent.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.ethnicity
- then:
- '@path': $.traits.ethnicity
- else:
- '@path': $.properties.ethnicity
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: hZmJfzmGQjM5cLcWNM4NAK
- sortOrder: 6
- fieldKey: first
- label: First Name
- type: STRING
- description: The constituent's first name up to 50 characters.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.firstName
- then:
- '@path': $.traits.firstName
- else:
- '@path': $.properties.firstName
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 4S8MKU4o61ekqVuzdG5iB6
- sortOrder: 7
- fieldKey: former_name
- label: Former Name
- type: STRING
- description: The constituent's former name up to 100 characters.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.formerName
- then:
- '@path': $.traits.formerName
- else:
- '@path': $.properties.formerName
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: grogXhhRAN4y5tzcGQp6kn
- sortOrder: 8
- fieldKey: gender
- label: Gender
- type: STRING
- description: The constituent's gender.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.gender
- then:
- '@path': $.traits.gender
- else:
- '@path': $.properties.gender
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 8R71jnwRcDevSi1Zsrowfu
- sortOrder: 9
- fieldKey: gives_anonymously
- label: Gives Anonymously
- type: BOOLEAN
- description: Indicates whether the constituent gives anonymously.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.givesAnonymously
- then:
- '@path': $.traits.givesAnonymously
- else:
- '@path': $.properties.givesAnonymously
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: vaty6aWFQ6HWkN3UZ372N
- sortOrder: 10
- fieldKey: income
- label: Income
- type: STRING
- description: The constituent's income.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.income
- then:
- '@path': $.traits.income
- else:
- '@path': $.properties.income
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: iJhiCtqCGDTYk5FNgCahUT
- sortOrder: 11
- fieldKey: industry
- label: Industry
- type: STRING
- description: The constituent's industry.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.industry
- then:
- '@path': $.traits.industry
- else:
- '@path': $.properties.industry
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 46h75ELsbG36KTr11aD6JY
- sortOrder: 12
- fieldKey: last
- label: Last Name
- type: STRING
- description: >-
- The constituent's last name up to 100 characters. This is required to
- create a constituent.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.lastName
- then:
- '@path': $.traits.lastName
- else:
- '@path': $.properties.lastName
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: oBvqnjoMrxLSxCGr4rwmTD
- sortOrder: 13
- fieldKey: lookup_id
- label: Lookup ID
- type: STRING
- description: The organization-defined identifier for the constituent.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: mbzpjFApc1XGkBGg5bTCtK
- sortOrder: 14
- fieldKey: marital_status
- label: Marital Status
- type: STRING
- description: >-
- The constituent's marital status. Available values are the entries in
- the Marital Status table.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.maritalStatus
- then:
- '@path': $.traits.maritalStatus
- else:
- '@path': $.properties.maritalStatus
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: nH9J2uriHcuHEUNGV9ypfT
- sortOrder: 15
- fieldKey: online_presence
- label: Online Presence
- type: OBJECT
- description: The constituent's online presence.
- placeholder: ''
- defaultValue:
- address:
- '@if':
- exists:
- '@path': $.traits.website
- then:
- '@path': $.traits.website
- else:
- '@path': $.properties.website
- primary: ''
- type: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: cyy4Poxag4orLQZSRn8dw4
- sortOrder: 16
- fieldKey: phone
- label: Phone
- type: OBJECT
- description: The constituent's phone number.
- placeholder: ''
- defaultValue:
- do_not_call: ''
- number:
- '@if':
- exists:
- '@path': $.traits.phone
- then:
- '@path': $.traits.phone
- else:
- '@path': $.properties.phone
- primary: ''
- type: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 9CEjHzF6ZG3MyRTaiitzfX
- sortOrder: 17
- fieldKey: preferred_name
- label: Preferred Name
- type: STRING
- description: The constituent's preferred name up to 50 characters.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.preferredName
- then:
- '@path': $.traits.preferredName
- else:
- '@path': $.properties.preferredName
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 9uQ5iZ5omVD1JWpQmGao13
- sortOrder: 18
- fieldKey: religion
- label: Religion
- type: STRING
- description: The religion of the constituent.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.religion
- then:
- '@path': $.traits.religion
- else:
- '@path': $.properties.religion
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: nF9T8vJyL9NwnPHvVDyPrD
- sortOrder: 19
- fieldKey: suffix
- label: Suffix
- type: STRING
- description: >-
- The constituent's primary suffix. Available values are the entries in
- the Suffixes table.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.suffix
- then:
- '@path': $.traits.suffix
- else:
- '@path': $.properties.suffix
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: i9jJJ2X37tPHTBmq2cuR3L
- sortOrder: 20
- fieldKey: suffix_2
- label: Secondary Suffix
- type: STRING
- description: >-
- The constituent's secondary suffix. Available values are the entries in
- the Suffixes table.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.suffix2
- then:
- '@path': $.traits.suffix2
- else:
- '@path': $.properties.suffix2
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: sEF7X5HD47DrVNy2tdjCz8
- sortOrder: 21
- fieldKey: title
- label: Title
- type: STRING
- description: >-
- The constituent's primary title. Available values are the entries in the
- Titles table.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.title
- then:
- '@path': $.traits.title
- else:
- '@path': $.properties.title
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: sT8RCJ5PCMcr1Rh4vNXxth
- sortOrder: 22
- fieldKey: title_2
- label: Secondary Title
- type: STRING
- description: >-
- The constituent's secondary title. Available values are the entries in
- the Titles table.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.title2
- then:
- '@path': $.traits.title2
- else:
- '@path': $.properties.title2
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
presets: []
- id: 64244158b33d1380a79dc85c
display_name: Blend Ai
@@ -15508,73 +15508,6 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 7dNvUgwYkBjJjCrHHdo7jX
- name: Debounce Middleware
- slug: debouncePlugin
- description: >-
- When enabled, it ensures that only events where at least one changed trait
- value are sent to Braze, and events with duplicate traits are not sent.
- Debounce functionality requires a frontend client to work. Therefore, it
- cannot be used with server-side libraries or with Engage.
- platform: WEB
- hidden: false
- defaultTrigger: type = "identify" or type = "group"
- fields: []
- - id: sRxUEeJSMLSTBFD2cgYBms
- name: Identify User
- slug: identifyUser
- description: >-
- Identifies an unidentified (alias-only) user. Use alongside the Create
- Alias action, or with user aliases you have already defined.
- platform: CLOUD
- hidden: false
- defaultTrigger: null
- fields:
- - id: ukXQNXqkPLav2qN9zfmXfw
- sortOrder: 0
- fieldKey: external_id
- label: External ID
- type: STRING
- description: The external ID of the user to identify.
- placeholder: ''
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 2rXBxhuBDHVv82KqNhRJmd
- sortOrder: 1
- fieldKey: user_alias
- label: User Alias Object
- type: OBJECT
- description: >-
- A user alias object. See [the
- docs](https://www.braze.com/docs/api/objects_filters/user_alias_object/).
- placeholder: ''
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 7Nz86915iJrHd7opZu9dWM
- sortOrder: 2
- fieldKey: merge_behavior
- label: Merge Behavior
- type: STRING
- description: >-
- Sets the endpoint to merge some fields found exclusively on the
- anonymous user to the identified user. See [the
- docs](https://www.braze.com/docs/api/endpoints/user_data/post_user_identify/#request-parameters).
- placeholder: ''
- required: false
- multiple: false
- choices:
- - label: None
- value: none
- - label: Merge
- value: merge
- dynamic: false
- allowNull: false
- id: vE7Gf9yobj2gTuMBhwmg7g
name: Track Purchase
slug: trackPurchase
@@ -15711,6 +15644,73 @@ items:
choices: null
dynamic: false
allowNull: false
+ - id: 7dNvUgwYkBjJjCrHHdo7jX
+ name: Debounce Middleware
+ slug: debouncePlugin
+ description: >-
+ When enabled, it ensures that only events where at least one changed trait
+ value are sent to Braze, and events with duplicate traits are not sent.
+ Debounce functionality requires a frontend client to work. Therefore, it
+ cannot be used with server-side libraries or with Engage.
+ platform: WEB
+ hidden: false
+ defaultTrigger: type = "identify" or type = "group"
+ fields: []
+ - id: sRxUEeJSMLSTBFD2cgYBms
+ name: Identify User
+ slug: identifyUser
+ description: >-
+ Identifies an unidentified (alias-only) user. Use alongside the Create
+ Alias action, or with user aliases you have already defined.
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: null
+ fields:
+ - id: ukXQNXqkPLav2qN9zfmXfw
+ sortOrder: 0
+ fieldKey: external_id
+ label: External ID
+ type: STRING
+ description: The external ID of the user to identify.
+ placeholder: ''
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 2rXBxhuBDHVv82KqNhRJmd
+ sortOrder: 1
+ fieldKey: user_alias
+ label: User Alias Object
+ type: OBJECT
+ description: >-
+ A user alias object. See [the
+ docs](https://www.braze.com/docs/api/objects_filters/user_alias_object/).
+ placeholder: ''
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 7Nz86915iJrHd7opZu9dWM
+ sortOrder: 2
+ fieldKey: merge_behavior
+ label: Merge Behavior
+ type: STRING
+ description: >-
+ Sets the endpoint to merge some fields found exclusively on the
+ anonymous user to the identified user. See [the
+ docs](https://www.braze.com/docs/api/endpoints/user_data/post_user_identify/#request-parameters).
+ placeholder: ''
+ required: false
+ multiple: false
+ choices:
+ - label: None
+ value: none
+ - label: Merge
+ value: merge
+ dynamic: false
+ allowNull: false
- id: vp138DdA9188zfyXfhJe6x
name: Create Alias
slug: createAlias
@@ -17076,16 +17076,6 @@ items:
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:
@@ -17096,6 +17086,16 @@ items:
properties:
'@path': $.properties
trigger: type = "track"
+ - actionId: hvgMsbTryH7WBktAmpmKBE
+ name: Group
+ fields:
+ groupId:
+ '@path': $.groupId
+ userId:
+ '@path': $.userId
+ traits:
+ '@path': $.traits
+ trigger: type = "group"
- actionId: i1XWim52toRNFZBohWgJKv
name: Identify User
fields:
@@ -19359,14 +19359,6 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: cNMDdU1GCoZX5yAk57vt7U
- name: Report Web Event
- slug: reportWebEvent
- description: deprecated
- platform: WEB
- hidden: true
- defaultTrigger: type = "track"
- fields: []
- id: pvLKevrkEtiUZX3ej5FX8j
name: Identify User
slug: identifyUser
@@ -19440,6 +19432,14 @@ items:
choices: null
dynamic: false
allowNull: false
+ - id: cNMDdU1GCoZX5yAk57vt7U
+ name: Report Web Event
+ slug: reportWebEvent
+ description: deprecated
+ platform: WEB
+ hidden: true
+ defaultTrigger: type = "track"
+ fields: []
presets:
- actionId: pvLKevrkEtiUZX3ej5FX8j
name: Identify User
@@ -19842,231 +19842,6 @@ items:
required: true
label: User ID attribute key
actions:
- - id: 3M3WKUgTfYoa62dvhpPst4
- name: Upsert Order
- slug: upsertOrder
- description: Upserts order to Cordial
- platform: CLOUD
- hidden: false
- defaultTrigger: >-
- event = "Order Completed" or event = "Order Updated" or event = "Order
- Refunded" or event = "Order Cancelled"
- fields:
- - id: 9LoqmaHfYvp2zNz9m8mLAa
- sortOrder: 0
- fieldKey: segmentId
- label: Segment User ID
- type: STRING
- description: Segment User ID value
- placeholder: ''
- defaultValue:
- '@path': $.userId
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: uzS59BdzQfrHw1R1BBNJnp
- sortOrder: 1
- fieldKey: anonymousId
- label: Segment Anonymous ID
- type: STRING
- description: Segment Anonymous ID value
- placeholder: ''
- defaultValue:
- '@path': $.anonymousId
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: mAEWu8QV8eBrHAqJLzeBMZ
- sortOrder: 2
- fieldKey: userIdentities
- label: User Identities
- type: OBJECT
- description: >-
- An ordered list of contact identifiers in Cordial. Each item in the list
- represents an identifier. For example, `channels.email.address ->
- userId` and/or `customerId -> traits.customerId`. If a contact is found
- using the identifiers it is updated, otherwise a new contact is created.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 28JKLaDofBiAnBc7KFoM1n
- sortOrder: 3
- fieldKey: orderID
- label: Order ID
- type: STRING
- description: Internal identifier of an order
- placeholder: ''
- defaultValue:
- '@path': $.properties.order_id
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: u4cXTTXJxV6wYf1xWXtKfH
- sortOrder: 4
- fieldKey: purchaseDate
- label: Order purchase date
- type: DATETIME
- description: Order purchase date
- placeholder: ''
- defaultValue:
- '@path': $.timestamp
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: fSbSz2vk2dCRHh9uqQSeF7
- sortOrder: 5
- fieldKey: status
- label: Order status
- type: STRING
- description: Order status (e.g. completed/cancelled/returned)
- placeholder: ''
- defaultValue:
- '@path': $.event
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: pUYhvLdPGNu78PCFeicYa2
- sortOrder: 6
- fieldKey: totalAmount
- label: Order total
- type: NUMBER
- description: Order total amount
- placeholder: ''
- defaultValue:
- '@path': $.properties.total
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: oma7Uh8jacLVUsRGTevpmp
- sortOrder: 7
- fieldKey: properties
- label: Order properties
- type: OBJECT
- description: Additional order properties (e.g. affiliation/tax/revenue)
- placeholder: ''
- defaultValue:
- affiliation:
- '@path': $.properties.affiliation
- revenue:
- '@path': $.properties.revenue
- shipping:
- '@path': $.properties.shipping
- tax:
- '@path': $.properties.tax
- discount:
- '@path': $.properties.discount
- coupon:
- '@path': $.properties.coupon
- currency:
- '@path': $.properties.currency
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: xjFB4gTQCeuTTe42ayDHJX
- sortOrder: 8
- fieldKey: items
- label: Order items
- type: OBJECT
- description: Order items
- placeholder: ''
- defaultValue:
- '@arrayPath':
- - $.properties.products
- - productID:
- '@path': $.product_id
- sku:
- '@path': $.sku
- category:
- '@path': $.category
- name:
- '@path': $.name
- manufacturerNname:
- '@path': $.brand
- itemPrice:
- '@path': $.price
- qty:
- '@path': $.quantity
- url:
- '@path': $.url
- imageUrl:
- '@path': $.image_url
- properties:
- variant:
- '@path': $.variant
- coupon:
- '@path': $.coupon
- required: true
- multiple: true
- choices: null
- dynamic: false
- allowNull: false
- - id: 4DUFCLv2Bqb12EQ9srSN2u
- name: Merge Contacts
- slug: mergeContacts
- description: Merge contacts in Cordial.
- platform: CLOUD
- hidden: false
- defaultTrigger: type = "alias"
- fields:
- - id: sUu8qBPJFvNo1gseAsggxk
- sortOrder: 0
- fieldKey: segmentId
- label: New Segment User ID
- type: STRING
- description: New Segment User ID value
- placeholder: ''
- defaultValue:
- '@path': $.userId
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: qGLBjsF1jxC8tqSLYgGSRJ
- sortOrder: 1
- fieldKey: anonymousId
- label: New Segment Anonymous ID
- type: STRING
- description: New Segment Anonymous ID value
- placeholder: ''
- defaultValue:
- '@path': $.anonymousId
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 3YfDb4yA7irEhTvzWCitkQ
- sortOrder: 2
- fieldKey: previousId
- label: Previous Segment ID
- type: STRING
- description: Previous Segment User or Anonymous ID value
- placeholder: ''
- defaultValue:
- '@path': $.previousId
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- id: 6HYwVVhUZMLFmHnwsEznjR
name: Add Contact to List
slug: addContactToList
@@ -20334,15 +20109,15 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: nfkYJ2U1rHjp4GT1hPoRxc
- name: Remove Product from Cart
- slug: removeProductFromCart
- description: Removes product from Cordial contact cart
+ - id: us48j5ZJjcJZjfW6EKTm9Q
+ name: Upsert Contact
+ slug: upsertContact
+ description: Create or update a contact in Cordial.
platform: CLOUD
hidden: false
- defaultTrigger: type = "track" and event = "Product Removed"
+ defaultTrigger: type = "identify"
fields:
- - id: rQ7WJnzh1gkfqvyAtkTxsQ
+ - id: 6zdRBWiurrdq6dnrxCGT5u
sortOrder: 0
fieldKey: segmentId
label: Segment User ID
@@ -20356,7 +20131,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 6RQ1KfHvzzqFPxbQjQ2JS5
+ - id: 36NRB145zZ1LEndwzN3UYA
sortOrder: 1
fieldKey: anonymousId
label: Segment Anonymous ID
@@ -20370,7 +20145,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 54nhUHwVphF2y7Y7qkfCQt
+ - id: c5CYbAakApuCkZSzJEX4XD
sortOrder: 2
fieldKey: userIdentities
label: User Identities
@@ -20386,43 +20161,209 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: nnYTZFN9fcFKRktdfvukK9
+ - id: hSrtvEh6mkgj1rfzcLhGp8
sortOrder: 3
- fieldKey: productID
- label: Product ID
+ fieldKey: attributes
+ label: Contact Attributes
+ type: OBJECT
+ description: >-
+ Contact attributes to update. Optional. Contact attributes must exist in
+ Cordial prior to updating. Attributes that do not exist in Cordial will
+ be ignored. Complex attribute types to be mapped via dot notation, for
+ example, `cordialPerson.first_name -> traits.segmentPerson.firstName`,
+ `cordialPerson.last_name -> traits.segmentPerson.lastName`. Segment
+ trait address can be mapped directly to geo Cordial attribute:
+ `geo_cordial_attribute -> traits.address`.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 3M3WKUgTfYoa62dvhpPst4
+ name: Upsert Order
+ slug: upsertOrder
+ description: Upserts order to Cordial
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: >-
+ event = "Order Completed" or event = "Order Updated" or event = "Order
+ Refunded" or event = "Order Cancelled"
+ fields:
+ - id: 9LoqmaHfYvp2zNz9m8mLAa
+ sortOrder: 0
+ fieldKey: segmentId
+ label: Segment User ID
type: STRING
- description: Internal identifier of a product
+ description: Segment User ID value
placeholder: ''
defaultValue:
- '@path': $.properties.product_id
+ '@path': $.userId
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: uzS59BdzQfrHw1R1BBNJnp
+ sortOrder: 1
+ fieldKey: anonymousId
+ label: Segment Anonymous ID
+ type: STRING
+ description: Segment Anonymous ID value
+ placeholder: ''
+ defaultValue:
+ '@path': $.anonymousId
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: mAEWu8QV8eBrHAqJLzeBMZ
+ sortOrder: 2
+ fieldKey: userIdentities
+ label: User Identities
+ type: OBJECT
+ description: >-
+ An ordered list of contact identifiers in Cordial. Each item in the list
+ represents an identifier. For example, `channels.email.address ->
+ userId` and/or `customerId -> traits.customerId`. If a contact is found
+ using the identifiers it is updated, otherwise a new contact is created.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 28JKLaDofBiAnBc7KFoM1n
+ sortOrder: 3
+ fieldKey: orderID
+ label: Order ID
+ type: STRING
+ description: Internal identifier of an order
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.order_id
required: true
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: hS5nc3CgiUcY7o76r4DquH
+ - id: u4cXTTXJxV6wYf1xWXtKfH
sortOrder: 4
- fieldKey: qty
- label: Quantity
- type: INTEGER
- description: Quantity of a product
+ fieldKey: purchaseDate
+ label: Order purchase date
+ type: DATETIME
+ description: Order purchase date
placeholder: ''
defaultValue:
- '@path': $.properties.quantity
+ '@path': $.timestamp
required: true
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: us48j5ZJjcJZjfW6EKTm9Q
- name: Upsert Contact
- slug: upsertContact
- description: Create or update a contact in Cordial.
+ - id: fSbSz2vk2dCRHh9uqQSeF7
+ sortOrder: 5
+ fieldKey: status
+ label: Order status
+ type: STRING
+ description: Order status (e.g. completed/cancelled/returned)
+ placeholder: ''
+ defaultValue:
+ '@path': $.event
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: pUYhvLdPGNu78PCFeicYa2
+ sortOrder: 6
+ fieldKey: totalAmount
+ label: Order total
+ type: NUMBER
+ description: Order total amount
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.total
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: oma7Uh8jacLVUsRGTevpmp
+ sortOrder: 7
+ fieldKey: properties
+ label: Order properties
+ type: OBJECT
+ description: Additional order properties (e.g. affiliation/tax/revenue)
+ placeholder: ''
+ defaultValue:
+ affiliation:
+ '@path': $.properties.affiliation
+ revenue:
+ '@path': $.properties.revenue
+ shipping:
+ '@path': $.properties.shipping
+ tax:
+ '@path': $.properties.tax
+ discount:
+ '@path': $.properties.discount
+ coupon:
+ '@path': $.properties.coupon
+ currency:
+ '@path': $.properties.currency
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: xjFB4gTQCeuTTe42ayDHJX
+ sortOrder: 8
+ fieldKey: items
+ label: Order items
+ type: OBJECT
+ description: Order items
+ placeholder: ''
+ defaultValue:
+ '@arrayPath':
+ - $.properties.products
+ - productID:
+ '@path': $.product_id
+ sku:
+ '@path': $.sku
+ category:
+ '@path': $.category
+ name:
+ '@path': $.name
+ manufacturerNname:
+ '@path': $.brand
+ itemPrice:
+ '@path': $.price
+ qty:
+ '@path': $.quantity
+ url:
+ '@path': $.url
+ imageUrl:
+ '@path': $.image_url
+ properties:
+ variant:
+ '@path': $.variant
+ coupon:
+ '@path': $.coupon
+ required: true
+ multiple: true
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: nfkYJ2U1rHjp4GT1hPoRxc
+ name: Remove Product from Cart
+ slug: removeProductFromCart
+ description: Removes product from Cordial contact cart
platform: CLOUD
hidden: false
- defaultTrigger: type = "identify"
+ defaultTrigger: type = "track" and event = "Product Removed"
fields:
- - id: 6zdRBWiurrdq6dnrxCGT5u
+ - id: rQ7WJnzh1gkfqvyAtkTxsQ
sortOrder: 0
fieldKey: segmentId
label: Segment User ID
@@ -20436,7 +20377,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 36NRB145zZ1LEndwzN3UYA
+ - id: 6RQ1KfHvzzqFPxbQjQ2JS5
sortOrder: 1
fieldKey: anonymousId
label: Segment Anonymous ID
@@ -20450,7 +20391,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: c5CYbAakApuCkZSzJEX4XD
+ - id: 54nhUHwVphF2y7Y7qkfCQt
sortOrder: 2
fieldKey: userIdentities
label: User Identities
@@ -20466,21 +20407,30 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: hSrtvEh6mkgj1rfzcLhGp8
+ - id: nnYTZFN9fcFKRktdfvukK9
sortOrder: 3
- fieldKey: attributes
- label: Contact Attributes
- type: OBJECT
- description: >-
- Contact attributes to update. Optional. Contact attributes must exist in
- Cordial prior to updating. Attributes that do not exist in Cordial will
- be ignored. Complex attribute types to be mapped via dot notation, for
- example, `cordialPerson.first_name -> traits.segmentPerson.firstName`,
- `cordialPerson.last_name -> traits.segmentPerson.lastName`. Segment
- trait address can be mapped directly to geo Cordial attribute:
- `geo_cordial_attribute -> traits.address`.
+ fieldKey: productID
+ label: Product ID
+ type: STRING
+ description: Internal identifier of a product
placeholder: ''
- required: false
+ defaultValue:
+ '@path': $.properties.product_id
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: hS5nc3CgiUcY7o76r4DquH
+ sortOrder: 4
+ fieldKey: qty
+ label: Quantity
+ type: INTEGER
+ description: Quantity of a product
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.quantity
+ required: true
multiple: false
choices: null
dynamic: false
@@ -20680,6 +20630,56 @@ items:
choices: null
dynamic: false
allowNull: false
+ - id: 4DUFCLv2Bqb12EQ9srSN2u
+ name: Merge Contacts
+ slug: mergeContacts
+ description: Merge contacts in Cordial.
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: type = "alias"
+ fields:
+ - id: sUu8qBPJFvNo1gseAsggxk
+ sortOrder: 0
+ fieldKey: segmentId
+ label: New Segment User ID
+ type: STRING
+ description: New Segment User ID value
+ placeholder: ''
+ defaultValue:
+ '@path': $.userId
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: qGLBjsF1jxC8tqSLYgGSRJ
+ sortOrder: 1
+ fieldKey: anonymousId
+ label: New Segment Anonymous ID
+ type: STRING
+ description: New Segment Anonymous ID value
+ placeholder: ''
+ defaultValue:
+ '@path': $.anonymousId
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 3YfDb4yA7irEhTvzWCitkQ
+ sortOrder: 2
+ fieldKey: previousId
+ label: Previous Segment ID
+ type: STRING
+ description: Previous Segment User or Anonymous ID value
+ placeholder: ''
+ defaultValue:
+ '@path': $.previousId
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
presets: []
- id: 60df6d4c038b872f10c54801
display_name: Correlated
@@ -21868,103 +21868,6 @@ items:
required: true
label: Site ID
actions:
- - id: bYpBhuXizNTPeBLwoJ1RxZ
- name: Track Page View
- slug: trackPageView
- description: Track a page view for a known or anonymous person.
- platform: CLOUD
- hidden: false
- defaultTrigger: type = "page"
- fields:
- - id: 4dWDqmt9MwmMybYafZtRon
- sortOrder: 0
- fieldKey: id
- label: Person ID
- type: STRING
- description: >-
- The ID used to uniquely identify a person in Customer.io. [Learn
- more](https://customer.io/docs/identifying-people/#identifiers).
- placeholder: ''
- defaultValue:
- '@path': $.userId
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: akzw6vdU67RAD79B2iR1k3
- sortOrder: 1
- fieldKey: anonymous_id
- label: Anonymous ID
- type: STRING
- description: >-
- An anonymous ID for when no Person ID exists. [Learn
- more](https://customer.io/docs/anonymous-events/).
- placeholder: ''
- defaultValue:
- '@path': $.anonymousId
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: ayF1C4BLLJ6fMhPRnbk51b
- sortOrder: 2
- fieldKey: url
- label: Page URL
- type: STRING
- description: The URL of the page visited.
- placeholder: ''
- defaultValue:
- '@path': $.properties.url
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: jUKCuwDASoNSwrqB4cBxtX
- sortOrder: 3
- fieldKey: timestamp
- label: Timestamp
- type: STRING
- description: >-
- A timestamp of when the event took place. Default is current date and
- time.
- placeholder: ''
- defaultValue:
- '@path': $.timestamp
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: qTfzZwZaTzV2TorCNv7En7
- sortOrder: 4
- fieldKey: data
- label: Event Attributes
- type: OBJECT
- description: Optional data to include with the event.
- placeholder: ''
- defaultValue:
- '@path': $.properties
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 4k6CnJ92awWrqMra5frQsu
- sortOrder: 5
- fieldKey: convert_timestamp
- label: Convert Timestamps
- type: BOOLEAN
- description: Convert dates to Unix timestamps (seconds since Epoch).
- placeholder: ''
- defaultValue: true
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- id: k4Xb8oym74V59L3n6YmkQe
name: Create or Update Person
slug: createUpdatePerson
@@ -22100,42 +22003,6 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: kHtCvAgiKSBNGShFzW5Wwo
- name: Delete Device
- slug: deleteDevice
- description: Track an "Application Uninstalled" event to delete a person's device.
- platform: CLOUD
- hidden: false
- defaultTrigger: event = "Application Uninstalled"
- fields:
- - id: wyR6EpxqLHLGL18pqmXvJ
- sortOrder: 0
- fieldKey: person_id
- label: Person ID
- type: STRING
- description: The ID of the person that this mobile device belongs to.
- placeholder: ''
- defaultValue:
- '@path': $.userId
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 96U3urbb5HsLtjvQCV56jE
- sortOrder: 1
- fieldKey: device_id
- label: Device ID
- type: STRING
- description: The device token of a customer's mobile device.
- placeholder: ''
- defaultValue:
- '@path': $.context.device.token
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- id: ni61rg53jNVHceAAKpAMiU
name: Track Event
slug: trackEvent
@@ -22344,6 +22211,139 @@ items:
choices: null
dynamic: false
allowNull: false
+ - id: bYpBhuXizNTPeBLwoJ1RxZ
+ name: Track Page View
+ slug: trackPageView
+ description: Track a page view for a known or anonymous person.
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: type = "page"
+ fields:
+ - id: 4dWDqmt9MwmMybYafZtRon
+ sortOrder: 0
+ fieldKey: id
+ label: Person ID
+ type: STRING
+ description: >-
+ The ID used to uniquely identify a person in Customer.io. [Learn
+ more](https://customer.io/docs/identifying-people/#identifiers).
+ placeholder: ''
+ defaultValue:
+ '@path': $.userId
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: akzw6vdU67RAD79B2iR1k3
+ sortOrder: 1
+ fieldKey: anonymous_id
+ label: Anonymous ID
+ type: STRING
+ description: >-
+ An anonymous ID for when no Person ID exists. [Learn
+ more](https://customer.io/docs/anonymous-events/).
+ placeholder: ''
+ defaultValue:
+ '@path': $.anonymousId
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: ayF1C4BLLJ6fMhPRnbk51b
+ sortOrder: 2
+ fieldKey: url
+ label: Page URL
+ type: STRING
+ description: The URL of the page visited.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.url
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: jUKCuwDASoNSwrqB4cBxtX
+ sortOrder: 3
+ fieldKey: timestamp
+ label: Timestamp
+ type: STRING
+ description: >-
+ A timestamp of when the event took place. Default is current date and
+ time.
+ placeholder: ''
+ defaultValue:
+ '@path': $.timestamp
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: qTfzZwZaTzV2TorCNv7En7
+ sortOrder: 4
+ fieldKey: data
+ label: Event Attributes
+ type: OBJECT
+ description: Optional data to include with the event.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 4k6CnJ92awWrqMra5frQsu
+ sortOrder: 5
+ fieldKey: convert_timestamp
+ label: Convert Timestamps
+ type: BOOLEAN
+ description: Convert dates to Unix timestamps (seconds since Epoch).
+ placeholder: ''
+ defaultValue: true
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: kHtCvAgiKSBNGShFzW5Wwo
+ name: Delete Device
+ slug: deleteDevice
+ description: Track an "Application Uninstalled" event to delete a person's device.
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: event = "Application Uninstalled"
+ fields:
+ - id: wyR6EpxqLHLGL18pqmXvJ
+ sortOrder: 0
+ fieldKey: person_id
+ label: Person ID
+ type: STRING
+ description: The ID of the person that this mobile device belongs to.
+ placeholder: ''
+ defaultValue:
+ '@path': $.userId
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 96U3urbb5HsLtjvQCV56jE
+ sortOrder: 1
+ fieldKey: device_id
+ label: Device ID
+ type: STRING
+ description: The device token of a customer's mobile device.
+ placeholder: ''
+ defaultValue:
+ '@path': $.context.device.token
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
- id: sqJbxd67L97ZpX6N8wphL3
name: Track Screen View
slug: trackScreenView
@@ -30403,58 +30403,6 @@ items:
required: true
label: Friendbuy Merchant ID
actions:
- - id: fk2xKEXiXd9qEkQb24nzXh
- name: Track Page
- slug: trackPage
- description: >-
- Record when a customer visits a new page. Allow Friendbuy widget targeting
- by Page Name instead of URL.
- platform: WEB
- hidden: false
- defaultTrigger: type = "page"
- fields:
- - id: 9m4ebCrh63BiJ5JZfHfLjx
- sortOrder: 0
- fieldKey: name
- label: Page Name
- type: STRING
- description: The page name.
- placeholder: ''
- defaultValue:
- '@path': $.name
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: gpbuBNz73y2QzrqcKAssZK
- sortOrder: 1
- fieldKey: category
- label: Page Category
- type: STRING
- description: The page category.
- placeholder: ''
- defaultValue:
- '@path': $.category
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: ja1bDYBCX5nbifXwAARRwu
- sortOrder: 2
- fieldKey: title
- label: Page Title
- type: STRING
- description: The page title.
- placeholder: ''
- defaultValue:
- '@path': $.properties.title
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- id: jK3iMvwwXbgAz1EBm9Akq6
name: Track Custom Event
slug: trackCustomEvent
@@ -31326,6 +31274,58 @@ items:
choices: null
dynamic: false
allowNull: false
+ - id: fk2xKEXiXd9qEkQb24nzXh
+ name: Track Page
+ slug: trackPage
+ description: >-
+ Record when a customer visits a new page. Allow Friendbuy widget targeting
+ by Page Name instead of URL.
+ platform: WEB
+ hidden: false
+ defaultTrigger: type = "page"
+ fields:
+ - id: 9m4ebCrh63BiJ5JZfHfLjx
+ sortOrder: 0
+ fieldKey: name
+ label: Page Name
+ type: STRING
+ description: The page name.
+ placeholder: ''
+ defaultValue:
+ '@path': $.name
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: gpbuBNz73y2QzrqcKAssZK
+ sortOrder: 1
+ fieldKey: category
+ label: Page Category
+ type: STRING
+ description: The page category.
+ placeholder: ''
+ defaultValue:
+ '@path': $.category
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: ja1bDYBCX5nbifXwAARRwu
+ sortOrder: 2
+ fieldKey: title
+ label: Page Title
+ type: STRING
+ description: The page title.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.title
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
presets:
- actionId: fk2xKEXiXd9qEkQb24nzXh
name: Track Page
@@ -31863,86 +31863,6 @@ items:
required: true
label: API Key
actions:
- - id: cG4Pxw8gkhTWa8i7ZF6bx7
- name: Identify User V2
- slug: identifyUserV2
- description: >-
- Sets user identity variables. Creates a new FullStory user if no user
- matching the given uid is found.
- platform: CLOUD
- hidden: false
- defaultTrigger: type = "identify"
- fields:
- - id: hdqpUQpHXHXzW3SWgLvLB6
- sortOrder: 0
- fieldKey: uid
- label: User ID
- type: STRING
- description: The user's id
- placeholder: ''
- defaultValue:
- '@path': $.userId
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 6GM5mcAEi5H6QKPa3Xa3Vp
- sortOrder: 1
- fieldKey: anonymousId
- label: Anonymous ID
- type: STRING
- description: The user's anonymous id
- placeholder: ''
- defaultValue:
- '@path': $.anonymousId
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: w7AVjQt8N8rB6FEvtzDWYw
- sortOrder: 2
- fieldKey: displayName
- label: Display Name
- type: STRING
- description: The user's display name
- placeholder: ''
- defaultValue:
- '@path': $.traits.name
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 2mfzzFS8f9QRSmf1VGudvB
- sortOrder: 3
- fieldKey: email
- label: Email
- type: STRING
- description: The user's email
- placeholder: ''
- defaultValue:
- '@path': $.traits.email
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: pha43kfJRfhBHoJpmrRKMv
- sortOrder: 4
- fieldKey: properties
- label: Traits
- type: OBJECT
- description: The Segment traits to be forwarded to FullStory
- placeholder: ''
- defaultValue:
- '@path': $.traits
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- id: cQzjeG68Cd8ah9pDvBHRWi
name: Track Event
slug: trackEvent
@@ -32118,6 +32038,86 @@ items:
choices: null
dynamic: false
allowNull: false
+ - id: cG4Pxw8gkhTWa8i7ZF6bx7
+ name: Identify User V2
+ slug: identifyUserV2
+ description: >-
+ Sets user identity variables. Creates a new FullStory user if no user
+ matching the given uid is found.
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: type = "identify"
+ fields:
+ - id: hdqpUQpHXHXzW3SWgLvLB6
+ sortOrder: 0
+ fieldKey: uid
+ label: User ID
+ type: STRING
+ description: The user's id
+ placeholder: ''
+ defaultValue:
+ '@path': $.userId
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 6GM5mcAEi5H6QKPa3Xa3Vp
+ sortOrder: 1
+ fieldKey: anonymousId
+ label: Anonymous ID
+ type: STRING
+ description: The user's anonymous id
+ placeholder: ''
+ defaultValue:
+ '@path': $.anonymousId
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: w7AVjQt8N8rB6FEvtzDWYw
+ sortOrder: 2
+ fieldKey: displayName
+ label: Display Name
+ type: STRING
+ description: The user's display name
+ placeholder: ''
+ defaultValue:
+ '@path': $.traits.name
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 2mfzzFS8f9QRSmf1VGudvB
+ sortOrder: 3
+ fieldKey: email
+ label: Email
+ type: STRING
+ description: The user's email
+ placeholder: ''
+ defaultValue:
+ '@path': $.traits.email
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: pha43kfJRfhBHoJpmrRKMv
+ sortOrder: 4
+ fieldKey: properties
+ label: Traits
+ type: OBJECT
+ description: The Segment traits to be forwarded to FullStory
+ placeholder: ''
+ defaultValue:
+ '@path': $.traits
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
- id: tSQynH2dL7wcoWdwYhLdE5
name: Track Event V2
slug: trackEventV2
@@ -32580,6 +32580,16 @@ items:
required: true
label: Data center
actions:
+ - id: LT28CpGtgs7XSBexKwDQg
+ name: Group Identify User
+ slug: groupIdentify
+ description: >-
+ Updates or adds properties to an account. The account is created if it
+ does not exist.
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: type = "group"
+ fields: []
- id: 3DbbbPpxoV8QLWnXRufobi
name: Identify User
slug: identifyUser
@@ -32588,15 +32598,21 @@ items:
hidden: false
defaultTrigger: type = "identify"
fields: []
- - id: LT28CpGtgs7XSBexKwDQg
- name: Group Identify User
- slug: groupIdentify
- description: >-
- Updates or adds properties to an account. The account is created if it
- does not exist.
+ - id: fHzJV5FLDWfZnE6SfwtaA7
+ name: Track Event
+ slug: trackEvent
+ description: Send an event to Gainsight PX
platform: CLOUD
hidden: false
- defaultTrigger: type = "group"
+ defaultTrigger: type = "track"
+ fields: []
+ - id: wqBksQwpL1YXNj5oHyrVHW
+ name: Track Page View
+ slug: trackPageView
+ description: Send a page view event to Gainsight PX
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: type = "page"
fields: []
- id: dhiJmXMos6JC66bCunuKb1
name: Send Event
@@ -32620,22 +32636,6 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: fHzJV5FLDWfZnE6SfwtaA7
- name: Track Event
- slug: trackEvent
- description: Send an event to Gainsight PX
- platform: CLOUD
- hidden: false
- defaultTrigger: type = "track"
- fields: []
- - id: wqBksQwpL1YXNj5oHyrVHW
- name: Track Page View
- slug: trackPageView
- description: Send a page view event to Gainsight PX
- platform: CLOUD
- hidden: false
- defaultTrigger: type = "page"
- fields: []
presets:
- actionId: dhiJmXMos6JC66bCunuKb1
name: Track Page View
@@ -33578,6 +33578,323 @@ items:
required: true
label: Customer ID
actions:
+ - id: h8sh7d7TUJYR1uv6RKZTGQ
+ name: Upload Enhanced Conversion (Legacy)
+ slug: postConversion
+ description: >-
+ Upload a conversion enhancement to the legacy Google Enhanced Conversions
+ API.
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: null
+ fields:
+ - id: tnH4Nm18zNBTDW2i5vamtr
+ sortOrder: 0
+ fieldKey: conversion_label
+ label: Conversion Label
+ type: STRING
+ description: >-
+ The Google Ads conversion label. You can find it in your Google Ads
+ account using the instructions in the article [Google Ads
+ conversions](https://support.google.com/tagmanager/answer/6105160?hl=en).
+ placeholder: ''
+ defaultValue: ''
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: q4EVFsCzqnHuJrNPJnqr51
+ sortOrder: 1
+ fieldKey: email
+ label: Email
+ type: STRING
+ description: Email address of the individual who triggered the conversion event.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.properties.email
+ then:
+ '@path': $.properties.email
+ else:
+ '@path': $.traits.email
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: pxMz3xgCuvdvVSyK6Rxi6U
+ sortOrder: 2
+ fieldKey: transaction_id
+ label: Order ID
+ type: STRING
+ description: >-
+ Order ID or Transaction ID of the conversion event. Google requires an
+ Order ID even if the event is not an ecommerce event. Learn more in the
+ article [Use a transaction ID to minimize duplicate
+ conversions](https://support.google.com/google-ads/answer/6386790?hl=en&ref_topic=3165803).
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.orderId
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: dGhkPPX72RMLkLBBbZasqU
+ sortOrder: 3
+ fieldKey: user_agent
+ label: User Agent
+ type: STRING
+ description: >-
+ User agent of the individual who triggered the conversion event. This
+ should match the user agent of the request that sent the original
+ conversion so the conversion and its enhancement are either both
+ attributed as same-device or both attributed as cross-device. This field
+ is optional but recommended.
+ placeholder: ''
+ defaultValue:
+ '@path': $.context.userAgent
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 2BtTx6EHAkeoArYsPL9fbv
+ sortOrder: 4
+ fieldKey: conversion_time
+ label: Conversion Time
+ type: DATETIME
+ description: Timestamp of the conversion event.
+ placeholder: ''
+ defaultValue:
+ '@path': $.timestamp
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: hFjKLykCCuABkjTd97bSo8
+ sortOrder: 5
+ fieldKey: value
+ label: Value
+ type: NUMBER
+ description: The monetary value attributed to the conversion event.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.total
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: rKgBGFHUhThQmrg1cwue5h
+ sortOrder: 6
+ fieldKey: currency_code
+ label: Currency Code
+ type: STRING
+ description: >-
+ Currency of the purchase or items associated with the conversion event,
+ in 3-letter ISO 4217 format.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.currency
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 6kFKoceCMxez6ipL9xcn2d
+ sortOrder: 7
+ fieldKey: is_app_incrementality
+ label: App Conversion for Incrementality Study
+ type: BOOLEAN
+ description: Set to true if this is an app conversion for an incrementality study.
+ placeholder: ''
+ defaultValue: false
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: tCBHXTG948QZ7zCeQkUtpf
+ sortOrder: 8
+ fieldKey: pcc_game
+ label: PCC Game Flag
+ type: BOOLEAN
+ description: >-
+ Alpha feature offered by Google for gaming industry. When set to true,
+ Segment will send pcc_game = 1 to Google.
+ placeholder: ''
+ defaultValue: false
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 8UfwXcX1rqXKMiMPkosckX
+ sortOrder: 9
+ fieldKey: phone_number
+ label: Phone Number
+ type: STRING
+ description: >-
+ Phone number of the individual who triggered the conversion event, in
+ E.164 standard format, e.g. +14150000000.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.properties.phone
+ then:
+ '@path': $.properties.phone
+ else:
+ '@path': $.traits.phone
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: xmqPB7NySPKcinU7y128wP
+ sortOrder: 10
+ fieldKey: first_name
+ label: First Name
+ type: STRING
+ description: First name of the individual who triggered the conversion event.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.properties.firstName
+ then:
+ '@path': $.properties.firstName
+ else:
+ '@path': $.traits.firstName
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: r3mYQ5w9cxaW4gxfwd3Xet
+ sortOrder: 11
+ fieldKey: last_name
+ label: Last Name
+ type: STRING
+ description: Last name of the individual who triggered the conversion event.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.properties.lastName
+ then:
+ '@path': $.properties.lastName
+ else:
+ '@path': $.traits.lastName
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: mEyBNtDKeJEXAUXNSiTRdx
+ sortOrder: 12
+ fieldKey: street_address
+ label: Street Address
+ type: STRING
+ description: Street address of the individual who triggered the conversion event.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.properties.address.street
+ then:
+ '@path': $.properties.address.street
+ else:
+ '@path': $.traits.address.street
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: anYcbzaDQMPfx7NuSWiWaY
+ sortOrder: 13
+ fieldKey: city
+ label: City
+ type: STRING
+ description: City of the individual who triggered the conversion event.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.properties.address.city
+ then:
+ '@path': $.properties.address.city
+ else:
+ '@path': $.traits.address.city
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: e4kbaxBGfQTEdQeD9bqMC8
+ sortOrder: 14
+ fieldKey: region
+ label: Region
+ type: STRING
+ description: Region of the individual who triggered the conversion event.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.properties.address.state
+ then:
+ '@path': $.properties.address.state
+ else:
+ '@path': $.traits.address.state
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: aqHhSAAuLB7usksS75XQVw
+ sortOrder: 15
+ fieldKey: post_code
+ label: Postal Code
+ type: STRING
+ description: Postal code of the individual who triggered the conversion event.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.properties.address.postalCode
+ then:
+ '@path': $.properties.address.postalCode
+ else:
+ '@path': $.traits.address.postalCode
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: mux2fXqeWNf6dzYhuhr2i9
+ sortOrder: 16
+ fieldKey: country
+ label: Country
+ type: STRING
+ description: Country of the individual who triggered the conversion event.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.properties.address.country
+ then:
+ '@path': $.properties.address.country
+ else:
+ '@path': $.traits.address.country
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
- id: 2n3RKy5oyzS1kLdEEYV99N
name: Upload Conversion Adjustment
slug: uploadConversionAdjustment
@@ -34227,323 +34544,6 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: h8sh7d7TUJYR1uv6RKZTGQ
- name: Upload Enhanced Conversion (Legacy)
- slug: postConversion
- description: >-
- Upload a conversion enhancement to the legacy Google Enhanced Conversions
- API.
- platform: CLOUD
- hidden: false
- defaultTrigger: null
- fields:
- - id: tnH4Nm18zNBTDW2i5vamtr
- sortOrder: 0
- fieldKey: conversion_label
- label: Conversion Label
- type: STRING
- description: >-
- The Google Ads conversion label. You can find it in your Google Ads
- account using the instructions in the article [Google Ads
- conversions](https://support.google.com/tagmanager/answer/6105160?hl=en).
- placeholder: ''
- defaultValue: ''
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: q4EVFsCzqnHuJrNPJnqr51
- sortOrder: 1
- fieldKey: email
- label: Email
- type: STRING
- description: Email address of the individual who triggered the conversion event.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.properties.email
- then:
- '@path': $.properties.email
- else:
- '@path': $.traits.email
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: pxMz3xgCuvdvVSyK6Rxi6U
- sortOrder: 2
- fieldKey: transaction_id
- label: Order ID
- type: STRING
- description: >-
- Order ID or Transaction ID of the conversion event. Google requires an
- Order ID even if the event is not an ecommerce event. Learn more in the
- article [Use a transaction ID to minimize duplicate
- conversions](https://support.google.com/google-ads/answer/6386790?hl=en&ref_topic=3165803).
- placeholder: ''
- defaultValue:
- '@path': $.properties.orderId
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: dGhkPPX72RMLkLBBbZasqU
- sortOrder: 3
- fieldKey: user_agent
- label: User Agent
- type: STRING
- description: >-
- User agent of the individual who triggered the conversion event. This
- should match the user agent of the request that sent the original
- conversion so the conversion and its enhancement are either both
- attributed as same-device or both attributed as cross-device. This field
- is optional but recommended.
- placeholder: ''
- defaultValue:
- '@path': $.context.userAgent
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 2BtTx6EHAkeoArYsPL9fbv
- sortOrder: 4
- fieldKey: conversion_time
- label: Conversion Time
- type: DATETIME
- description: Timestamp of the conversion event.
- placeholder: ''
- defaultValue:
- '@path': $.timestamp
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: hFjKLykCCuABkjTd97bSo8
- sortOrder: 5
- fieldKey: value
- label: Value
- type: NUMBER
- description: The monetary value attributed to the conversion event.
- placeholder: ''
- defaultValue:
- '@path': $.properties.total
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: rKgBGFHUhThQmrg1cwue5h
- sortOrder: 6
- fieldKey: currency_code
- label: Currency Code
- type: STRING
- description: >-
- Currency of the purchase or items associated with the conversion event,
- in 3-letter ISO 4217 format.
- placeholder: ''
- defaultValue:
- '@path': $.properties.currency
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 6kFKoceCMxez6ipL9xcn2d
- sortOrder: 7
- fieldKey: is_app_incrementality
- label: App Conversion for Incrementality Study
- type: BOOLEAN
- description: Set to true if this is an app conversion for an incrementality study.
- placeholder: ''
- defaultValue: false
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: tCBHXTG948QZ7zCeQkUtpf
- sortOrder: 8
- fieldKey: pcc_game
- label: PCC Game Flag
- type: BOOLEAN
- description: >-
- Alpha feature offered by Google for gaming industry. When set to true,
- Segment will send pcc_game = 1 to Google.
- placeholder: ''
- defaultValue: false
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 8UfwXcX1rqXKMiMPkosckX
- sortOrder: 9
- fieldKey: phone_number
- label: Phone Number
- type: STRING
- description: >-
- Phone number of the individual who triggered the conversion event, in
- E.164 standard format, e.g. +14150000000.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.properties.phone
- then:
- '@path': $.properties.phone
- else:
- '@path': $.traits.phone
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: xmqPB7NySPKcinU7y128wP
- sortOrder: 10
- fieldKey: first_name
- label: First Name
- type: STRING
- description: First name of the individual who triggered the conversion event.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.properties.firstName
- then:
- '@path': $.properties.firstName
- else:
- '@path': $.traits.firstName
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: r3mYQ5w9cxaW4gxfwd3Xet
- sortOrder: 11
- fieldKey: last_name
- label: Last Name
- type: STRING
- description: Last name of the individual who triggered the conversion event.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.properties.lastName
- then:
- '@path': $.properties.lastName
- else:
- '@path': $.traits.lastName
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: mEyBNtDKeJEXAUXNSiTRdx
- sortOrder: 12
- fieldKey: street_address
- label: Street Address
- type: STRING
- description: Street address of the individual who triggered the conversion event.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.properties.address.street
- then:
- '@path': $.properties.address.street
- else:
- '@path': $.traits.address.street
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: anYcbzaDQMPfx7NuSWiWaY
- sortOrder: 13
- fieldKey: city
- label: City
- type: STRING
- description: City of the individual who triggered the conversion event.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.properties.address.city
- then:
- '@path': $.properties.address.city
- else:
- '@path': $.traits.address.city
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: e4kbaxBGfQTEdQeD9bqMC8
- sortOrder: 14
- fieldKey: region
- label: Region
- type: STRING
- description: Region of the individual who triggered the conversion event.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.properties.address.state
- then:
- '@path': $.properties.address.state
- else:
- '@path': $.traits.address.state
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: aqHhSAAuLB7usksS75XQVw
- sortOrder: 15
- fieldKey: post_code
- label: Postal Code
- type: STRING
- description: Postal code of the individual who triggered the conversion event.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.properties.address.postalCode
- then:
- '@path': $.properties.address.postalCode
- else:
- '@path': $.traits.address.postalCode
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: mux2fXqeWNf6dzYhuhr2i9
- sortOrder: 16
- fieldKey: country
- label: Country
- type: STRING
- description: Country of the individual who triggered the conversion event.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.properties.address.country
- then:
- '@path': $.properties.address.country
- else:
- '@path': $.traits.address.country
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- id: uEYL2A2fTEoxCzYmsRwRmT
name: Upload Call Conversion
slug: uploadCallConversion
@@ -34809,15 +34809,15 @@ items:
required: true
label: Measurement ID
actions:
- - id: 21Vhf5XWiD5aLnzvq4k9yy
- name: Page View
- slug: pageView
- description: Send page view when a user views a page
+ - id: 6CHmQRmGR9QiQAAVPzukE9
+ name: Add to Cart
+ slug: addToCart
+ description: Send event when a user adds items to a cart
platform: CLOUD
hidden: false
- defaultTrigger: type = "page"
+ defaultTrigger: type = "track" and event = "Product Added"
fields:
- - id: ptXpTB8AYA3TueTLdjxnKo
+ - id: c2h4RzpAGTxtHwTBKirTVY
sortOrder: 0
fieldKey: data_stream_type
label: Data Stream Type
@@ -34836,7 +34836,7 @@ items:
value: Mobile App
dynamic: false
allowNull: false
- - id: eaDXdrf7mSbyGCvUYrQ68G
+ - id: i99L9BUzz1yVPNm6rXqgh8
sortOrder: 1
fieldKey: app_instance_id
label: Firebase App Instance ID
@@ -34851,9 +34851,9 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 6LcYbpi9x19XRzmjd1qnAf
+ - id: FPZLG2FPSqqYdH5Upxcei
sortOrder: 2
- fieldKey: clientId
+ fieldKey: client_id
label: Client ID
type: STRING
description: >-
@@ -34873,7 +34873,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 47aecDi7AZuuEFUmgxA5H
+ - id: 2M7KXxFyFwg4EGCui4PXGs
sortOrder: 3
fieldKey: user_id
label: User ID
@@ -34890,7 +34890,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: vR8B64r2NY4z8Me7VB8PVg
+ - id: hoBxA6gpWpmnCrzJ9RffJd
sortOrder: 4
fieldKey: timestamp_micros
label: Event Timestamp
@@ -34907,36 +34907,71 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: anyjpVmsMRx3cTRLV75o1B
+ - id: fdBT82cgyEwcquZoX6yn3n
sortOrder: 5
- fieldKey: page_location
- label: Page Location
+ fieldKey: currency
+ label: Currency
type: STRING
- description: The current page URL
+ description: >-
+ Currency of the items associated with the event, in 3-letter ISO 4217
+ format.
placeholder: ''
defaultValue:
- '@path': $.context.page.url
+ '@path': $.properties.currency
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: 5r9BwCTaB63r7QRSktBokW
+ - id: 8qcvqZS6q8pXuYHkafqdvd
sortOrder: 6
- fieldKey: page_referrer
- label: Page Referrer
- type: STRING
- description: Previous page URL
+ fieldKey: items
+ label: Products
+ type: OBJECT
+ description: The list of products purchased.
placeholder: ''
defaultValue:
- '@path': $.context.page.referrer
+ '@arrayPath':
+ - $.properties
+ - item_id:
+ '@path': $.product_id
+ item_name:
+ '@path': $.name
+ affiliation:
+ '@path': $.affiliation
+ coupon:
+ '@path': $.coupon
+ item_brand:
+ '@path': $.brand
+ item_category:
+ '@path': $.category
+ item_variant:
+ '@path': $.variant
+ price:
+ '@path': $.price
+ quantity:
+ '@path': $.quantity
+ required: true
+ multiple: true
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 81rsdpwChM9tCn8raxVwMs
+ sortOrder: 7
+ fieldKey: value
+ label: Value
+ type: NUMBER
+ description: The monetary value of the event.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.value
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: 7xrFHH46piWu42cjHXXWGv
- sortOrder: 7
+ - id: hEAegpAgdvZHxdc6yhnsmE
+ sortOrder: 8
fieldKey: user_properties
label: User Properties
type: OBJECT
@@ -34952,21 +34987,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: ivxxeci3mJ7Aws6E55VNEJ
- sortOrder: 8
- fieldKey: page_title
- label: Page Title
- type: STRING
- description: The current page title
- placeholder: ''
- defaultValue:
- '@path': $.context.page.title
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 414wdrq7NG424riTiC5gNj
+ - id: 5xeeojg86kre4TF3Pv8gsv
sortOrder: 9
fieldKey: engagement_time_msec
label: Engagement Time in Milliseconds
@@ -34983,7 +35004,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: tS4ftWTGWWJHnPwikiutcH
+ - id: edCHDC95XfUgXTu7frH8Ps
sortOrder: 10
fieldKey: params
label: Event Parameters
@@ -34995,15 +35016,15 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 3TuhpcSioLxgD95gTwi3D6
- name: Select Promotion
- slug: selectPromotion
- description: Send event when a user selects a promotion
+ - id: ktHJRgMzTxdVu3SsB8mD2A
+ name: Purchase
+ slug: purchase
+ description: Send event when a user completes a purchase
platform: CLOUD
hidden: false
- defaultTrigger: type = "track" and event = "Promotion Clicked"
+ defaultTrigger: type = "track" and event = "Order Completed"
fields:
- - id: tA8wbRS26DzJpaJ6HRijDM
+ - id: 4YNffhEH1S3tUzjvM5YBAn
sortOrder: 0
fieldKey: data_stream_type
label: Data Stream Type
@@ -35022,7 +35043,7 @@ items:
value: Mobile App
dynamic: false
allowNull: false
- - id: Xi7oPv4hsFoCRxWzdcm6
+ - id: n467C9zpz8TkUZPDjriQ
sortOrder: 1
fieldKey: app_instance_id
label: Firebase App Instance ID
@@ -35037,7 +35058,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 9dqy1fyTiq5bgwBZ2qKj58
+ - id: oraqUvtnprUZKTozLZAdoF
sortOrder: 2
fieldKey: client_id
label: Client ID
@@ -35059,7 +35080,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: p9WW9Wa6W9uZaEpHT5TaA1
+ - id: 8LMDs6CDzRfd5UNZPVQDv1
sortOrder: 3
fieldKey: user_id
label: User ID
@@ -35076,7 +35097,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: m4396kvjNu1ehnurJKtjJy
+ - id: nHwxTV4WTUL7sdkjAFLvpQ
sortOrder: 4
fieldKey: timestamp_micros
label: Event Timestamp
@@ -35093,74 +35114,54 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 6BhEjG7ZUJHTM8ja9i2CsC
+ - id: NuFRz7ZNbK8MtXETnGy4f
sortOrder: 5
- fieldKey: creative_name
- label: Creative Name
+ fieldKey: affiliation
+ label: Affiliation
type: STRING
- description: The name of the promotional creative.
+ description: >-
+ Store or affiliation from which this transaction occurred (e.g. Google
+ Store).
placeholder: ''
+ defaultValue:
+ '@path': $.properties.affiliation
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: ebBQsNTMMoGSfMQBZDSxsV
+ - id: vD61JaT6dqrqqYupmtikim
sortOrder: 6
- fieldKey: creative_slot
- label: Creative Slot
+ fieldKey: coupon
+ label: Coupon
type: STRING
- description: The name of the promotional creative slot associated with the event.
+ description: Coupon code used for a purchase.
placeholder: ''
defaultValue:
- '@path': $.properties.creative
+ '@path': $.properties.coupon
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: 8dLKNKHDJUV7w4KVvUHV9p
+ - id: cBoh1PMs76g1D16QQdy8Dc
sortOrder: 7
- fieldKey: location_id
- label: Location ID
- type: STRING
- description: The ID of the location.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 7gLaer5rUHfNgHzDr9ToMN
- sortOrder: 8
- fieldKey: promotion_id
- label: Promotion ID
- type: STRING
- description: The ID of the promotion associated with the event.
- placeholder: ''
- defaultValue:
- '@path': $.properties.promotion_id
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: t9bk9GDHtmt1K6Ppk2aSQK
- sortOrder: 9
- fieldKey: promotion_name
- label: Promotion Name
+ fieldKey: currency
+ label: Currency
type: STRING
- description: The name of the promotion associated with the event.
+ description: >-
+ Currency of the items associated with the event, in 3-letter ISO 4217
+ format.
placeholder: ''
defaultValue:
- '@path': $.properties.name
- required: false
+ '@path': $.properties.currency
+ required: true
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: xojU3tiZBTzmPZZ52iEMZm
- sortOrder: 10
+ - id: cxUqwK4e3TPmkm4p8hssE
+ sortOrder: 8
fieldKey: items
label: Products
type: OBJECT
@@ -35168,7 +35169,7 @@ items:
placeholder: ''
defaultValue:
'@arrayPath':
- - $.properties
+ - $.properties.products
- item_id:
'@path': $.product_id
item_name:
@@ -35177,6 +35178,8 @@ items:
'@path': $.affiliation
coupon:
'@path': $.coupon
+ index:
+ '@path': $.position
item_brand:
'@path': $.brand
item_category:
@@ -35187,13 +35190,69 @@ items:
'@path': $.price
quantity:
'@path': $.quantity
- required: false
+ required: true
multiple: true
choices: null
dynamic: false
allowNull: false
- - id: 5SmfX7NFcuaFYUhZ9oGRTb
+ - id: 4X17nWsswJipGGRSD9gu7
+ sortOrder: 9
+ fieldKey: transaction_id
+ label: Order Id
+ type: STRING
+ description: The unique identifier of a transaction.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.order_id
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: urUJnsEwMgTmeaJ4BoBSAU
+ sortOrder: 10
+ fieldKey: shipping
+ label: Shipping
+ type: NUMBER
+ description: Shipping cost associated with the transaction.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.shipping
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: aXKcGgfoqhhzudFXo5nkfs
sortOrder: 11
+ fieldKey: tax
+ label: Tax
+ type: NUMBER
+ description: Total tax associated with the transaction.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.tax
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: wwRwpoS6NfNGfU7vGc4ksH
+ sortOrder: 12
+ fieldKey: value
+ label: Value
+ type: NUMBER
+ description: The monetary value of the event.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.total
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: pAsKQMBBFbsYwQ8QEnuVpv
+ sortOrder: 13
fieldKey: user_properties
label: User Properties
type: OBJECT
@@ -35209,8 +35268,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 3gt8AAuexiDB6hdgdrYZej
- sortOrder: 12
+ - id: 9b4njsQkttWS67iDj948TJ
+ sortOrder: 14
fieldKey: engagement_time_msec
label: Engagement Time in Milliseconds
type: NUMBER
@@ -35226,8 +35285,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: jXsAv4ZopG4zPigkoxMLRF
- sortOrder: 13
+ - id: vf2o4c1YSF8eRh1Eto2r8Y
+ sortOrder: 15
fieldKey: params
label: Event Parameters
type: OBJECT
@@ -35238,15 +35297,15 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 4HudviPyb7R2RWPsiWvPVq
- name: View Item List
- slug: viewItemList
- description: Send event when a user views a list of items or offerings
+ - id: 21Vhf5XWiD5aLnzvq4k9yy
+ name: Page View
+ slug: pageView
+ description: Send page view when a user views a page
platform: CLOUD
hidden: false
- defaultTrigger: type = "track" and event = "Product List Viewed"
+ defaultTrigger: type = "page"
fields:
- - id: vneJhdhmFEo9TcjzGg7Fdg
+ - id: ptXpTB8AYA3TueTLdjxnKo
sortOrder: 0
fieldKey: data_stream_type
label: Data Stream Type
@@ -35265,7 +35324,7 @@ items:
value: Mobile App
dynamic: false
allowNull: false
- - id: 433bRJWsWFcExpoWbF5NGZ
+ - id: eaDXdrf7mSbyGCvUYrQ68G
sortOrder: 1
fieldKey: app_instance_id
label: Firebase App Instance ID
@@ -35280,9 +35339,9 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 5ppHnM6aTZt1HzXRFnAEVv
+ - id: 6LcYbpi9x19XRzmjd1qnAf
sortOrder: 2
- fieldKey: client_id
+ fieldKey: clientId
label: Client ID
type: STRING
description: >-
@@ -35302,7 +35361,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: fmAkkFJFTKuszE2t1Dung9
+ - id: 47aecDi7AZuuEFUmgxA5H
sortOrder: 3
fieldKey: user_id
label: User ID
@@ -35319,7 +35378,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: vkU1KAWeU41oyAeg55WPey
+ - id: vR8B64r2NY4z8Me7VB8PVg
sortOrder: 4
fieldKey: timestamp_micros
label: Event Timestamp
@@ -35336,36 +35395,260 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: mrz4A87xYH27rc17rKp9hZ
+ - id: anyjpVmsMRx3cTRLV75o1B
sortOrder: 5
- fieldKey: item_list_id
- label: Item List ID
+ fieldKey: page_location
+ label: Page Location
type: STRING
- description: The ID of the list in which the item was presented to the user.
+ description: The current page URL
placeholder: ''
defaultValue:
- '@path': $.properties.list_id
+ '@path': $.context.page.url
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: ncjpg5D9hUTZnAoDVdd4Qo
+ - id: 5r9BwCTaB63r7QRSktBokW
sortOrder: 6
- fieldKey: item_list_name
- label: Item List Name
+ fieldKey: page_referrer
+ label: Page Referrer
type: STRING
- description: The name of the list in which the item was presented to the user.
+ description: Previous page URL
placeholder: ''
defaultValue:
- '@path': $.properties.category
+ '@path': $.context.page.referrer
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: patSnNiPp4hsRqv3gtCTzW
+ - id: 7xrFHH46piWu42cjHXXWGv
sortOrder: 7
+ fieldKey: user_properties
+ label: User Properties
+ type: OBJECT
+ description: >-
+ The user properties to send to Google Analytics 4. You must create
+ user-scoped dimensions to ensure custom properties are picked up by
+ Google. See Google’s [Custom user
+ properties](https://support.google.com/analytics/answer/9269570) to
+ learn how to set and register user properties.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: ivxxeci3mJ7Aws6E55VNEJ
+ sortOrder: 8
+ fieldKey: page_title
+ label: Page Title
+ type: STRING
+ description: The current page title
+ placeholder: ''
+ defaultValue:
+ '@path': $.context.page.title
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 414wdrq7NG424riTiC5gNj
+ sortOrder: 9
+ fieldKey: engagement_time_msec
+ label: Engagement Time in Milliseconds
+ type: NUMBER
+ description: >-
+ The amount of time a user interacted with your site, in milliseconds.
+ Google only counts users who interact with your site for a non-zero
+ amount of time. By default, Segment sets engagement time to 1 so users
+ are counted.
+ placeholder: ''
+ defaultValue: 1
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: tS4ftWTGWWJHnPwikiutcH
+ sortOrder: 10
+ fieldKey: params
+ label: Event Parameters
+ type: OBJECT
+ description: The event parameters to send to Google Analytics 4.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 3TuhpcSioLxgD95gTwi3D6
+ name: Select Promotion
+ slug: selectPromotion
+ description: Send event when a user selects a promotion
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: type = "track" and event = "Promotion Clicked"
+ fields:
+ - id: tA8wbRS26DzJpaJ6HRijDM
+ sortOrder: 0
+ fieldKey: data_stream_type
+ label: Data Stream Type
+ type: STRING
+ description: >-
+ The type of data stream this data belongs in. This can either be a web
+ stream or a mobile app stream (iOS or Android).
+ placeholder: ''
+ defaultValue: Web
+ required: false
+ multiple: false
+ choices:
+ - label: Web
+ value: Web
+ - label: Mobile App
+ value: Mobile App
+ dynamic: false
+ allowNull: false
+ - id: Xi7oPv4hsFoCRxWzdcm6
+ sortOrder: 1
+ fieldKey: app_instance_id
+ label: Firebase App Instance ID
+ type: STRING
+ description: >-
+ Uniquely identifies a specific installation of a Firebase app. This
+ value needs to be retrieved through the Firebase SDK. **Required for
+ mobile app streams.**
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 9dqy1fyTiq5bgwBZ2qKj58
+ sortOrder: 2
+ fieldKey: client_id
+ label: Client ID
+ type: STRING
+ description: >-
+ Uniquely identifies a user instance of a web client. **Required for web
+ streams.**
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.userId
+ then:
+ '@path': $.userId
+ else:
+ '@path': $.anonymousId
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: p9WW9Wa6W9uZaEpHT5TaA1
+ sortOrder: 3
+ fieldKey: user_id
+ label: User ID
+ type: STRING
+ description: >-
+ A unique identifier for a user. See Google's [User-ID for cross-platform
+ analysis](https://support.google.com/analytics/answer/9213390) and
+ [Reporting: deduplicate user
+ counts](https://support.google.com/analytics/answer/9355949?hl=en)
+ documentation for more information on this identifier.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: m4396kvjNu1ehnurJKtjJy
+ sortOrder: 4
+ fieldKey: timestamp_micros
+ label: Event Timestamp
+ type: STRING
+ description: >-
+ A Unix timestamp (in microseconds) for the time to associate with the
+ event. Segment will convert to Unix if not already converted. Events can
+ be backdated up to 3 calendar days based on the property's timezone.
+ placeholder: ''
+ defaultValue:
+ '@path': $.timestamp
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 6BhEjG7ZUJHTM8ja9i2CsC
+ sortOrder: 5
+ fieldKey: creative_name
+ label: Creative Name
+ type: STRING
+ description: The name of the promotional creative.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: ebBQsNTMMoGSfMQBZDSxsV
+ sortOrder: 6
+ fieldKey: creative_slot
+ label: Creative Slot
+ type: STRING
+ description: The name of the promotional creative slot associated with the event.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.creative
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 8dLKNKHDJUV7w4KVvUHV9p
+ sortOrder: 7
+ fieldKey: location_id
+ label: Location ID
+ type: STRING
+ description: The ID of the location.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 7gLaer5rUHfNgHzDr9ToMN
+ sortOrder: 8
+ fieldKey: promotion_id
+ label: Promotion ID
+ type: STRING
+ description: The ID of the promotion associated with the event.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.promotion_id
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: t9bk9GDHtmt1K6Ppk2aSQK
+ sortOrder: 9
+ fieldKey: promotion_name
+ label: Promotion Name
+ type: STRING
+ description: The name of the promotion associated with the event.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.name
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: xojU3tiZBTzmPZZ52iEMZm
+ sortOrder: 10
fieldKey: items
label: Products
type: OBJECT
@@ -35373,7 +35656,7 @@ items:
placeholder: ''
defaultValue:
'@arrayPath':
- - $.properties.products
+ - $.properties
- item_id:
'@path': $.product_id
item_name:
@@ -35382,8 +35665,6 @@ items:
'@path': $.affiliation
coupon:
'@path': $.coupon
- index:
- '@path': $.position
item_brand:
'@path': $.brand
item_category:
@@ -35394,13 +35675,13 @@ items:
'@path': $.price
quantity:
'@path': $.quantity
- required: true
+ required: false
multiple: true
choices: null
dynamic: false
allowNull: false
- - id: bgARaEXrUk9CAAFmxg3Vta
- sortOrder: 8
+ - id: 5SmfX7NFcuaFYUhZ9oGRTb
+ sortOrder: 11
fieldKey: user_properties
label: User Properties
type: OBJECT
@@ -35416,8 +35697,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: uTyafHcXMFwfqGTN8mqbsD
- sortOrder: 9
+ - id: 3gt8AAuexiDB6hdgdrYZej
+ sortOrder: 12
fieldKey: engagement_time_msec
label: Engagement Time in Milliseconds
type: NUMBER
@@ -35433,8 +35714,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: j9Rz3bYhEvVnXyRvyZhQgt
- sortOrder: 10
+ - id: jXsAv4ZopG4zPigkoxMLRF
+ sortOrder: 13
fieldKey: params
label: Event Parameters
type: OBJECT
@@ -35668,15 +35949,15 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 5oPdBsFNJRsrxVh17oPFPm
- name: Refund
- slug: refund
- description: Send event when a refund is issued
+ - id: h4zXXRRkchxkVGvtqdgzKe
+ name: View Item
+ slug: viewItem
+ description: Send event when a user views an item
platform: CLOUD
hidden: false
- defaultTrigger: type = "track" and event = "Order Refunded"
+ defaultTrigger: type = "track" and event = "Product Viewed"
fields:
- - id: dqTmAJvBcg2f86sVaSqt3f
+ - id: aCEWbAuEvJCL5iLaBDhRi2
sortOrder: 0
fieldKey: data_stream_type
label: Data Stream Type
@@ -35695,7 +35976,7 @@ items:
value: Mobile App
dynamic: false
allowNull: false
- - id: kFgWNcTgd3KnGpEDfTw1Uq
+ - id: 2N5zB78ffBiUQSLRvsroR2
sortOrder: 1
fieldKey: app_instance_id
label: Firebase App Instance ID
@@ -35710,7 +35991,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: mqi1ThbNTzK1Z7nRf6MZWx
+ - id: pF8Yc9dWZYFSDhufwm4FoE
sortOrder: 2
fieldKey: client_id
label: Client ID
@@ -35732,7 +36013,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: g3JXjS58LQQvi29gBviijr
+ - id: nQJeguNSzFVnLZKYikhzXL
sortOrder: 3
fieldKey: user_id
label: User ID
@@ -35749,7 +36030,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 7d8CpK4iNbE37hL26atDfv
+ - id: qXUnkJWtcVQaeBzCcCnE1E
sortOrder: 4
fieldKey: timestamp_micros
label: Event Timestamp
@@ -35766,7 +36047,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: gUGAQmwUCPwroQddVh7aR5
+ - id: ojNR1C5f8UDt1tuajzmyAV
sortOrder: 5
fieldKey: currency
label: Currency
@@ -35782,125 +36063,236 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 6HUvwvBPyzj26D65KDSnEc
+ - id: b7Vck9dHTArzA293Zqeob3
sortOrder: 6
- fieldKey: transaction_id
- label: Order Id
- type: STRING
- description: The unique identifier of a transaction.
+ fieldKey: value
+ label: Value
+ type: NUMBER
+ description: The monetary value of the event.
placeholder: ''
defaultValue:
- '@path': $.properties.order_id
- required: true
+ '@path': $.properties.value
+ required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: nGFT6zByN964qmQZShTfwj
+ - id: iSzBsK3RsK5qugQe6qRU1q
sortOrder: 7
- fieldKey: value
- label: Value
- type: NUMBER
- description: The monetary value of the event.
+ fieldKey: items
+ label: Products
+ type: OBJECT
+ description: The list of products purchased.
placeholder: ''
defaultValue:
- '@path': $.properties.total
- required: false
- multiple: false
+ '@arrayPath':
+ - $.properties
+ - item_id:
+ '@path': $.product_id
+ item_name:
+ '@path': $.name
+ affiliation:
+ '@path': $.affiliation
+ coupon:
+ '@path': $.coupon
+ item_brand:
+ '@path': $.brand
+ item_category:
+ '@path': $.category
+ item_variant:
+ '@path': $.variant
+ price:
+ '@path': $.price
+ quantity:
+ '@path': $.quantity
+ required: true
+ multiple: true
choices: null
dynamic: false
allowNull: false
- - id: 8ZSNFG7K3Mt6jSuChT8Crg
+ - id: aLWhS92JFcrRcfEcNH7map
sortOrder: 8
- fieldKey: affiliation
- label: Affiliation
- type: STRING
+ fieldKey: user_properties
+ label: User Properties
+ type: OBJECT
description: >-
- Store or affiliation from which this transaction occurred (e.g. Google
- Store).
+ The user properties to send to Google Analytics 4. You must create
+ user-scoped dimensions to ensure custom properties are picked up by
+ Google. See Google’s [Custom user
+ properties](https://support.google.com/analytics/answer/9269570) to
+ learn how to set and register user properties.
placeholder: ''
- defaultValue:
- '@path': $.properties.affiliation
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: 2qn8PG1voGFAV8xgvN6u8G
+ - id: wcMFEiHTs36Rg5aULVCNRT
sortOrder: 9
- fieldKey: coupon
- label: Coupon
- type: STRING
- description: Coupon code used for a purchase.
+ fieldKey: engagement_time_msec
+ label: Engagement Time in Milliseconds
+ type: NUMBER
+ description: >-
+ The amount of time a user interacted with your site, in milliseconds.
+ Google only counts users who interact with your site for a non-zero
+ amount of time. By default, Segment sets engagement time to 1 so users
+ are counted.
placeholder: ''
+ defaultValue: 1
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: jr41W8YDWtivU1vjY98ctn
+ - id: mC6dYsoEs3ru85hBW6QT4n
sortOrder: 10
- fieldKey: shipping
- label: Shipping
- type: NUMBER
- description: Shipping cost associated with the transaction.
+ fieldKey: params
+ label: Event Parameters
+ type: OBJECT
+ description: The event parameters to send to Google Analytics 4.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: tNPRvBDTsfszvJQy6kE9K3
+ name: Custom Event
+ slug: customEvent
+ description: Send any custom event
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: type = "track"
+ fields:
+ - id: qCc4gRyfC7dP3gafcsAgQT
+ sortOrder: 0
+ fieldKey: data_stream_type
+ label: Data Stream Type
+ type: STRING
+ description: >-
+ The type of data stream this data belongs in. This can either be a web
+ stream or a mobile app stream (iOS or Android).
+ placeholder: ''
+ defaultValue: Web
+ required: false
+ multiple: false
+ choices:
+ - label: Web
+ value: Web
+ - label: Mobile App
+ value: Mobile App
+ dynamic: false
+ allowNull: false
+ - id: aHusyGsyfL9Nz74gfJGaYh
+ sortOrder: 1
+ fieldKey: app_instance_id
+ label: Firebase App Instance ID
+ type: STRING
+ description: >-
+ Uniquely identifies a specific installation of a Firebase app. This
+ value needs to be retrieved through the Firebase SDK. **Required for
+ mobile app streams.**
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: uAHfnJ1hbhRgeC4b5Ka7uL
+ sortOrder: 2
+ fieldKey: clientId
+ label: Client ID
+ type: STRING
+ description: >-
+ Uniquely identifies a user instance of a web client. **Required for web
+ streams.**
placeholder: ''
defaultValue:
- '@path': $.properties.shipping
+ '@if':
+ exists:
+ '@path': $.userId
+ then:
+ '@path': $.userId
+ else:
+ '@path': $.anonymousId
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: jD3AJ3ffy3iEhmEmXkgos2
- sortOrder: 11
- fieldKey: tax
- label: Tax
- type: NUMBER
- description: Tax cost associated with a transaction.
+ - id: denyXnu9NjTNmfqtQiMjSt
+ sortOrder: 3
+ fieldKey: user_id
+ label: User ID
+ type: STRING
+ description: >-
+ A unique identifier for a user. See Google's [User-ID for cross-platform
+ analysis](https://support.google.com/analytics/answer/9213390) and
+ [Reporting: deduplicate user
+ counts](https://support.google.com/analytics/answer/9355949?hl=en)
+ documentation for more information on this identifier.
placeholder: ''
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: ekSWoE8e9ir5Et9UT1aehM
- sortOrder: 12
- fieldKey: items
- label: Products
- type: OBJECT
- description: The list of products purchased.
+ - id: 6oc5yTGkpyJT9nT1FERisw
+ sortOrder: 4
+ fieldKey: timestamp_micros
+ label: Event Timestamp
+ type: STRING
+ description: >-
+ A Unix timestamp (in microseconds) for the time to associate with the
+ event. Segment will convert to Unix if not already converted. Events can
+ be backdated up to 3 calendar days based on the property's timezone.
placeholder: ''
defaultValue:
- '@arrayPath':
- - $.properties.products
- - item_id:
- '@path': $.product_id
- item_name:
- '@path': $.name
- affiliation:
- '@path': $.affiliation
- coupon:
- '@path': $.coupon
- index:
- '@path': $.position
- item_brand:
- '@path': $.brand
- item_category:
- '@path': $.category
- item_variant:
- '@path': $.variant
- price:
- '@path': $.price
- quantity:
- '@path': $.quantity
+ '@path': $.timestamp
required: false
- multiple: true
+ multiple: false
choices: null
dynamic: false
allowNull: false
- - id: bkUr8iptpoDbcFWUGs17pu
- sortOrder: 13
+ - id: 4oyFfqecoLhrQWRhTCXGvA
+ sortOrder: 5
+ fieldKey: name
+ label: Event Name
+ type: STRING
+ description: >-
+ The unique name of the custom event created in GA4. GA4 does not accept
+ spaces in event names so Segment will replace any spaces with
+ underscores. More information about GA4 event name rules is available in
+ [their
+ docs](https://support.google.com/analytics/answer/10085872?hl=en&ref_topic=9756175#event-name-rules&zippy=%2Cin-this-article.%2Cin-this-article).
+ placeholder: ''
+ defaultValue:
+ '@path': $.event
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: isejGrCmGayNPZbqsKfCYD
+ sortOrder: 6
+ fieldKey: lowercase
+ label: Lowercase Event Name
+ type: BOOLEAN
+ description: >-
+ If true, the event name will be converted to lowercase before sending to
+ Google. Event names are case sensitive in GA4 so enable this setting to
+ avoid distinct events for casing differences. More information about GA4
+ event name rules is available in [their
+ docs](https://support.google.com/analytics/answer/10085872?hl=en&ref_topic=9756175#event-name-rules&zippy=%2Cin-this-article.%2Cin-this-article).
+ placeholder: ''
+ defaultValue: false
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: nz6koocrWTfSYBvv9WPJJk
+ sortOrder: 7
fieldKey: user_properties
label: User Properties
type: OBJECT
@@ -35916,8 +36308,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: shwWJoD1TNLDHcnDYwZBet
- sortOrder: 14
+ - id: nWakudsXbt9Ehtuhganp3X
+ sortOrder: 8
fieldKey: engagement_time_msec
label: Engagement Time in Milliseconds
type: NUMBER
@@ -35933,8 +36325,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 6V4azUPvPfkJUvqEKMZBrd
- sortOrder: 15
+ - id: kxTXZs6UthjJDdeTTwHUro
+ sortOrder: 9
fieldKey: params
label: Event Parameters
type: OBJECT
@@ -35945,15 +36337,15 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 6CHmQRmGR9QiQAAVPzukE9
- name: Add to Cart
- slug: addToCart
- description: Send event when a user adds items to a cart
+ - id: xBj1Vpdp5BWErfezRDxczN
+ name: Select Item
+ slug: selectItem
+ description: Send event when a user selects an item from a list
platform: CLOUD
hidden: false
- defaultTrigger: type = "track" and event = "Product Added"
+ defaultTrigger: type = "track" and event = "Product Clicked"
fields:
- - id: c2h4RzpAGTxtHwTBKirTVY
+ - id: 8LaCwvi5z3QUk5AFSHjPdK
sortOrder: 0
fieldKey: data_stream_type
label: Data Stream Type
@@ -35972,7 +36364,7 @@ items:
value: Mobile App
dynamic: false
allowNull: false
- - id: i99L9BUzz1yVPNm6rXqgh8
+ - id: vBM5U4Sio3trz5u2KD4owF
sortOrder: 1
fieldKey: app_instance_id
label: Firebase App Instance ID
@@ -35987,7 +36379,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: FPZLG2FPSqqYdH5Upxcei
+ - id: wsi1AWiUw28TZnvtTu9EdJ
sortOrder: 2
fieldKey: client_id
label: Client ID
@@ -36009,7 +36401,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 2M7KXxFyFwg4EGCui4PXGs
+ - id: 46Tg6DdsEduZun4JMgq49v
sortOrder: 3
fieldKey: user_id
label: User ID
@@ -36026,7 +36418,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: hoBxA6gpWpmnCrzJ9RffJd
+ - id: 5dCfY6r7wzm6YSm1s8LfMR
sortOrder: 4
fieldKey: timestamp_micros
label: Event Timestamp
@@ -36043,24 +36435,32 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: fdBT82cgyEwcquZoX6yn3n
+ - id: 3GbWv3UXCjFEcDmB2ktBsb
sortOrder: 5
- fieldKey: currency
- label: Currency
+ fieldKey: item_list_name
+ label: Item List Name
type: STRING
- description: >-
- Currency of the items associated with the event, in 3-letter ISO 4217
- format.
+ description: The name of the list in which the item was presented to the user.
placeholder: ''
- defaultValue:
- '@path': $.properties.currency
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: 8qcvqZS6q8pXuYHkafqdvd
+ - id: itUkLrV6PNTr2F7hqaivKM
sortOrder: 6
+ fieldKey: item_list_id
+ label: Item List Id
+ type: STRING
+ description: The ID of the list in which the item was presented to the user.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 76zQbXvjXCxuabfXSMeokD
+ sortOrder: 7
fieldKey: items
label: Products
type: OBJECT
@@ -36092,21 +36492,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 81rsdpwChM9tCn8raxVwMs
- sortOrder: 7
- fieldKey: value
- label: Value
- type: NUMBER
- description: The monetary value of the event.
- placeholder: ''
- defaultValue:
- '@path': $.properties.value
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: hEAegpAgdvZHxdc6yhnsmE
+ - id: niqPbJADWwzWu4WTbetmYd
sortOrder: 8
fieldKey: user_properties
label: User Properties
@@ -36123,7 +36509,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 5xeeojg86kre4TF3Pv8gsv
+ - id: qcAW1H6eCc3psQMpG8pn6F
sortOrder: 9
fieldKey: engagement_time_msec
label: Engagement Time in Milliseconds
@@ -36140,7 +36526,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: edCHDC95XfUgXTu7frH8Ps
+ - id: bMveGq5YrZrrUJ13RSwM2i
sortOrder: 10
fieldKey: params
label: Event Parameters
@@ -36152,15 +36538,15 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 784GCiEtK8isdAU6VHkzPw
- name: Add Payment Info
- slug: addPaymentInfo
- description: Send event when a user submits their payment information
+ - id: 4HudviPyb7R2RWPsiWvPVq
+ name: View Item List
+ slug: viewItemList
+ description: Send event when a user views a list of items or offerings
platform: CLOUD
hidden: false
- defaultTrigger: type = "track" and event = "Payment Info Entered"
+ defaultTrigger: type = "track" and event = "Product List Viewed"
fields:
- - id: fWToXnZtM8zH1Pw7a1LH7L
+ - id: vneJhdhmFEo9TcjzGg7Fdg
sortOrder: 0
fieldKey: data_stream_type
label: Data Stream Type
@@ -36179,7 +36565,7 @@ items:
value: Mobile App
dynamic: false
allowNull: false
- - id: dZkQPuBXy4ESkQWLKPDWCi
+ - id: 433bRJWsWFcExpoWbF5NGZ
sortOrder: 1
fieldKey: app_instance_id
label: Firebase App Instance ID
@@ -36194,7 +36580,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: pVvNGfyHUFsmz3xnFkN8hD
+ - id: 5ppHnM6aTZt1HzXRFnAEVv
sortOrder: 2
fieldKey: client_id
label: Client ID
@@ -36216,7 +36602,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: cyaRqKic9Cpxqb3peBq1Sw
+ - id: fmAkkFJFTKuszE2t1Dung9
sortOrder: 3
fieldKey: user_id
label: User ID
@@ -36233,7 +36619,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: bvnKU4NaD9MDHijNe2sHQQ
+ - id: vkU1KAWeU41oyAeg55WPey
sortOrder: 4
fieldKey: timestamp_micros
label: Event Timestamp
@@ -36250,64 +36636,36 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: egYyeEm7VctdGHJYaJuZ8T
+ - id: mrz4A87xYH27rc17rKp9hZ
sortOrder: 5
- fieldKey: currency
- label: Currency
+ fieldKey: item_list_id
+ label: Item List ID
type: STRING
- description: >-
- Currency of the items associated with the event, in 3-letter ISO 4217
- format.
+ description: The ID of the list in which the item was presented to the user.
placeholder: ''
defaultValue:
- '@path': $.properties.currency
+ '@path': $.properties.list_id
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: qYHcgKDSbuGTbXJf8bhBFN
+ - id: ncjpg5D9hUTZnAoDVdd4Qo
sortOrder: 6
- fieldKey: value
- label: Value
- type: NUMBER
- description: The monetary value of the event.
- placeholder: ''
- defaultValue:
- '@path': $.properties.value
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: uZMuHBaurr6VgchFrayBFr
- sortOrder: 7
- fieldKey: coupon
- label: Coupon
- type: STRING
- description: Coupon code used for a purchase.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: kTiwTTNoYocyfu1bgQS8wG
- sortOrder: 8
- fieldKey: payment_type
- label: Payment Type
+ fieldKey: item_list_name
+ label: Item List Name
type: STRING
- description: The chosen method of payment.
+ description: The name of the list in which the item was presented to the user.
placeholder: ''
defaultValue:
- '@path': $.properties.payment_method
+ '@path': $.properties.category
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: 66R8PGstxVFxUbaXwJmp7s
- sortOrder: 9
+ - id: patSnNiPp4hsRqv3gtCTzW
+ sortOrder: 7
fieldKey: items
label: Products
type: OBJECT
@@ -36341,8 +36699,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: hZU1TZ1t2MPHHRib2wsZSr
- sortOrder: 10
+ - id: bgARaEXrUk9CAAFmxg3Vta
+ sortOrder: 8
fieldKey: user_properties
label: User Properties
type: OBJECT
@@ -36358,8 +36716,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: a2Co9ABshUQ3fCwsyCzamN
- sortOrder: 11
+ - id: uTyafHcXMFwfqGTN8mqbsD
+ sortOrder: 9
fieldKey: engagement_time_msec
label: Engagement Time in Milliseconds
type: NUMBER
@@ -36375,8 +36733,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: vJhDR9r4GX4jYPDAL3N9XZ
- sortOrder: 12
+ - id: j9Rz3bYhEvVnXyRvyZhQgt
+ sortOrder: 10
fieldKey: params
label: Event Parameters
type: OBJECT
@@ -36387,15 +36745,15 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: bmcGi7ckjg1yJyQ7mwqm3t
- name: Add to Wishlist
- slug: addToWishlist
- description: Send event when a user adds items to a wishlist
+ - id: 5oPdBsFNJRsrxVh17oPFPm
+ name: Refund
+ slug: refund
+ description: Send event when a refund is issued
platform: CLOUD
hidden: false
- defaultTrigger: type = "track" and event = "Product Added to Wishlist"
+ defaultTrigger: type = "track" and event = "Order Refunded"
fields:
- - id: bxkFEVxQnA52zLDGxaxRD
+ - id: dqTmAJvBcg2f86sVaSqt3f
sortOrder: 0
fieldKey: data_stream_type
label: Data Stream Type
@@ -36414,7 +36772,7 @@ items:
value: Mobile App
dynamic: false
allowNull: false
- - id: oLBaj3FFwcFrhtAGXQ28qZ
+ - id: kFgWNcTgd3KnGpEDfTw1Uq
sortOrder: 1
fieldKey: app_instance_id
label: Firebase App Instance ID
@@ -36429,7 +36787,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 3qXeqKRZnYJvYzU96x3uGK
+ - id: mqi1ThbNTzK1Z7nRf6MZWx
sortOrder: 2
fieldKey: client_id
label: Client ID
@@ -36451,7 +36809,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: dSr2WadJ9nwTsCLmpfCqhs
+ - id: g3JXjS58LQQvi29gBviijr
sortOrder: 3
fieldKey: user_id
label: User ID
@@ -36468,7 +36826,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: gByUFnpb7K43WMzDTdCUYG
+ - id: 7d8CpK4iNbE37hL26atDfv
sortOrder: 4
fieldKey: timestamp_micros
label: Event Timestamp
@@ -36485,7 +36843,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 6LvQPAid3AAZFd5u2PCG3x
+ - id: gUGAQmwUCPwroQddVh7aR5
sortOrder: 5
fieldKey: currency
label: Currency
@@ -36501,22 +36859,90 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: fLRFvmnRAxeCwjwpz1rPPw
+ - id: 6HUvwvBPyzj26D65KDSnEc
sortOrder: 6
+ fieldKey: transaction_id
+ label: Order Id
+ type: STRING
+ description: The unique identifier of a transaction.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.order_id
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: nGFT6zByN964qmQZShTfwj
+ sortOrder: 7
fieldKey: value
label: Value
type: NUMBER
description: The monetary value of the event.
placeholder: ''
defaultValue:
- '@path': $.properties.value
+ '@path': $.properties.total
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: ig2WSHLbGHscmJcuvDjV4T
- sortOrder: 7
+ - id: 8ZSNFG7K3Mt6jSuChT8Crg
+ sortOrder: 8
+ fieldKey: affiliation
+ label: Affiliation
+ type: STRING
+ description: >-
+ Store or affiliation from which this transaction occurred (e.g. Google
+ Store).
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.affiliation
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 2qn8PG1voGFAV8xgvN6u8G
+ sortOrder: 9
+ fieldKey: coupon
+ label: Coupon
+ type: STRING
+ description: Coupon code used for a purchase.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: jr41W8YDWtivU1vjY98ctn
+ sortOrder: 10
+ fieldKey: shipping
+ label: Shipping
+ type: NUMBER
+ description: Shipping cost associated with the transaction.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.shipping
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: jD3AJ3ffy3iEhmEmXkgos2
+ sortOrder: 11
+ fieldKey: tax
+ label: Tax
+ type: NUMBER
+ description: Tax cost associated with a transaction.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: ekSWoE8e9ir5Et9UT1aehM
+ sortOrder: 12
fieldKey: items
label: Products
type: OBJECT
@@ -36524,7 +36950,7 @@ items:
placeholder: ''
defaultValue:
'@arrayPath':
- - $.properties
+ - $.properties.products
- item_id:
'@path': $.product_id
item_name:
@@ -36533,6 +36959,8 @@ items:
'@path': $.affiliation
coupon:
'@path': $.coupon
+ index:
+ '@path': $.position
item_brand:
'@path': $.brand
item_category:
@@ -36543,13 +36971,13 @@ items:
'@path': $.price
quantity:
'@path': $.quantity
- required: true
+ required: false
multiple: true
choices: null
dynamic: false
allowNull: false
- - id: tQjUCiFMwyubnFnesxyVJF
- sortOrder: 8
+ - id: bkUr8iptpoDbcFWUGs17pu
+ sortOrder: 13
fieldKey: user_properties
label: User Properties
type: OBJECT
@@ -36565,8 +36993,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: fL4Lms977CYeGimFvjagrh
- sortOrder: 9
+ - id: shwWJoD1TNLDHcnDYwZBet
+ sortOrder: 14
fieldKey: engagement_time_msec
label: Engagement Time in Milliseconds
type: NUMBER
@@ -36582,8 +37010,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: uLhWBC9p62i1vvxnwr6aMc
- sortOrder: 10
+ - id: 6V4azUPvPfkJUvqEKMZBrd
+ sortOrder: 15
fieldKey: params
label: Event Parameters
type: OBJECT
@@ -36594,15 +37022,15 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: h4zXXRRkchxkVGvtqdgzKe
- name: View Item
- slug: viewItem
- description: Send event when a user views an item
+ - id: 784GCiEtK8isdAU6VHkzPw
+ name: Add Payment Info
+ slug: addPaymentInfo
+ description: Send event when a user submits their payment information
platform: CLOUD
hidden: false
- defaultTrigger: type = "track" and event = "Product Viewed"
+ defaultTrigger: type = "track" and event = "Payment Info Entered"
fields:
- - id: aCEWbAuEvJCL5iLaBDhRi2
+ - id: fWToXnZtM8zH1Pw7a1LH7L
sortOrder: 0
fieldKey: data_stream_type
label: Data Stream Type
@@ -36621,7 +37049,7 @@ items:
value: Mobile App
dynamic: false
allowNull: false
- - id: 2N5zB78ffBiUQSLRvsroR2
+ - id: dZkQPuBXy4ESkQWLKPDWCi
sortOrder: 1
fieldKey: app_instance_id
label: Firebase App Instance ID
@@ -36636,7 +37064,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: pF8Yc9dWZYFSDhufwm4FoE
+ - id: pVvNGfyHUFsmz3xnFkN8hD
sortOrder: 2
fieldKey: client_id
label: Client ID
@@ -36658,7 +37086,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: nQJeguNSzFVnLZKYikhzXL
+ - id: cyaRqKic9Cpxqb3peBq1Sw
sortOrder: 3
fieldKey: user_id
label: User ID
@@ -36675,7 +37103,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: qXUnkJWtcVQaeBzCcCnE1E
+ - id: bvnKU4NaD9MDHijNe2sHQQ
sortOrder: 4
fieldKey: timestamp_micros
label: Event Timestamp
@@ -36692,7 +37120,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: ojNR1C5f8UDt1tuajzmyAV
+ - id: egYyeEm7VctdGHJYaJuZ8T
sortOrder: 5
fieldKey: currency
label: Currency
@@ -36708,7 +37136,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: b7Vck9dHTArzA293Zqeob3
+ - id: qYHcgKDSbuGTbXJf8bhBFN
sortOrder: 6
fieldKey: value
label: Value
@@ -36722,8 +37150,34 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: iSzBsK3RsK5qugQe6qRU1q
+ - id: uZMuHBaurr6VgchFrayBFr
sortOrder: 7
+ fieldKey: coupon
+ label: Coupon
+ type: STRING
+ description: Coupon code used for a purchase.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: kTiwTTNoYocyfu1bgQS8wG
+ sortOrder: 8
+ fieldKey: payment_type
+ label: Payment Type
+ type: STRING
+ description: The chosen method of payment.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.payment_method
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 66R8PGstxVFxUbaXwJmp7s
+ sortOrder: 9
fieldKey: items
label: Products
type: OBJECT
@@ -36731,7 +37185,7 @@ items:
placeholder: ''
defaultValue:
'@arrayPath':
- - $.properties
+ - $.properties.products
- item_id:
'@path': $.product_id
item_name:
@@ -36740,6 +37194,8 @@ items:
'@path': $.affiliation
coupon:
'@path': $.coupon
+ index:
+ '@path': $.position
item_brand:
'@path': $.brand
item_category:
@@ -36755,8 +37211,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: aLWhS92JFcrRcfEcNH7map
- sortOrder: 8
+ - id: hZU1TZ1t2MPHHRib2wsZSr
+ sortOrder: 10
fieldKey: user_properties
label: User Properties
type: OBJECT
@@ -36772,8 +37228,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: wcMFEiHTs36Rg5aULVCNRT
- sortOrder: 9
+ - id: a2Co9ABshUQ3fCwsyCzamN
+ sortOrder: 11
fieldKey: engagement_time_msec
label: Engagement Time in Milliseconds
type: NUMBER
@@ -36789,8 +37245,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: mC6dYsoEs3ru85hBW6QT4n
- sortOrder: 10
+ - id: vJhDR9r4GX4jYPDAL3N9XZ
+ sortOrder: 12
fieldKey: params
label: Event Parameters
type: OBJECT
@@ -36801,17 +37257,15 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: kJJRs3S5EiVC8At7GZt9nX
- name: Sign Up
- slug: signUp
- description: >-
- Send event when a user signs up to measure the popularity of each sign-up
- method
+ - id: bmcGi7ckjg1yJyQ7mwqm3t
+ name: Add to Wishlist
+ slug: addToWishlist
+ description: Send event when a user adds items to a wishlist
platform: CLOUD
hidden: false
- defaultTrigger: type = "track" and event = "Signed Up"
+ defaultTrigger: type = "track" and event = "Product Added to Wishlist"
fields:
- - id: tKWNUhNFVGWzYxaRnhqxZB
+ - id: bxkFEVxQnA52zLDGxaxRD
sortOrder: 0
fieldKey: data_stream_type
label: Data Stream Type
@@ -36830,7 +37284,7 @@ items:
value: Mobile App
dynamic: false
allowNull: false
- - id: jKP4UEwfg7TnGjLRbKP8yE
+ - id: oLBaj3FFwcFrhtAGXQ28qZ
sortOrder: 1
fieldKey: app_instance_id
label: Firebase App Instance ID
@@ -36845,7 +37299,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: cXzScwFaH4gmDhzNHwDckT
+ - id: 3qXeqKRZnYJvYzU96x3uGK
sortOrder: 2
fieldKey: client_id
label: Client ID
@@ -36867,7 +37321,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: ufuycoDxg1dsSunwdh17QL
+ - id: dSr2WadJ9nwTsCLmpfCqhs
sortOrder: 3
fieldKey: user_id
label: User ID
@@ -36884,7 +37338,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: vuebn3Fk5xLwYY3JraoCWX
+ - id: gByUFnpb7K43WMzDTdCUYG
sortOrder: 4
fieldKey: timestamp_micros
label: Event Timestamp
@@ -36901,22 +37355,71 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: a86wi8u6RJKqg7fGRJtq1j
+ - id: 6LvQPAid3AAZFd5u2PCG3x
sortOrder: 5
- fieldKey: method
- label: Method
+ fieldKey: currency
+ label: Currency
type: STRING
- description: The method used for sign up.
+ description: >-
+ Currency of the items associated with the event, in 3-letter ISO 4217
+ format.
placeholder: ''
defaultValue:
- '@path': $.properties.type
+ '@path': $.properties.currency
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: 3ZSM6CWy2cLXS4uiYbdbaL
+ - id: fLRFvmnRAxeCwjwpz1rPPw
sortOrder: 6
+ fieldKey: value
+ label: Value
+ type: NUMBER
+ description: The monetary value of the event.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.value
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: ig2WSHLbGHscmJcuvDjV4T
+ sortOrder: 7
+ fieldKey: items
+ label: Products
+ type: OBJECT
+ description: The list of products purchased.
+ placeholder: ''
+ defaultValue:
+ '@arrayPath':
+ - $.properties
+ - item_id:
+ '@path': $.product_id
+ item_name:
+ '@path': $.name
+ affiliation:
+ '@path': $.affiliation
+ coupon:
+ '@path': $.coupon
+ item_brand:
+ '@path': $.brand
+ item_category:
+ '@path': $.category
+ item_variant:
+ '@path': $.variant
+ price:
+ '@path': $.price
+ quantity:
+ '@path': $.quantity
+ required: true
+ multiple: true
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: tQjUCiFMwyubnFnesxyVJF
+ sortOrder: 8
fieldKey: user_properties
label: User Properties
type: OBJECT
@@ -36932,8 +37435,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: nSwyt1i7fDAce5mtPSCBmf
- sortOrder: 7
+ - id: fL4Lms977CYeGimFvjagrh
+ sortOrder: 9
fieldKey: engagement_time_msec
label: Engagement Time in Milliseconds
type: NUMBER
@@ -36949,8 +37452,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: pPrRs7LkRSxiCSubQXynbo
- sortOrder: 8
+ - id: uLhWBC9p62i1vvxnwr6aMc
+ sortOrder: 10
fieldKey: params
label: Event Parameters
type: OBJECT
@@ -36961,15 +37464,17 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: ktHJRgMzTxdVu3SsB8mD2A
- name: Purchase
- slug: purchase
- description: Send event when a user completes a purchase
+ - id: kJJRs3S5EiVC8At7GZt9nX
+ name: Sign Up
+ slug: signUp
+ description: >-
+ Send event when a user signs up to measure the popularity of each sign-up
+ method
platform: CLOUD
hidden: false
- defaultTrigger: type = "track" and event = "Order Completed"
+ defaultTrigger: type = "track" and event = "Signed Up"
fields:
- - id: 4YNffhEH1S3tUzjvM5YBAn
+ - id: tKWNUhNFVGWzYxaRnhqxZB
sortOrder: 0
fieldKey: data_stream_type
label: Data Stream Type
@@ -36988,7 +37493,7 @@ items:
value: Mobile App
dynamic: false
allowNull: false
- - id: n467C9zpz8TkUZPDjriQ
+ - id: jKP4UEwfg7TnGjLRbKP8yE
sortOrder: 1
fieldKey: app_instance_id
label: Firebase App Instance ID
@@ -37003,7 +37508,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: oraqUvtnprUZKTozLZAdoF
+ - id: cXzScwFaH4gmDhzNHwDckT
sortOrder: 2
fieldKey: client_id
label: Client ID
@@ -37025,7 +37530,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 8LMDs6CDzRfd5UNZPVQDv1
+ - id: ufuycoDxg1dsSunwdh17QL
sortOrder: 3
fieldKey: user_id
label: User ID
@@ -37042,7 +37547,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: nHwxTV4WTUL7sdkjAFLvpQ
+ - id: vuebn3Fk5xLwYY3JraoCWX
sortOrder: 4
fieldKey: timestamp_micros
label: Event Timestamp
@@ -37059,145 +37564,22 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: NuFRz7ZNbK8MtXETnGy4f
+ - id: a86wi8u6RJKqg7fGRJtq1j
sortOrder: 5
- fieldKey: affiliation
- label: Affiliation
+ fieldKey: method
+ label: Method
type: STRING
- description: >-
- Store or affiliation from which this transaction occurred (e.g. Google
- Store).
+ description: The method used for sign up.
placeholder: ''
defaultValue:
- '@path': $.properties.affiliation
+ '@path': $.properties.type
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: vD61JaT6dqrqqYupmtikim
+ - id: 3ZSM6CWy2cLXS4uiYbdbaL
sortOrder: 6
- fieldKey: coupon
- label: Coupon
- type: STRING
- description: Coupon code used for a purchase.
- placeholder: ''
- defaultValue:
- '@path': $.properties.coupon
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: cBoh1PMs76g1D16QQdy8Dc
- sortOrder: 7
- fieldKey: currency
- label: Currency
- type: STRING
- description: >-
- Currency of the items associated with the event, in 3-letter ISO 4217
- format.
- placeholder: ''
- defaultValue:
- '@path': $.properties.currency
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: cxUqwK4e3TPmkm4p8hssE
- sortOrder: 8
- fieldKey: items
- label: Products
- type: OBJECT
- description: The list of products purchased.
- placeholder: ''
- defaultValue:
- '@arrayPath':
- - $.properties.products
- - item_id:
- '@path': $.product_id
- item_name:
- '@path': $.name
- affiliation:
- '@path': $.affiliation
- coupon:
- '@path': $.coupon
- index:
- '@path': $.position
- item_brand:
- '@path': $.brand
- item_category:
- '@path': $.category
- item_variant:
- '@path': $.variant
- price:
- '@path': $.price
- quantity:
- '@path': $.quantity
- required: true
- multiple: true
- choices: null
- dynamic: false
- allowNull: false
- - id: 4X17nWsswJipGGRSD9gu7
- sortOrder: 9
- fieldKey: transaction_id
- label: Order Id
- type: STRING
- description: The unique identifier of a transaction.
- placeholder: ''
- defaultValue:
- '@path': $.properties.order_id
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: urUJnsEwMgTmeaJ4BoBSAU
- sortOrder: 10
- fieldKey: shipping
- label: Shipping
- type: NUMBER
- description: Shipping cost associated with the transaction.
- placeholder: ''
- defaultValue:
- '@path': $.properties.shipping
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: aXKcGgfoqhhzudFXo5nkfs
- sortOrder: 11
- fieldKey: tax
- label: Tax
- type: NUMBER
- description: Total tax associated with the transaction.
- placeholder: ''
- defaultValue:
- '@path': $.properties.tax
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: wwRwpoS6NfNGfU7vGc4ksH
- sortOrder: 12
- fieldKey: value
- label: Value
- type: NUMBER
- description: The monetary value of the event.
- placeholder: ''
- defaultValue:
- '@path': $.properties.total
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: pAsKQMBBFbsYwQ8QEnuVpv
- sortOrder: 13
fieldKey: user_properties
label: User Properties
type: OBJECT
@@ -37213,8 +37595,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 9b4njsQkttWS67iDj948TJ
- sortOrder: 14
+ - id: nSwyt1i7fDAce5mtPSCBmf
+ sortOrder: 7
fieldKey: engagement_time_msec
label: Engagement Time in Milliseconds
type: NUMBER
@@ -37230,8 +37612,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: vf2o4c1YSF8eRh1Eto2r8Y
- sortOrder: 15
+ - id: pPrRs7LkRSxiCSubQXynbo
+ sortOrder: 8
fieldKey: params
label: Event Parameters
type: OBJECT
@@ -37852,187 +38234,6 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: tNPRvBDTsfszvJQy6kE9K3
- name: Custom Event
- slug: customEvent
- description: Send any custom event
- platform: CLOUD
- hidden: false
- defaultTrigger: type = "track"
- fields:
- - id: qCc4gRyfC7dP3gafcsAgQT
- sortOrder: 0
- fieldKey: data_stream_type
- label: Data Stream Type
- type: STRING
- description: >-
- The type of data stream this data belongs in. This can either be a web
- stream or a mobile app stream (iOS or Android).
- placeholder: ''
- defaultValue: Web
- required: false
- multiple: false
- choices:
- - label: Web
- value: Web
- - label: Mobile App
- value: Mobile App
- dynamic: false
- allowNull: false
- - id: aHusyGsyfL9Nz74gfJGaYh
- sortOrder: 1
- fieldKey: app_instance_id
- label: Firebase App Instance ID
- type: STRING
- description: >-
- Uniquely identifies a specific installation of a Firebase app. This
- value needs to be retrieved through the Firebase SDK. **Required for
- mobile app streams.**
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: uAHfnJ1hbhRgeC4b5Ka7uL
- sortOrder: 2
- fieldKey: clientId
- label: Client ID
- type: STRING
- description: >-
- Uniquely identifies a user instance of a web client. **Required for web
- streams.**
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.userId
- then:
- '@path': $.userId
- else:
- '@path': $.anonymousId
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: denyXnu9NjTNmfqtQiMjSt
- sortOrder: 3
- fieldKey: user_id
- label: User ID
- type: STRING
- description: >-
- A unique identifier for a user. See Google's [User-ID for cross-platform
- analysis](https://support.google.com/analytics/answer/9213390) and
- [Reporting: deduplicate user
- counts](https://support.google.com/analytics/answer/9355949?hl=en)
- documentation for more information on this identifier.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 6oc5yTGkpyJT9nT1FERisw
- sortOrder: 4
- fieldKey: timestamp_micros
- label: Event Timestamp
- type: STRING
- description: >-
- A Unix timestamp (in microseconds) for the time to associate with the
- event. Segment will convert to Unix if not already converted. Events can
- be backdated up to 3 calendar days based on the property's timezone.
- placeholder: ''
- defaultValue:
- '@path': $.timestamp
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 4oyFfqecoLhrQWRhTCXGvA
- sortOrder: 5
- fieldKey: name
- label: Event Name
- type: STRING
- description: >-
- The unique name of the custom event created in GA4. GA4 does not accept
- spaces in event names so Segment will replace any spaces with
- underscores. More information about GA4 event name rules is available in
- [their
- docs](https://support.google.com/analytics/answer/10085872?hl=en&ref_topic=9756175#event-name-rules&zippy=%2Cin-this-article.%2Cin-this-article).
- placeholder: ''
- defaultValue:
- '@path': $.event
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: isejGrCmGayNPZbqsKfCYD
- sortOrder: 6
- fieldKey: lowercase
- label: Lowercase Event Name
- type: BOOLEAN
- description: >-
- If true, the event name will be converted to lowercase before sending to
- Google. Event names are case sensitive in GA4 so enable this setting to
- avoid distinct events for casing differences. More information about GA4
- event name rules is available in [their
- docs](https://support.google.com/analytics/answer/10085872?hl=en&ref_topic=9756175#event-name-rules&zippy=%2Cin-this-article.%2Cin-this-article).
- placeholder: ''
- defaultValue: false
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: nz6koocrWTfSYBvv9WPJJk
- sortOrder: 7
- fieldKey: user_properties
- label: User Properties
- type: OBJECT
- description: >-
- The user properties to send to Google Analytics 4. You must create
- user-scoped dimensions to ensure custom properties are picked up by
- Google. See Google’s [Custom user
- properties](https://support.google.com/analytics/answer/9269570) to
- learn how to set and register user properties.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: nWakudsXbt9Ehtuhganp3X
- sortOrder: 8
- fieldKey: engagement_time_msec
- label: Engagement Time in Milliseconds
- type: NUMBER
- description: >-
- The amount of time a user interacted with your site, in milliseconds.
- Google only counts users who interact with your site for a non-zero
- amount of time. By default, Segment sets engagement time to 1 so users
- are counted.
- placeholder: ''
- defaultValue: 1
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: kxTXZs6UthjJDdeTTwHUro
- sortOrder: 9
- fieldKey: params
- label: Event Parameters
- type: OBJECT
- description: The event parameters to send to Google Analytics 4.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- id: tVLMy9L1jG6K6c8AuxWGiP
name: Remove from Cart
slug: removeFromCart
@@ -38304,165 +38505,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: v72M7osCmKyY6aLmeBEWy2
- sortOrder: 3
- fieldKey: user_id
- label: User ID
- type: STRING
- description: >-
- A unique identifier for a user. See Google's [User-ID for cross-platform
- analysis](https://support.google.com/analytics/answer/9213390) and
- [Reporting: deduplicate user
- counts](https://support.google.com/analytics/answer/9355949?hl=en)
- documentation for more information on this identifier.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: eoJjf9C9E9h8mAoLX9FSQ
- sortOrder: 4
- fieldKey: timestamp_micros
- label: Event Timestamp
- type: STRING
- description: >-
- A Unix timestamp (in microseconds) for the time to associate with the
- event. Segment will convert to Unix if not already converted. Events can
- be backdated up to 3 calendar days based on the property's timezone.
- placeholder: ''
- defaultValue:
- '@path': $.timestamp
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 9dPf6gU6ifPkFggVTsugQH
- sortOrder: 5
- fieldKey: search_term
- label: Search Term
- type: STRING
- description: The term that was searched for.
- placeholder: ''
- defaultValue:
- '@path': $.properties.query
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: swuL4XvwLz1B4AERk9NHDn
- sortOrder: 6
- fieldKey: user_properties
- label: User Properties
- type: OBJECT
- description: >-
- The user properties to send to Google Analytics 4. You must create
- user-scoped dimensions to ensure custom properties are picked up by
- Google. See Google’s [Custom user
- properties](https://support.google.com/analytics/answer/9269570) to
- learn how to set and register user properties.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: vxthsWs1jrnggNHT7YPZoj
- sortOrder: 7
- fieldKey: engagement_time_msec
- label: Engagement Time in Milliseconds
- type: NUMBER
- description: >-
- The amount of time a user interacted with your site, in milliseconds.
- Google only counts users who interact with your site for a non-zero
- amount of time. By default, Segment sets engagement time to 1 so users
- are counted.
- placeholder: ''
- defaultValue: 1
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 4zQoafergcCTSGAvAzwjYW
- sortOrder: 8
- fieldKey: params
- label: Event Parameters
- type: OBJECT
- description: The event parameters to send to Google Analytics 4.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: xBj1Vpdp5BWErfezRDxczN
- name: Select Item
- slug: selectItem
- description: Send event when a user selects an item from a list
- platform: CLOUD
- hidden: false
- defaultTrigger: type = "track" and event = "Product Clicked"
- fields:
- - id: 8LaCwvi5z3QUk5AFSHjPdK
- sortOrder: 0
- fieldKey: data_stream_type
- label: Data Stream Type
- type: STRING
- description: >-
- The type of data stream this data belongs in. This can either be a web
- stream or a mobile app stream (iOS or Android).
- placeholder: ''
- defaultValue: Web
- required: false
- multiple: false
- choices:
- - label: Web
- value: Web
- - label: Mobile App
- value: Mobile App
- dynamic: false
- allowNull: false
- - id: vBM5U4Sio3trz5u2KD4owF
- sortOrder: 1
- fieldKey: app_instance_id
- label: Firebase App Instance ID
- type: STRING
- description: >-
- Uniquely identifies a specific installation of a Firebase app. This
- value needs to be retrieved through the Firebase SDK. **Required for
- mobile app streams.**
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: wsi1AWiUw28TZnvtTu9EdJ
- sortOrder: 2
- fieldKey: client_id
- label: Client ID
- type: STRING
- description: >-
- Uniquely identifies a user instance of a web client. **Required for web
- streams.**
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.userId
- then:
- '@path': $.userId
- else:
- '@path': $.anonymousId
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 46Tg6DdsEduZun4JMgq49v
+ - id: v72M7osCmKyY6aLmeBEWy2
sortOrder: 3
fieldKey: user_id
label: User ID
@@ -38479,7 +38522,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 5dCfY6r7wzm6YSm1s8LfMR
+ - id: eoJjf9C9E9h8mAoLX9FSQ
sortOrder: 4
fieldKey: timestamp_micros
label: Event Timestamp
@@ -38496,65 +38539,22 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 3GbWv3UXCjFEcDmB2ktBsb
+ - id: 9dPf6gU6ifPkFggVTsugQH
sortOrder: 5
- fieldKey: item_list_name
- label: Item List Name
- type: STRING
- description: The name of the list in which the item was presented to the user.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: itUkLrV6PNTr2F7hqaivKM
- sortOrder: 6
- fieldKey: item_list_id
- label: Item List Id
+ fieldKey: search_term
+ label: Search Term
type: STRING
- description: The ID of the list in which the item was presented to the user.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 76zQbXvjXCxuabfXSMeokD
- sortOrder: 7
- fieldKey: items
- label: Products
- type: OBJECT
- description: The list of products purchased.
+ description: The term that was searched for.
placeholder: ''
defaultValue:
- '@arrayPath':
- - $.properties
- - item_id:
- '@path': $.product_id
- item_name:
- '@path': $.name
- affiliation:
- '@path': $.affiliation
- coupon:
- '@path': $.coupon
- item_brand:
- '@path': $.brand
- item_category:
- '@path': $.category
- item_variant:
- '@path': $.variant
- price:
- '@path': $.price
- quantity:
- '@path': $.quantity
+ '@path': $.properties.query
required: true
- multiple: true
+ multiple: false
choices: null
dynamic: false
allowNull: false
- - id: niqPbJADWwzWu4WTbetmYd
- sortOrder: 8
+ - id: swuL4XvwLz1B4AERk9NHDn
+ sortOrder: 6
fieldKey: user_properties
label: User Properties
type: OBJECT
@@ -38570,8 +38570,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: qcAW1H6eCc3psQMpG8pn6F
- sortOrder: 9
+ - id: vxthsWs1jrnggNHT7YPZoj
+ sortOrder: 7
fieldKey: engagement_time_msec
label: Engagement Time in Milliseconds
type: NUMBER
@@ -38587,8 +38587,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: bMveGq5YrZrrUJ13RSwM2i
- sortOrder: 10
+ - id: 4zQoafergcCTSGAvAzwjYW
+ sortOrder: 8
fieldKey: params
label: Event Parameters
type: OBJECT
@@ -38947,7 +38947,7 @@ items:
hidden: false
defaultTrigger: type = "track" and event = "Product Added"
fields:
- - id: nDWmEXsvbr7u43GaHg7rXk
+ - id: gKoR4Rufr2ba6oMzNHLtCV
sortOrder: 0
fieldKey: user_id
label: User ID
@@ -38964,7 +38964,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: YDSjK5ZPB4bdau3aCHzpu
+ - id: 38KmaoYUbBHPB3gvaPtHZj
sortOrder: 1
fieldKey: currency
label: Currency
@@ -38980,7 +38980,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: mt2RWoLNwpcZb4y2gV3ugd
+ - id: 5vguMDmPyD2tnFWZ7gta7d
sortOrder: 2
fieldKey: items
label: Products
@@ -39013,7 +39013,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: averb7Ln6EMWXbcD89keeE
+ - id: k4K8pU3dazhru3hdot156D
sortOrder: 3
fieldKey: value
label: Value
@@ -39027,7 +39027,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 4Y65hHKfJf7PZJnyZYvjWh
+ - id: upL7fnfWjUtSopp1uX7GTi
sortOrder: 4
fieldKey: user_properties
label: User Properties
@@ -39044,7 +39044,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: dwLiGAi2UcZ8A7CXfPQr1k
+ - id: cvj3ZcR8ermdjo1k69XxEH
sortOrder: 5
fieldKey: params
label: Event Parameters
@@ -39064,7 +39064,7 @@ items:
hidden: false
defaultTrigger: type = "track" and event = "Products Searched"
fields:
- - id: sbJ2EGRSrGR4FpRdssQx33
+ - id: iR1GpUyz2Lyt7RScqovg8H
sortOrder: 0
fieldKey: user_id
label: User ID
@@ -39081,7 +39081,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: ixyM2jEw33Aki8kHkxYG2Y
+ - id: k1wXe2YM2byRMTx2kmx4J6
sortOrder: 1
fieldKey: user_properties
label: User Properties
@@ -39098,7 +39098,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: bKamjSyot3ATQJzUkUogz9
+ - id: 6iZuY1cuQrBvGBt3qU8csL
sortOrder: 2
fieldKey: params
label: Event Parameters
@@ -39110,7 +39110,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: katNH9zFAxyfTXgdXwhyLo
+ - id: bwc5t2xKEsJJQWFCQamvdh
sortOrder: 3
fieldKey: search_term
label: Search Term
@@ -39132,7 +39132,7 @@ items:
hidden: false
defaultTrigger: type = "track" and event = "Product Clicked"
fields:
- - id: mdWep2WaHNZt6ooALmsZTt
+ - id: cKKqSZPY2y6GiwMtEtPxFf
sortOrder: 0
fieldKey: user_id
label: User ID
@@ -39149,7 +39149,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: qqKu3oo5pcrUVNQ15qBEA4
+ - id: b9tk6FdLr9QW2XUFbfHR1Y
sortOrder: 1
fieldKey: item_list_name
label: Item List Name
@@ -39163,7 +39163,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: nBmc1ey4qm83fMQ6AhL6JW
+ - id: 4wqypBgVgd2DoHzf5WeJXs
sortOrder: 2
fieldKey: item_list_id
label: Item List Id
@@ -39177,7 +39177,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 26h63hTHCm3jztA5aP6nc2
+ - id: wSJ7szCfEcFhbP6aoasqxn
sortOrder: 3
fieldKey: items
label: Products
@@ -39210,7 +39210,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: koSL5KJj9e2cwDnvweQsCo
+ - id: qR1jWFzX8Ry9DyW9FFKyAF
sortOrder: 4
fieldKey: user_properties
label: User Properties
@@ -39227,7 +39227,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 4xevFhZ9C2Y2rzSGpjsQn
+ - id: wpndmwFfuZqAKNcBbptAn1
sortOrder: 5
fieldKey: params
label: Event Parameters
@@ -39249,7 +39249,7 @@ items:
hidden: false
defaultTrigger: type = "track" and event = "Product List Viewed"
fields:
- - id: cRgCcHWFyvMueCgqke8HM4
+ - id: vFuLckwKwBPDYsELXnenL6
sortOrder: 0
fieldKey: user_id
label: User ID
@@ -39266,7 +39266,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: iYqScCwaYZdyqJvkfygbtF
+ - id: t7HStNXW8ZrwsJxKndbETU
sortOrder: 1
fieldKey: item_list_id
label: Item List Id
@@ -39280,7 +39280,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: wk2fd7beWrd2KCgpmGd77a
+ - id: uQzGiXPTxFgy4L9nNaC6Wk
sortOrder: 2
fieldKey: item_list_name
label: Item List Name
@@ -39294,7 +39294,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: q4eMfh7ouqhG6McxU2pdsy
+ - id: cPRH7Q7HCcjMdzcjdJRwPW
sortOrder: 3
fieldKey: items
label: Products
@@ -39329,7 +39329,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 5D7b7hLxvKaJcTwsGzYpkG
+ - id: nsL2c63Vpp88DBtx1qcFkK
sortOrder: 4
fieldKey: user_properties
label: User Properties
@@ -39346,7 +39346,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: pQBsxaKjooAoJPXLHwQ7Af
+ - id: ba5bVzidEXZ47h3X3hyzeW
sortOrder: 5
fieldKey: params
label: Event Parameters
@@ -39366,7 +39366,7 @@ items:
hidden: false
defaultTrigger: type = "track" and event = "Signed Up"
fields:
- - id: jNUZ2vw5ZKcRJKr6KCio5z
+ - id: eDS4mTJYCKoy8L5UHznpEY
sortOrder: 0
fieldKey: user_id
label: User ID
@@ -39383,7 +39383,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: k9nyjUjbQSYsTTCrA4wHZq
+ - id: tqfUYkVnLQQdq9DPgJEDv4
sortOrder: 1
fieldKey: method
label: Method
@@ -39397,7 +39397,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 8E8ZSaHVCfHfbkkxExQvAp
+ - id: wYDGP8ogRNghqef2sjib5h
sortOrder: 2
fieldKey: user_properties
label: User Properties
@@ -39414,7 +39414,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: npFCk1aLrQNty4RCrEbPb1
+ - id: W83YkUWNyRSHiHK2K8yDh
sortOrder: 3
fieldKey: params
label: Event Parameters
@@ -39434,7 +39434,7 @@ items:
hidden: false
defaultTrigger: type = "track"
fields:
- - id: mVarDbSztZhangaAX1JVRc
+ - id: vmMDYF99f6f6iLPFzhn17h
sortOrder: 0
fieldKey: name
label: Event Name
@@ -39453,7 +39453,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 8NHzCuKsigHyrZaDsq9eUj
+ - id: 6EFxGnVVwE5hCNqecx4CpB
sortOrder: 1
fieldKey: lowercase
label: Lowercase Event Name
@@ -39471,7 +39471,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: dRvJDKNmXcd74c9rhtRYMN
+ - id: e8rqthoJfchoLd4FWAhHBd
sortOrder: 2
fieldKey: user_id
label: User ID
@@ -39488,7 +39488,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: rNgpAMShLAGAihUCb9N7yK
+ - id: rwWArUwuXLkAYy3ihy8vSF
sortOrder: 3
fieldKey: user_properties
label: User Properties
@@ -39505,7 +39505,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 59Cbo8R7FaSstS5zMvz8Ji
+ - id: eppTEPufDoz5gsbWa7MuXg
sortOrder: 4
fieldKey: params
label: Event Parameters
@@ -39525,7 +39525,7 @@ items:
hidden: false
defaultTrigger: type = "track" and event = "Order Refunded"
fields:
- - id: 4EAia8ugv5EynDY8PTE63W
+ - id: pJJqv2UEsnqgNfw14YDaz7
sortOrder: 0
fieldKey: user_id
label: User ID
@@ -39542,7 +39542,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 8swKhJfRg9jPmKZqwqzUap
+ - id: 29i5fL4xnPQyV6cJME8Uze
sortOrder: 1
fieldKey: currency
label: Currency
@@ -39558,7 +39558,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: sSpjQa5UcX4bmchYa7t8Ka
+ - id: 3JLuXnkhxzAxYMD4xERyMm
sortOrder: 2
fieldKey: transaction_id
label: Order Id
@@ -39572,7 +39572,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 9BFvAXNCJjF9LmzZZCvn16
+ - id: jimkTWd8c42Z9eDTGk7Ld8
sortOrder: 3
fieldKey: value
label: Value
@@ -39586,7 +39586,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: mn4RCLvoG7uSo4uoWyzGXy
+ - id: cZQxYBuXV3hEP48SGVYM9W
sortOrder: 4
fieldKey: affiliation
label: Affiliation
@@ -39602,7 +39602,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 9LBSzEjzJWNeHgQgAEziz5
+ - id: b6EyJjoX1MmZhVntz5YAVG
sortOrder: 5
fieldKey: coupon
label: Coupon
@@ -39614,7 +39614,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: u5ruA5NzQS3aWXBHHNHuKm
+ - id: uumqVr2wFHPRoGj6qsddqk
sortOrder: 6
fieldKey: shipping
label: Shipping
@@ -39628,7 +39628,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: mAinCj12M1jvaZ27nT546f
+ - id: 8TEbSGyHVb3uxfRTyStaGK
sortOrder: 7
fieldKey: tax
label: Tax
@@ -39642,7 +39642,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 8Njsot4XLCjqiExixubyRP
+ - id: 9ciVrNmwtwx5Us3PfX7Yzc
sortOrder: 8
fieldKey: items
label: Products
@@ -39677,7 +39677,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: fkU3wpDesjyp7CNcSsuJyz
+ - id: cmf6cbr4LvDBWJKTj2wT12
sortOrder: 9
fieldKey: user_properties
label: User Properties
@@ -39694,7 +39694,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: ayC7hbkYumSAdXdHMJxXU7
+ - id: ofJJQ4Hxc6oB2by3CeGGxS
sortOrder: 10
fieldKey: params
label: Event Parameters
@@ -39714,7 +39714,7 @@ items:
hidden: false
defaultTrigger: type = "track" and event = "Payment Info Entered"
fields:
- - id: 5Mcm8Z9gTsherqWTXwqaH
+ - id: dJbFdMymWR8aESJWqcS2c1
sortOrder: 0
fieldKey: user_id
label: User ID
@@ -39731,7 +39731,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: s6ue1rP9xE4QiEDu7zRHpd
+ - id: t4ahyFWsL6hTqHwSZRb2rL
sortOrder: 1
fieldKey: currency
label: Currency
@@ -39747,7 +39747,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: kWXPzfwGvegpEYSoFYZ5bL
+ - id: sbZHeTXFix4VZ72wF5x7Yu
sortOrder: 2
fieldKey: value
label: Value
@@ -39761,7 +39761,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: hsmVDKs5nGHDEHDaAZRbXA
+ - id: f3oKdDA9xhLeJbvpYrtJCD
sortOrder: 3
fieldKey: coupon
label: Coupon
@@ -39773,7 +39773,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 5Lq7516w7q7GF4QWesEDuD
+ - id: dAEyzkn2jtU94TBnHf7JEC
sortOrder: 4
fieldKey: payment_type
label: Payment Type
@@ -39787,7 +39787,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 4wDGwRsYCny42CVscywpJe
+ - id: 8jPnQ9MPqympGe6j3BfVga
sortOrder: 5
fieldKey: items
label: Products
@@ -39822,7 +39822,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: tFNiyeai4aBwostcfpHnWG
+ - id: nJXBo6cPYFVQqyd9Qv2pZM
sortOrder: 6
fieldKey: user_properties
label: User Properties
@@ -39839,7 +39839,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: c2e2fJmMi7UrF3EYKTUKHL
+ - id: gN2Xpc1wwMyz5e3jRapHa4
sortOrder: 7
fieldKey: params
label: Event Parameters
@@ -39859,7 +39859,7 @@ items:
hidden: false
defaultTrigger: type = "track" and event = "Cart Viewed"
fields:
- - id: bTJVDUixg4MAZosYXYmf3W
+ - id: kJELx8fD2cxgtvShnzCoZe
sortOrder: 0
fieldKey: user_id
label: User ID
@@ -39876,7 +39876,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: qpi1rAE8t3EM5C5niKtk4A
+ - id: 8D26i3k3p7qw7zPr1UWd2P
sortOrder: 1
fieldKey: currency
label: Currency
@@ -39892,7 +39892,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: wSiM1XtVzxWs6H2AjoHrh3
+ - id: 6VDr96e6ryxMHiyyboTyYN
sortOrder: 2
fieldKey: value
label: Value
@@ -39906,7 +39906,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: nHvEzVDwX6fvQQTw86Cf5h
+ - id: ipomvnWnHrpWk4HxeqKqEp
sortOrder: 3
fieldKey: items
label: Products
@@ -39941,7 +39941,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: gCCReXAu45uqWCGqbTmyqs
+ - id: 8WvUGd9DkUd3ZjvewEz3wL
sortOrder: 4
fieldKey: user_properties
label: User Properties
@@ -39958,7 +39958,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: tZotav2bU64zCcHnX724EX
+ - id: eef6dabDBncXP6caRaUmT4
sortOrder: 5
fieldKey: params
label: Event Parameters
@@ -39978,7 +39978,7 @@ items:
hidden: false
defaultTrigger: type = "page"
fields:
- - id: bpN6XeXgYdZskpQrjs5jZp
+ - id: HLmbPEHvquAnzrcyxS9EM
sortOrder: 0
fieldKey: user_id
label: User ID
@@ -39995,7 +39995,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: vXtrbrXGVyccedJSYhiGLa
+ - id: 6fAT3w74G82h6pNecR5JeZ
sortOrder: 1
fieldKey: user_properties
label: User Properties
@@ -40012,7 +40012,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: dZrKjPhc8vNZ9rLY6Un2wg
+ - id: d1q1P4aec3UV7CjqojnCgW
sortOrder: 2
fieldKey: ads_storage_consent_state
label: Ads Storage Consent State
@@ -40027,7 +40027,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 6b7iigMenQLYN2B36AAHWQ
+ - id: 8URgZZoTyGcPcJRTKQyS6B
sortOrder: 3
fieldKey: analytics_storage_consent_state
label: Analytics Storage Consent State
@@ -40042,7 +40042,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: geCgWb8Ve1fmAWR24UYM8G
+ - id: b1uUqJ2t5krW2nYuh1cg8m
sortOrder: 4
fieldKey: campaign_content
label: Campaign Content
@@ -40057,7 +40057,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: kkNEd1xqAKAfae4hecgzDP
+ - id: 7aomn5hk1uucvQ3TAhBQk9
sortOrder: 5
fieldKey: campaign_id
label: Campaign ID
@@ -40071,7 +40071,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: hxyiSzL9SavyefUYBVLs2Y
+ - id: jpcUJV8EsVCxJRMXT3ajCA
sortOrder: 6
fieldKey: campaign_medium
label: Campaign Medium
@@ -40086,7 +40086,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: sVxH8Uj3hLaLZdDuXpJWdy
+ - id: fDQhzGwEiqSK1njbSRpw6j
sortOrder: 7
fieldKey: campaign_name
label: Campaign Name
@@ -40100,7 +40100,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: wTvxzEYbEmCMPfAFqLD7eK
+ - id: kbP3aHCucDkEgDAWwXZyUA
sortOrder: 8
fieldKey: campaign_source
label: Campaign Source
@@ -40115,7 +40115,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: iK9R155qjCdkqMfasP62HR
+ - id: 3JmwzzcwHiibmTifm9pDAg
sortOrder: 9
fieldKey: campaign_term
label: Campaign Term
@@ -40129,7 +40129,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: cqaji4rZk9SxqrnbaNna9U
+ - id: 54fmhNhw93T16PntMxXSWd
sortOrder: 10
fieldKey: content_group
label: Content Group
@@ -40144,7 +40144,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: EYPuX1XUwAZZQJP6x89k5
+ - id: b1Yp9Hdg8EB8b7DGQ1spTV
sortOrder: 11
fieldKey: language
label: Language
@@ -40158,7 +40158,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: coHtQee8RWL6ekqSXZ2r73
+ - id: 5NuWz7pm3pmQkMyZssyyyV
sortOrder: 12
fieldKey: page_location
label: Page Location
@@ -40172,7 +40172,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: qoGpx5RgrubyUeirCNVzhm
+ - id: azK6rbj7XLTK5tUEfts7Kk
sortOrder: 13
fieldKey: page_referrer
label: Page Referrer
@@ -40187,7 +40187,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: iNeWPJVfSYvmKobQQ3wLyn
+ - id: 3eNZLjcZxZ27ugnBn7nsow
sortOrder: 14
fieldKey: page_title
label: Page Title
@@ -40201,7 +40201,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: vzg3Tqfe4snpxhhscwbmTP
+ - id: d1KwkSyuLtjjfS3CX2aiD9
sortOrder: 15
fieldKey: screen_resolution
label: Screen Resolution
@@ -40216,7 +40216,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: tKN4UVWyNKhYPLGJuNmWLY
+ - id: uNzsN8EvXkyPzEy7norrZE
sortOrder: 16
fieldKey: params
label: Event Parameters
@@ -40236,7 +40236,7 @@ items:
hidden: false
defaultTrigger: type = "track" and event = "Order Completed"
fields:
- - id: jUUEPCxisY8Aq7YRCpUnq9
+ - id: iPsopfK4nSLeBF4ZS66n9K
sortOrder: 0
fieldKey: user_id
label: User ID
@@ -40253,7 +40253,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: sAbHZxLdLwrsGEwdwfXUqo
+ - id: qjyszs9YjPMiVQJ9peTEVs
sortOrder: 1
fieldKey: coupon
label: Coupon
@@ -40267,7 +40267,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: eDfwHNMgwpWUckfBQDdFNV
+ - id: 3AmwBoBZG1uqNK1z1CgSVd
sortOrder: 2
fieldKey: currency
label: Currency
@@ -40283,7 +40283,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: fL44SeoTAhGYGTHyMFu6TB
+ - id: wQbCuRcaKWr6G6wZwJtv1z
sortOrder: 3
fieldKey: items
label: Products
@@ -40318,7 +40318,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: efonwyLu9HqHzxAMHthBoM
+ - id: b6eT9pegcQ4maVCGnvnxt
sortOrder: 4
fieldKey: transaction_id
label: Order Id
@@ -40332,7 +40332,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: qUxa7UeQghdrH3rUYBtj6i
+ - id: xh2Zv9CLMRPFYXMv84FZps
sortOrder: 5
fieldKey: shipping
label: Shipping
@@ -40346,7 +40346,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 5gsFD6wWYjCCd5uciFt91K
+ - id: jXDUsefWqBgNuyofBz1gN2
sortOrder: 6
fieldKey: tax
label: Tax
@@ -40360,7 +40360,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 5pD8kp7ids8YnEKmocuSYw
+ - id: cJ8TPu84E7PpLW6GDApWdg
sortOrder: 7
fieldKey: value
label: Value
@@ -40374,7 +40374,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 53GqWxwxHCQcgTH5xxU8e1
+ - id: hUXgURfEANCQvWudGeFaFR
sortOrder: 8
fieldKey: user_properties
label: User Properties
@@ -40391,7 +40391,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 9N2QZFYD58LYpa8F33T1FC
+ - id: 5p53vZu5J7AU6SrGrm4ufq
sortOrder: 9
fieldKey: params
label: Event Parameters
@@ -40411,7 +40411,7 @@ items:
hidden: false
defaultTrigger: type = "track" and event = "Promotion Viewed"
fields:
- - id: d9kbZXPrvfjqEE9uzHVn26
+ - id: 2kU9VASyJp7QrLFgDv59Wt
sortOrder: 0
fieldKey: user_id
label: User ID
@@ -40428,7 +40428,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 8mhYuMn8q39QRBDNXkbqWA
+ - id: mQonxWG9euKULJYpC7cBx1
sortOrder: 1
fieldKey: creative_name
label: Creative Name
@@ -40440,7 +40440,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: seQmeTjRY6GYsb8SDuduwi
+ - id: qrzLGcLdpUy1BU2UHQiS7i
sortOrder: 2
fieldKey: creative_slot
label: Creative Slot
@@ -40454,7 +40454,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 7CsGHrLWbtUvL3SBKmJ9EU
+ - id: ncLHC9ikw9EMWwB5YXJsh6
sortOrder: 3
fieldKey: location_id
label: Location ID
@@ -40468,7 +40468,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 58dEFN2F2QegwyqSUHdobZ
+ - id: sfCd8EG2t98ykTeNJvs1VM
sortOrder: 4
fieldKey: promotion_id
label: Promotion ID
@@ -40482,7 +40482,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 6VYtaeg7KHt8Gxy3nexzu7
+ - id: qxWCDxHaYtVgHV5CKQkTDa
sortOrder: 5
fieldKey: promotion_name
label: Promotion Name
@@ -40496,7 +40496,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 2d6CmTb9UW8HnF7WzJ9E1P
+ - id: gGCYeCAsRTnCSUmRi1AHnJ
sortOrder: 6
fieldKey: items
label: Products
@@ -40529,7 +40529,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: uAyDD8CdEbPk6n6tAqbS9V
+ - id: adC22BJ3G36RW6f923g8NK
sortOrder: 7
fieldKey: user_properties
label: User Properties
@@ -40546,7 +40546,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: tHBxvd2WyrniP18Udf9ivk
+ - id: 9QP4Njabq2N4Pzrm1Y5x2m
sortOrder: 8
fieldKey: params
label: Event Parameters
@@ -40568,7 +40568,7 @@ items:
hidden: false
defaultTrigger: type = "track" and event = "Product Added to Wishlist"
fields:
- - id: 41oS12YcxyaFjsVeKp5G9N
+ - id: mhgCg31eEy6wtsCWSb75Qe
sortOrder: 0
fieldKey: user_id
label: User ID
@@ -40585,7 +40585,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: ggmkMj512SAp5RkTAHQjQ3
+ - id: kW4bvhMZgfZtNWC2sZJuLE
sortOrder: 1
fieldKey: currency
label: Currency
@@ -40601,7 +40601,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: ghCWvN4aKzHLkkuQiF5adT
+ - id: wfuajoYHqvr1bruC6B6vWk
sortOrder: 2
fieldKey: value
label: Value
@@ -40615,7 +40615,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: jR5a4NmSmA6HveVnU6irXQ
+ - id: rH5bh8uSJf9Gvo6nGub4gk
sortOrder: 3
fieldKey: items
label: Products
@@ -40648,7 +40648,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: n7VmGj9JFw9S9U3wuDaXcj
+ - id: sukmWSyXm2q7vWHjrL8Yux
sortOrder: 4
fieldKey: user_properties
label: User Properties
@@ -40665,7 +40665,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 7tvzh4RwKokDqNZw597iQQ
+ - id: p7VxMbBvFjoDd1cpLRFEw6
sortOrder: 5
fieldKey: params
label: Event Parameters
@@ -40685,7 +40685,7 @@ items:
hidden: false
defaultTrigger: type = "track" and event = "Product Removed"
fields:
- - id: biVda3azGoJEPKhsBnW8FU
+ - id: qsQ8AqSSAxDk5D4Ea2RUU9
sortOrder: 0
fieldKey: user_id
label: User ID
@@ -40702,7 +40702,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: mzeYF3WjcrSFRWChBCeind
+ - id: oiT9wvrn7f1gKWNk4u3Mpm
sortOrder: 1
fieldKey: currency
label: Currency
@@ -40718,7 +40718,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 5LfwwHMcSvtkWQNoivmXHU
+ - id: qUNMn8jXLjHYcWanes1C3P
sortOrder: 2
fieldKey: value
label: Value
@@ -40732,7 +40732,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: mXLeEoqZeqJCjZTZBfExbc
+ - id: 6zoLP7eUSFBquRPRX6zeHT
sortOrder: 3
fieldKey: items
label: Products
@@ -40765,7 +40765,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: dCfU8SmdmYvxwzSQGtqTWL
+ - id: 4PXmbyvmiPZGmcD6nQnGBM
sortOrder: 4
fieldKey: user_properties
label: User Properties
@@ -40782,7 +40782,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: eYSfAvBFoQdqD6tUWABk5g
+ - id: tXEVzTeSpipoTrs2qCUBMf
sortOrder: 5
fieldKey: params
label: Event Parameters
@@ -40804,7 +40804,7 @@ items:
hidden: false
defaultTrigger: type = "track"
fields:
- - id: jQnQEVeJ8yUmU3nJmDBSrj
+ - id: 3kEz4tsguNWmjm1mfTy5NA
sortOrder: 0
fieldKey: user_id
label: User ID
@@ -40821,7 +40821,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: duh4fPkDvH5KM7Zs9cUJpp
+ - id: HtHKG3ySiRRDepWLvZVV4
sortOrder: 1
fieldKey: currency
label: Currency
@@ -40837,7 +40837,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 7RBS3gVK8gZv82No8XWoPk
+ - id: kbPz7QYurUt3QqLEuEVEQi
sortOrder: 2
fieldKey: value
label: Value
@@ -40851,7 +40851,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: mRf86JgTNHkPdBMmGUqGKB
+ - id: eLrES3sSBfTFWHufYVHBtv
sortOrder: 3
fieldKey: user_properties
label: User Properties
@@ -40868,7 +40868,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: sLUzE3334tKDH9m8buBcCo
+ - id: mJZDAspeJV9NTGpQXqicoQ
sortOrder: 4
fieldKey: params
label: Event Parameters
@@ -40888,7 +40888,7 @@ items:
hidden: false
defaultTrigger: type = "track" and event = "Promotion Clicked"
fields:
- - id: t5VMzuuyTNP9PRvqu1t2WY
+ - id: 9QLJ3ZFv1JeUh1qfRRXpqa
sortOrder: 0
fieldKey: user_id
label: User ID
@@ -40905,7 +40905,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 5TfuurUVnph8cdW2bUWUCb
+ - id: wFk7WMNdjYxr9bF8L2vtd7
sortOrder: 1
fieldKey: creative_name
label: Creative Name
@@ -40917,7 +40917,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: aVsZDYUBvQ1zH99BjbUcwn
+ - id: 3kR4YyxXqjSSirJtxv3Prt
sortOrder: 2
fieldKey: creative_slot
label: Creative Slot
@@ -40931,7 +40931,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 9mez7Avgsz2uo834arKere
+ - id: 5QPi9QeaWdQaQpzEHaPqpt
sortOrder: 3
fieldKey: location_id
label: Location ID
@@ -40945,7 +40945,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 9ZFM7W7MqsDAHxzd9LusAr
+ - id: uZWqdqBvDSUXFyo8q4E65U
sortOrder: 4
fieldKey: promotion_id
label: Promotion ID
@@ -40959,7 +40959,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: i48rXSLqtsciHTMN4ihEBv
+ - id: mTw6ZHVhUfKVhetocUVBLF
sortOrder: 5
fieldKey: promotion_name
label: Promotion Name
@@ -40973,7 +40973,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 7qom4QKXuNEqJ21hAK5iz2
+ - id: 92Uu2rzNMpA52CSxVUj1XS
sortOrder: 6
fieldKey: items
label: Products
@@ -41006,7 +41006,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: j4BSAtjzovFZNy3tcVDeNR
+ - id: dwov9AFhkTK5ttWnNb6fzj
sortOrder: 7
fieldKey: user_properties
label: User Properties
@@ -41023,7 +41023,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: t5SUwoJbx7pV1RLV3NLr64
+ - id: aShVGkdEftKDWuYUiyzC5L
sortOrder: 8
fieldKey: params
label: Event Parameters
@@ -41045,7 +41045,7 @@ items:
hidden: false
defaultTrigger: type = "track" and event = "Product Viewed"
fields:
- - id: dpqf32u55MiSay8R8h4qyc
+ - id: q2FZifEEfzwDzZnVKu2FRe
sortOrder: 0
fieldKey: user_id
label: User ID
@@ -41062,7 +41062,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: mexftMTnFM752K2ywoStWU
+ - id: 8F4fERHAtPHKJZ6BkNZW8e
sortOrder: 1
fieldKey: currency
label: Currency
@@ -41078,7 +41078,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: pUsSNVoKLG5NHu8buxeaCy
+ - id: dTQYjjvDXT92DhoCmZeai6
sortOrder: 2
fieldKey: value
label: Value
@@ -41092,7 +41092,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 2fuLjW7Gh92zrFuJKw9C6Z
+ - id: uFMKwWFXk9jKJoWkozzSJ4
sortOrder: 3
fieldKey: items
label: Products
@@ -41125,7 +41125,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 7NzPEHQdb6LnPpnTUX17br
+ - id: iGDUqFui8hWxAEj5JtjMSX
sortOrder: 4
fieldKey: user_properties
label: User Properties
@@ -41142,7 +41142,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: haaDz6nnC8VgkHXeDjBLby
+ - id: s49G4gD64qYmS58RUykHuS
sortOrder: 5
fieldKey: params
label: Event Parameters
@@ -41162,7 +41162,7 @@ items:
hidden: false
defaultTrigger: type = "track" and event = "Checkout Started"
fields:
- - id: xdujwuxC9UMmPfovFMbZMz
+ - id: 8jgaew1DLE5jVfmBEPsaHC
sortOrder: 0
fieldKey: user_id
label: User ID
@@ -41179,7 +41179,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: hc3jXVUqeCFarAvH9Bg3oU
+ - id: 6rWkn6eCMEC4PFGLnHB2DU
sortOrder: 1
fieldKey: coupon
label: Coupon
@@ -41193,7 +41193,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: ibpmxVBqBxDtze1VsZ6pVD
+ - id: 9sRs7G1Y1xarfq2beyo6gg
sortOrder: 2
fieldKey: currency
label: Currency
@@ -41209,7 +41209,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: jTw7epdZ6zbC6cvUeyKNwe
+ - id: tpq4ZzpnZHCq3vgojrRb7d
sortOrder: 3
fieldKey: items
label: Products
@@ -41244,7 +41244,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: qUxFzLSBSEM8uZuqzdumkv
+ - id: b1RozrwVcHwKNAKFaFLkBc
sortOrder: 4
fieldKey: value
label: Value
@@ -41258,7 +41258,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: nJychqiyrKU9EKx3TCBfH4
+ - id: fNd4qU7WGWA4w4psr6KQHT
sortOrder: 5
fieldKey: params
label: Event Parameters
@@ -41270,7 +41270,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: qBbMuu8Vv42r5XoAdpWrAE
+ - id: ofPgXiKudCfXTzBWJYSTFP
sortOrder: 6
fieldKey: user_properties
label: User Properties
@@ -41295,7 +41295,7 @@ items:
hidden: false
defaultTrigger: type = "track" and event = "Signed In"
fields:
- - id: mdN7kfRGcsG71T8PvRv27J
+ - id: x2bVYCx4s5QpmVB2d53KM3
sortOrder: 0
fieldKey: user_id
label: User ID
@@ -41312,7 +41312,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 5KCyKM9ULxqXx5T7i5U5JY
+ - id: dSrsgpgWzdY8yhhb8VbQD4
sortOrder: 1
fieldKey: method
label: Method
@@ -41326,7 +41326,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: mapQWezVw3Nz4hP6LTxXrs
+ - id: wcERUfrwvoqJRhntmkTPYs
sortOrder: 2
fieldKey: user_properties
label: User Properties
@@ -41343,7 +41343,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 7SetJDsraCzbBKhMZ3j7a6
+ - id: Khkvk6Tmjw1th23CoueYM
sortOrder: 3
fieldKey: params
label: Event Parameters
@@ -43597,7 +43597,7 @@ items:
hidden: false
defaultTrigger: type = "track"
fields:
- - id: nKNcdqKUA45mjMYCPV7TD1
+ - id: aH3SVka9XSgyHitdWpcJGc
sortOrder: 0
fieldKey: eventName
label: Event Name
@@ -43613,9 +43613,9 @@ items:
required: true
multiple: false
choices: null
- dynamic: false
+ dynamic: true
allowNull: false
- - id: gFb5XVU7c3uTfy9fPcHHK4
+ - id: bmJa2E7E1H9BNwWbFZ1puW
sortOrder: 1
fieldKey: occurredAt
label: Event Timestamp
@@ -43631,7 +43631,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: kjReVUtSMUjiS4CToVyzeh
+ - id: bBgdEue3x3DKPvUZQrQZ9G
sortOrder: 2
fieldKey: email
label: Email Address
@@ -43653,7 +43653,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: jHMW9B1zknuKoWuK2yg1Ny
+ - id: xh6FyMFwbBYZykb9nG6MkZ
sortOrder: 3
fieldKey: utk
label: User Token
@@ -43667,7 +43667,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 41kVteuEaA73tzEYKPD7wT
+ - id: copM5UAUBzEdNbzAFrjbwK
sortOrder: 4
fieldKey: objectId
label: Object ID
@@ -43682,7 +43682,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: qKUF4bKzwfVZJkjqmc5tLX
+ - id: dXtTFdQLB8gNDCyHxYmdtK
sortOrder: 5
fieldKey: properties
label: Event Properties
@@ -43699,273 +43699,6 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: dfT2tG36Ddr8MUKCUvcvLt
- name: Upsert Company
- slug: upsertCompany
- description: Create or update a company in HubSpot.
- platform: CLOUD
- hidden: false
- defaultTrigger: type = "group"
- fields:
- - id: vS7JjwXVgqLQMnjRzyU2wH
- sortOrder: 0
- fieldKey: groupid
- label: Unique Company Identifier
- type: STRING
- description: >-
- A unique identifier you assign to a company. Segment creates a custom
- property in HubSpot to store this value for each company so it can be
- used as a unique search field. Segment recommends not changing this
- value once set to avoid creating duplicate companies.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.groupId
- then:
- '@path': $.groupId
- else:
- '@path': $.context.groupId
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 7a6Pu9T27gTExrim9Dzg2J
- sortOrder: 1
- fieldKey: createNewCompany
- label: Create Company if Not Found
- type: BOOLEAN
- description: >-
- If true, Segment will attempt to update an existing company in HubSpot
- and if no company is found, Segment will create a new company. If false,
- Segment will only attempt to update an existing company and never create
- a new company. This is set to true by default.
- placeholder: ''
- defaultValue: true
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: kmz68Ncshyjhpu8pEizK1f
- sortOrder: 2
- fieldKey: associateContact
- label: Associate Contact with Company
- type: BOOLEAN
- description: >-
- If true, Segment will associate the company with the user identified in
- your payload. If no contact is found in HubSpot, an error is thrown and
- the company is not created/updated. If false, Segment will not attempt
- to associate a contact with the company and companies can be
- created/updated without requiring a contact association. This is set to
- true by default.
- placeholder: ''
- defaultValue: true
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: ruH6gKEGEzBboQD7mAetV3
- sortOrder: 3
- fieldKey: companysearchfields
- label: Company Search Fields
- type: OBJECT
- description: >-
- The unique field(s) used to search for an existing company in HubSpot to
- update. By default, Segment creates a custom property to store groupId
- for each company and uses this property to search for companies. If a
- company is not found, the fields provided here are then used to search.
- If a company is still not found, a new one is created.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: axbhi8B7UbhSuxzmh3dqNW
- sortOrder: 4
- fieldKey: name
- label: Company Name
- type: STRING
- description: The name of the company.
- placeholder: ''
- defaultValue:
- '@path': $.traits.name
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: gbdFf9i8qsh5jNA1S6ospu
- sortOrder: 5
- fieldKey: description
- label: Company Description
- type: STRING
- description: A short statement about the company’s mission and goals.
- placeholder: ''
- defaultValue:
- '@path': $.traits.description
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: eug3LDEsQZ8fKYh68QGpM3
- sortOrder: 6
- fieldKey: address
- label: Street Address
- type: STRING
- description: The street address of the company.
- placeholder: ''
- defaultValue:
- '@path': $.traits.address.street
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 3X7qogMuUxEFDJKX4npmgu
- sortOrder: 7
- fieldKey: city
- label: City
- type: STRING
- description: The city where the company is located.
- placeholder: ''
- defaultValue:
- '@path': $.traits.address.city
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 4dYENXp1tiNg43GttrsiFz
- sortOrder: 8
- fieldKey: state
- label: State
- type: STRING
- description: The state or region where the company is located.
- placeholder: ''
- defaultValue:
- '@path': $.traits.address.state
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: ibu4kbGbxWnP1QeCCjxuy3
- sortOrder: 9
- fieldKey: zip
- label: Postal Code
- type: STRING
- description: The postal or zip code of the company.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.address.postalCode
- then:
- '@path': $.traits.address.postalCode
- else:
- '@path': $.traits.address.postal_code
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: c9cYwKMEgxXnjwB7ctqspe
- sortOrder: 10
- fieldKey: domain
- label: Domain
- type: STRING
- description: The company’s website domain.
- placeholder: ''
- defaultValue:
- '@path': $.traits.website
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: maupQ5rTokuNtDof7hkLT2
- sortOrder: 11
- fieldKey: phone
- label: Phone
- type: STRING
- description: The company’s primary phone number.
- placeholder: ''
- defaultValue:
- '@path': $.traits.phone
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: susEBu1ytWiV3MtRh6K7Bf
- sortOrder: 12
- fieldKey: numberofemployees
- label: Number of Employees
- type: INTEGER
- description: The total number of people who work for the company.
- placeholder: ''
- defaultValue:
- '@path': $.traits.employees
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: mK8MFuQE8za2NHdtZYYsYk
- sortOrder: 13
- fieldKey: industry
- label: Industry
- type: STRING
- description: The type of business the company performs.
- placeholder: ''
- defaultValue:
- '@path': $.traits.industry
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 9HhJhqatFFMVzninrrw4gN
- sortOrder: 14
- fieldKey: lifecyclestage
- label: Lifecycle Stage
- type: STRING
- description: >-
- The company’s stage within the marketing/sales process. See more
- information on default and custom stages in [HubSpot’s
- documentation](https://knowledge.hubspot.com/contacts/use-lifecycle-stages).
- Segment supports moving status forwards or backwards.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 2Wzh4HW12BvEAAY754zKFb
- sortOrder: 15
- fieldKey: properties
- label: Other Properties
- type: OBJECT
- description: >-
- Any other default or custom company properties. On the left-hand side,
- input the internal name of the property as seen in your HubSpot account.
- On the right-hand side, map the Segment field that contains the value.
- Custom properties must be predefined in HubSpot. See more information in
- [HubSpot’s
- documentation](https://knowledge.hubspot.com/crm-setup/manage-your-properties#create-custom-properties).
- Important: Do not use ’segment_group_id’ here as it is an internal
- property and will result in an an error.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- id: fRn8RWTicuG6dpma5JKi9d
name: Upsert Custom Object Record
slug: upsertCustomObjectRecord
@@ -43974,7 +43707,7 @@ items:
hidden: false
defaultTrigger: null
fields:
- - id: fGPdKbTviSEqqCv4JGheoZ
+ - id: vnTMae3GfAqhSNpvVy5Ckp
sortOrder: 0
fieldKey: createNewCustomRecord
label: Create Custom Object Record if Not Found
@@ -43991,7 +43724,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: oDztXeoCfofzMg4MojckAv
+ - id: chuh5FJ52yzBjhiw4Mnizy
sortOrder: 1
fieldKey: customObjectSearchFields
label: Custom Object Search Fields
@@ -44006,7 +43739,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: oecuX9JW6hBWzDts72ggDt
+ - id: qg5CT9Ab4Ug4dPLLwKjJbo
sortOrder: 2
fieldKey: objectType
label: Object Type
@@ -44024,7 +43757,7 @@ items:
choices: null
dynamic: true
allowNull: false
- - id: hQGErnxtrJv95Pp2bCsSAQ
+ - id: fiqcfLvqdgcGAHcoSabvtx
sortOrder: 3
fieldKey: properties
label: Properties
@@ -44042,7 +43775,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: piG2yrMK9ijTmUqRX8Fi5N
+ - id: hXxpBwwZ9yCauDnjXgBXPU
sortOrder: 4
fieldKey: searchFieldsToAssociateCustomObjects
label: Search Fields to Associate custom Object
@@ -44058,7 +43791,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 7UuqnNrysHFNY5wprU2jwP
+ - id: e5fpPBaiuLyvggRwZWXc55
sortOrder: 5
fieldKey: toObjectType
label: ObjectType to associate
@@ -44076,7 +43809,7 @@ items:
choices: null
dynamic: true
allowNull: false
- - id: orFhvhnWfQjaFp7NYKJBou
+ - id: 9SYYLi6wAnd3GJABNrjtKh
sortOrder: 6
fieldKey: associationLabel
label: Association Label
@@ -44096,7 +43829,7 @@ items:
hidden: false
defaultTrigger: type = "identify"
fields:
- - id: s2W9p89P2pMRXgnNFWm4rT
+ - id: jiK1tsmBQFyQSQNqDWEB74
sortOrder: 0
fieldKey: email
label: Email
@@ -44114,7 +43847,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 6EY146WitkJtDaYkR558XA
+ - id: uKumAWbj4GJ2tjbAXnhKY2
sortOrder: 1
fieldKey: company
label: Company Name
@@ -44128,7 +43861,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: rVVHPpwRTTgCDBxNjQ7phC
+ - id: rW6gEHexDVTcTDCXtvA83u
sortOrder: 2
fieldKey: firstname
label: First Name
@@ -44148,7 +43881,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: do5k4iepWuaHGwXHFjmbDW
+ - id: vJoh1o8yrbKj9CGTbRMVvZ
sortOrder: 3
fieldKey: lastname
label: Last Name
@@ -44168,7 +43901,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 2A2eFd9zmWp5hGovG4fz99
+ - id: sZDXgbGD2Qhn3xe8xF4VRL
sortOrder: 4
fieldKey: phone
label: Phone
@@ -44182,7 +43915,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: hjdqB9LstCtubrkMF2ZQpy
+ - id: 3vui85w7StUH2HLuzDdrn
sortOrder: 5
fieldKey: address
label: Street Address
@@ -44196,7 +43929,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: vwdWrryt9RfeVKTYzN1GyS
+ - id: uaBNU1BXGq2HP4SAvVMcKK
sortOrder: 6
fieldKey: city
label: City
@@ -44210,7 +43943,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: hTJfvwwSzSBBJUYa7fGRZc
+ - id: dfcL3XP7rTNzDWmqcAkSG6
sortOrder: 7
fieldKey: state
label: State
@@ -44224,7 +43957,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: d7eWtVkrLJ1jjSHMTJc7fV
+ - id: 8vN56i7f2xhgS9fBrEi6fR
sortOrder: 8
fieldKey: country
label: Country
@@ -44238,7 +43971,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: akct2ybHCGZjrLVjwpXJXn
+ - id: 86kUgcfqQ3sADgLAqiMKum
sortOrder: 9
fieldKey: zip
label: Postal Code
@@ -44258,7 +43991,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: fGwtxvKcru1MEwF9f8Wnnh
+ - id: 8iZhdKhxvassLNeqUnn7XC
sortOrder: 10
fieldKey: website
label: Website
@@ -44272,7 +44005,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: oTzj3FCjtnfbwgjp6CgMv3
+ - id: xbkNYvgdztso3rBDhfF6Sh
sortOrder: 11
fieldKey: lifecyclestage
label: Lifecycle Stage
@@ -44288,7 +44021,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: mPW3rg1C7GNPt5qpivgigL
+ - id: wipHiHbtyp6PV6C3zdXNYE
sortOrder: 12
fieldKey: properties
label: Other properties
@@ -44306,7 +44039,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: cw7DbFX9rusmDTK7u963sg
+ - id: uChHsuCVoB7N8AcBZuv5Tk
sortOrder: 13
fieldKey: enable_batching
label: Send Batch Data to HubSpot
@@ -44323,6 +44056,273 @@ items:
choices: null
dynamic: false
allowNull: false
+ - id: dfT2tG36Ddr8MUKCUvcvLt
+ name: Upsert Company
+ slug: upsertCompany
+ description: Create or update a company in HubSpot.
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: type = "group"
+ fields:
+ - id: ptoi3aUcSNJ7s4BQ58Dgtv
+ sortOrder: 0
+ fieldKey: groupid
+ label: Unique Company Identifier
+ type: STRING
+ description: >-
+ A unique identifier you assign to a company. Segment creates a custom
+ property in HubSpot to store this value for each company so it can be
+ used as a unique search field. Segment recommends not changing this
+ value once set to avoid creating duplicate companies.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.groupId
+ then:
+ '@path': $.groupId
+ else:
+ '@path': $.context.groupId
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 7CS13NM7wsDM3RtDQwSBxJ
+ sortOrder: 1
+ fieldKey: createNewCompany
+ label: Create Company if Not Found
+ type: BOOLEAN
+ description: >-
+ If true, Segment will attempt to update an existing company in HubSpot
+ and if no company is found, Segment will create a new company. If false,
+ Segment will only attempt to update an existing company and never create
+ a new company. This is set to true by default.
+ placeholder: ''
+ defaultValue: true
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 9Bq7nvrkrAJN7f1QCGNHsw
+ sortOrder: 2
+ fieldKey: associateContact
+ label: Associate Contact with Company
+ type: BOOLEAN
+ description: >-
+ If true, Segment will associate the company with the user identified in
+ your payload. If no contact is found in HubSpot, an error is thrown and
+ the company is not created/updated. If false, Segment will not attempt
+ to associate a contact with the company and companies can be
+ created/updated without requiring a contact association. This is set to
+ true by default.
+ placeholder: ''
+ defaultValue: true
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: mzr6ZWhVDJiEE2XKfp1a6j
+ sortOrder: 3
+ fieldKey: companysearchfields
+ label: Company Search Fields
+ type: OBJECT
+ description: >-
+ The unique field(s) used to search for an existing company in HubSpot to
+ update. By default, Segment creates a custom property to store groupId
+ for each company and uses this property to search for companies. If a
+ company is not found, the fields provided here are then used to search.
+ If a company is still not found, a new one is created.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: kzobKrsSRknVzyRXjwvYPH
+ sortOrder: 4
+ fieldKey: name
+ label: Company Name
+ type: STRING
+ description: The name of the company.
+ placeholder: ''
+ defaultValue:
+ '@path': $.traits.name
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: oZpH4vPE9YdjHBsMgonUWc
+ sortOrder: 5
+ fieldKey: description
+ label: Company Description
+ type: STRING
+ description: A short statement about the company’s mission and goals.
+ placeholder: ''
+ defaultValue:
+ '@path': $.traits.description
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: cQ5dwdcB6EcoaubyigCb3m
+ sortOrder: 6
+ fieldKey: address
+ label: Street Address
+ type: STRING
+ description: The street address of the company.
+ placeholder: ''
+ defaultValue:
+ '@path': $.traits.address.street
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: kAzQ1B2sJymr9p1rmbB8hw
+ sortOrder: 7
+ fieldKey: city
+ label: City
+ type: STRING
+ description: The city where the company is located.
+ placeholder: ''
+ defaultValue:
+ '@path': $.traits.address.city
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: cb7wDCwLgmA5eSMgVCtv2W
+ sortOrder: 8
+ fieldKey: state
+ label: State
+ type: STRING
+ description: The state or region where the company is located.
+ placeholder: ''
+ defaultValue:
+ '@path': $.traits.address.state
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: paTF97M1oCxNhg67Dtjz9j
+ sortOrder: 9
+ fieldKey: zip
+ label: Postal Code
+ type: STRING
+ description: The postal or zip code of the company.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.traits.address.postalCode
+ then:
+ '@path': $.traits.address.postalCode
+ else:
+ '@path': $.traits.address.postal_code
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: eBNFWZ4VJMKAqX1MdTusMa
+ sortOrder: 10
+ fieldKey: domain
+ label: Domain
+ type: STRING
+ description: The company’s website domain.
+ placeholder: ''
+ defaultValue:
+ '@path': $.traits.website
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: cASpQicCj5N7wwpEJ4XvCU
+ sortOrder: 11
+ fieldKey: phone
+ label: Phone
+ type: STRING
+ description: The company’s primary phone number.
+ placeholder: ''
+ defaultValue:
+ '@path': $.traits.phone
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: jd2DG6oanwNUK5YDaKZrch
+ sortOrder: 12
+ fieldKey: numberofemployees
+ label: Number of Employees
+ type: INTEGER
+ description: The total number of people who work for the company.
+ placeholder: ''
+ defaultValue:
+ '@path': $.traits.employees
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 3shQG5n1stv5SHQ5KREYi7
+ sortOrder: 13
+ fieldKey: industry
+ label: Industry
+ type: STRING
+ description: The type of business the company performs.
+ placeholder: ''
+ defaultValue:
+ '@path': $.traits.industry
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 4sQKpVXjCtPwBLfhepuCrM
+ sortOrder: 14
+ fieldKey: lifecyclestage
+ label: Lifecycle Stage
+ type: STRING
+ description: >-
+ The company’s stage within the marketing/sales process. See more
+ information on default and custom stages in [HubSpot’s
+ documentation](https://knowledge.hubspot.com/contacts/use-lifecycle-stages).
+ Segment supports moving status forwards or backwards.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: tekZeGFdM55KfFyPf2RGWz
+ sortOrder: 15
+ fieldKey: properties
+ label: Other Properties
+ type: OBJECT
+ description: >-
+ Any other default or custom company properties. On the left-hand side,
+ input the internal name of the property as seen in your HubSpot account.
+ On the right-hand side, map the Segment field that contains the value.
+ Custom properties must be predefined in HubSpot. See more information in
+ [HubSpot’s
+ documentation](https://knowledge.hubspot.com/crm-setup/manage-your-properties#create-custom-properties).
+ Important: Do not use ’segment_group_id’ here as it is an internal
+ property and will result in an an error.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
presets: []
- id: 631a1c2bfdce36a23f0a14ec
display_name: HubSpot Web (Actions)
@@ -48578,6 +48578,143 @@ items:
server: true
settings: []
actions:
+ - id: C5A9XfbiQnCfksZHXbMhK
+ name: Track Event
+ slug: trackEvent
+ description: Submit an event to Intercom.
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: type = "track"
+ fields:
+ - id: cxYz7kBqvCFddpn4BoAmi7
+ sortOrder: 0
+ fieldKey: event_name
+ label: Event Name
+ type: STRING
+ description: >-
+ The name of the event that occurred. Names are treated as case
+ insensitive. Periods and dollar signs in event names are replaced with
+ hyphens.
+ placeholder: ''
+ defaultValue:
+ '@path': $.event
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 4ZvDFtwpLXWnDrMADXa9HC
+ sortOrder: 1
+ fieldKey: created_at
+ label: Event Timestamp
+ type: DATETIME
+ description: >-
+ The time the event occurred as a UTC Unix timestamp. Segment will
+ convert to Unix if not already converted.
+ placeholder: ''
+ defaultValue:
+ '@path': $.timestamp
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: dRHQUsbzAdpyqPhTfpFhZL
+ sortOrder: 2
+ fieldKey: user_id
+ label: User ID
+ type: STRING
+ description: >-
+ Your identifier for the user who performed the event. User ID is
+ required if no email or Contact ID is provided.
+ placeholder: ''
+ defaultValue:
+ '@path': $.userId
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: dnZubXq4cZ5Hemu9rXph32
+ sortOrder: 3
+ fieldKey: email
+ label: Email Address
+ type: STRING
+ description: >-
+ The email address for the user who performed the event. Email is
+ required if no User ID or Contact ID is provided.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.email
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: fDBu4dD1cDFXr4f4WuAgN7
+ sortOrder: 4
+ fieldKey: revenue
+ label: Revenue
+ type: NUMBER
+ description: >-
+ The amount associated with a purchase. Segment will multiply by 100 as
+ Intercom requires the amount in cents.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.revenue
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 98jA3MA7FJs3yEU39796B4
+ sortOrder: 5
+ fieldKey: currency
+ label: Currency
+ type: STRING
+ description: >-
+ The currency of the purchase amount. Segment will default to USD if
+ revenue is provided without a currency.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.currency
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: tAERWbarfX1Jd1tErMhebQ
+ sortOrder: 6
+ fieldKey: id
+ label: Contact ID
+ type: STRING
+ description: >-
+ Intercom's unique identifier for the contact. If no Contact ID is
+ provided, Segment will use User ID or Email to find a user or lead.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: gQesvdf3pWtu4Rc2oTYozV
+ sortOrder: 7
+ fieldKey: metadata
+ label: Event Metadata
+ type: OBJECT
+ description: >-
+ Optional metadata describing the event. Each event can contain up to ten
+ metadata key-value pairs. If you send more than ten keys, Intercom will
+ ignore the rest. Intercom does not support nested JSON structures within
+ metadata.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
- id: 3Tk7gpN5MvNbTxnRDeJzKr
name: Identify Company
slug: groupIdentifyContact
@@ -48766,143 +48903,6 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: C5A9XfbiQnCfksZHXbMhK
- name: Track Event
- slug: trackEvent
- description: Submit an event to Intercom.
- platform: CLOUD
- hidden: false
- defaultTrigger: type = "track"
- fields:
- - id: cxYz7kBqvCFddpn4BoAmi7
- sortOrder: 0
- fieldKey: event_name
- label: Event Name
- type: STRING
- description: >-
- The name of the event that occurred. Names are treated as case
- insensitive. Periods and dollar signs in event names are replaced with
- hyphens.
- placeholder: ''
- defaultValue:
- '@path': $.event
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 4ZvDFtwpLXWnDrMADXa9HC
- sortOrder: 1
- fieldKey: created_at
- label: Event Timestamp
- type: DATETIME
- description: >-
- The time the event occurred as a UTC Unix timestamp. Segment will
- convert to Unix if not already converted.
- placeholder: ''
- defaultValue:
- '@path': $.timestamp
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: dRHQUsbzAdpyqPhTfpFhZL
- sortOrder: 2
- fieldKey: user_id
- label: User ID
- type: STRING
- description: >-
- Your identifier for the user who performed the event. User ID is
- required if no email or Contact ID is provided.
- placeholder: ''
- defaultValue:
- '@path': $.userId
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: dnZubXq4cZ5Hemu9rXph32
- sortOrder: 3
- fieldKey: email
- label: Email Address
- type: STRING
- description: >-
- The email address for the user who performed the event. Email is
- required if no User ID or Contact ID is provided.
- placeholder: ''
- defaultValue:
- '@path': $.properties.email
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: fDBu4dD1cDFXr4f4WuAgN7
- sortOrder: 4
- fieldKey: revenue
- label: Revenue
- type: NUMBER
- description: >-
- The amount associated with a purchase. Segment will multiply by 100 as
- Intercom requires the amount in cents.
- placeholder: ''
- defaultValue:
- '@path': $.properties.revenue
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 98jA3MA7FJs3yEU39796B4
- sortOrder: 5
- fieldKey: currency
- label: Currency
- type: STRING
- description: >-
- The currency of the purchase amount. Segment will default to USD if
- revenue is provided without a currency.
- placeholder: ''
- defaultValue:
- '@path': $.properties.currency
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: tAERWbarfX1Jd1tErMhebQ
- sortOrder: 6
- fieldKey: id
- label: Contact ID
- type: STRING
- description: >-
- Intercom's unique identifier for the contact. If no Contact ID is
- provided, Segment will use User ID or Email to find a user or lead.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: gQesvdf3pWtu4Rc2oTYozV
- sortOrder: 7
- fieldKey: metadata
- label: Event Metadata
- type: OBJECT
- description: >-
- Optional metadata describing the event. Each event can contain up to ten
- metadata key-value pairs. If you send more than ten keys, Intercom will
- ignore the rest. Intercom does not support nested JSON structures within
- metadata.
- placeholder: ''
- defaultValue:
- '@path': $.properties
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- id: sXZzg4LGsu5WVyx5imvkWL
name: Identify Contact
slug: identifyContact
@@ -49156,6 +49156,74 @@ items:
required: true
label: Rich Link Properties
actions:
+ - id: obbhMxCCfbwRwxViADd4Dq
+ name: Track Event
+ slug: trackEvent
+ description: Submit an event to Intercom.
+ platform: WEB
+ hidden: false
+ defaultTrigger: type = "track"
+ fields:
+ - id: qvKDyrxKJFCyapD8V2LbV4
+ sortOrder: 0
+ fieldKey: event_name
+ label: Event Name
+ type: STRING
+ description: The name of the event.
+ placeholder: ''
+ defaultValue:
+ '@path': $.event
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 4SrYnNvGoEHCTiGBXnBzFA
+ sortOrder: 1
+ fieldKey: revenue
+ label: Revenue
+ type: NUMBER
+ description: >-
+ The amount associated with a purchase. Segment will multiply by 100 as
+ Intercom requires the amount in cents.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.revenue
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: o8py5UCoNf4Z8NQHnyZVHC
+ sortOrder: 2
+ fieldKey: currency
+ label: Currency
+ type: STRING
+ description: >-
+ The currency of the purchase amount. Segment will default to USD if
+ revenue is provided without a currency.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.currency
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 3Rng2h7ZEMAtbXwNrPWWCF
+ sortOrder: 3
+ fieldKey: event_metadata
+ label: Event Metadata
+ type: OBJECT
+ description: Optional metadata describing the event.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
- id: 9e8n4VX1tR81fawEiAtGPg
name: Identify Company
slug: identifyCompany
@@ -49225,74 +49293,6 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: obbhMxCCfbwRwxViADd4Dq
- name: Track Event
- slug: trackEvent
- description: Submit an event to Intercom.
- platform: WEB
- hidden: false
- defaultTrigger: type = "track"
- fields:
- - id: qvKDyrxKJFCyapD8V2LbV4
- sortOrder: 0
- fieldKey: event_name
- label: Event Name
- type: STRING
- description: The name of the event.
- placeholder: ''
- defaultValue:
- '@path': $.event
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 4SrYnNvGoEHCTiGBXnBzFA
- sortOrder: 1
- fieldKey: revenue
- label: Revenue
- type: NUMBER
- description: >-
- The amount associated with a purchase. Segment will multiply by 100 as
- Intercom requires the amount in cents.
- placeholder: ''
- defaultValue:
- '@path': $.properties.revenue
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: o8py5UCoNf4Z8NQHnyZVHC
- sortOrder: 2
- fieldKey: currency
- label: Currency
- type: STRING
- description: >-
- The currency of the purchase amount. Segment will default to USD if
- revenue is provided without a currency.
- placeholder: ''
- defaultValue:
- '@path': $.properties.currency
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 3Rng2h7ZEMAtbXwNrPWWCF
- sortOrder: 3
- fieldKey: event_metadata
- label: Event Metadata
- type: OBJECT
- description: Optional metadata describing the event.
- placeholder: ''
- defaultValue:
- '@path': $.properties
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- id: soJTzcZj8roZAwGZow5YNp
name: Identify User
slug: identifyUser
@@ -52207,252 +52207,6 @@ items:
required: true
label: API Key
actions:
- - id: 5YPbdm7ah3qQRMGnQDrYAy
- name: Order Completed
- slug: orderCompleted
- description: >-
- Order Completed Event action tracks users Order Completed events and
- associate it with their profile.
- platform: CLOUD
- hidden: false
- defaultTrigger: type = "track"
- fields:
- - id: eUhTXEMfETpPzuayf6rpwA
- sortOrder: 0
- fieldKey: profile
- label: Profile
- type: OBJECT
- description: Properties of the profile that triggered this event.
- placeholder: ''
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 2RjvkJKwjuYzrJ8Uf2mjXm
- sortOrder: 1
- fieldKey: properties
- label: Properties
- type: OBJECT
- description: Properties of this event.
- placeholder: ''
- defaultValue:
- '@path': $.properties
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: nDoQPtst8uboXCXwuKisp
- sortOrder: 2
- fieldKey: time
- label: Time
- type: DATETIME
- description: >-
- When this event occurred. By default, the time the request was received
- will be used.
- The time is truncated to the second. The time must be after the year 2000 and can only
- be up to 1 year in the future.
-
- placeholder: ''
- defaultValue:
- '@path': $.timestamp
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 9LbSJsAbjibZ1RsT7yiu5d
- sortOrder: 3
- fieldKey: value
- label: Value
- type: NUMBER
- description: >-
- A numeric value to associate with this event. For example, the dollar
- amount of a purchase.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: r8hbYvyF9truwou2fgWHYg
- sortOrder: 4
- fieldKey: unique_id
- label: Unique ID
- type: STRING
- description: >-
- A unique identifier for an event. If the unique_id is repeated for the
- same
- profile and metric, only the first processed event will be recorded. If this is not
- present, this will use the time to the second. Using the default, this limits only one
- event per profile per second.
-
- placeholder: ''
- defaultValue:
- '@path': $.messageId
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: rcrX17AnCa4eBdjDiK6xL7
- sortOrder: 5
- fieldKey: products
- label: Products
- type: OBJECT
- description: List of products purchased in the order.
- placeholder: ''
- required: false
- multiple: true
- choices: null
- dynamic: false
- allowNull: false
- - id: 88kMUHcA4pyvAyVUVNztL2
- name: Remove profile from list
- slug: removeProfileFromList
- description: Remove profile from list
- platform: CLOUD
- hidden: false
- defaultTrigger: event = "Audience Exited"
- fields:
- - id: rYJwV38E5Z4rzCvKwEP82o
- sortOrder: 0
- fieldKey: email
- label: Email
- type: STRING
- description: The user's email to send to Klavio.
- placeholder: ''
- defaultValue:
- '@path': $.context.traits.email
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: hNCHqSegRF2LGJKbhg16VH
- sortOrder: 1
- fieldKey: external_id
- label: External ID
- type: STRING
- description: >-
- A unique identifier used by customers to associate Klaviyo profiles with
- profiles in an external system. One of External ID and Email required.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: bcTogP3k6Gj48vWnVduvMx
- sortOrder: 2
- fieldKey: list_id
- label: List Id
- type: STRING
- description: >-
- 'Insert the ID of the default list that you'd like to subscribe users to
- when you call .identify().'
- placeholder: ''
- defaultValue:
- '@path': $.context.personas.external_audience_id
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 3iQVw5DFkvuW3Q59f5Ftx2
- sortOrder: 3
- fieldKey: enable_batching
- label: Batch Data to Klaviyo
- type: BOOLEAN
- description: When enabled, the action will use the klaviyo batch API.
- placeholder: ''
- defaultValue: true
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 9XeQC7vecFTQE17eM1DeLN
- name: Add Profile To List
- slug: addProfileToList
- description: Add Profile To List
- platform: CLOUD
- hidden: false
- defaultTrigger: event = "Audience Entered"
- fields:
- - id: iTYyPhCX4KDiWQmFFwRWC5
- sortOrder: 0
- fieldKey: email
- label: Email
- type: STRING
- description: The user's email to send to Klavio.
- placeholder: ''
- defaultValue:
- '@path': $.context.traits.email
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 9doQo1G8a71EgTqQbALNzw
- sortOrder: 1
- fieldKey: list_id
- label: List Id
- type: STRING
- description: >-
- 'Insert the ID of the default list that you'd like to subscribe users to
- when you call .identify().'
- placeholder: ''
- defaultValue:
- '@path': $.context.personas.external_audience_id
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 4pTMBxWFkAseyz47erLLcH
- sortOrder: 2
- fieldKey: external_id
- label: External ID
- type: STRING
- description: >-
- A unique identifier used by customers to associate Klaviyo profiles with
- profiles in an external system. One of External ID and Email required.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 6Xs2McWHXRRSzN4B6Mq1S9
- sortOrder: 3
- fieldKey: enable_batching
- label: Batch Data to Klaviyo
- type: BOOLEAN
- description: When enabled, the action will use the klaviyo batch API.
- placeholder: ''
- defaultValue: true
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: fEucaT9w93sGoKS6zihpjG
- sortOrder: 4
- fieldKey: batch_size
- label: Batch Size
- type: NUMBER
- description: >-
- Maximum number of events to include in each batch. Actual batch sizes
- may be lower.
- placeholder: ''
- defaultValue: 10000
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- id: e3hcjRJqFJAJYkAis7RpeV
name: Upsert Profile
slug: upsertProfile
@@ -52659,6 +52413,107 @@ items:
choices: null
dynamic: false
allowNull: false
+ - id: 5YPbdm7ah3qQRMGnQDrYAy
+ name: Order Completed
+ slug: orderCompleted
+ description: >-
+ Order Completed Event action tracks users Order Completed events and
+ associate it with their profile.
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: type = "track"
+ fields:
+ - id: eUhTXEMfETpPzuayf6rpwA
+ sortOrder: 0
+ fieldKey: profile
+ label: Profile
+ type: OBJECT
+ description: Properties of the profile that triggered this event.
+ placeholder: ''
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 2RjvkJKwjuYzrJ8Uf2mjXm
+ sortOrder: 1
+ fieldKey: properties
+ label: Properties
+ type: OBJECT
+ description: Properties of this event.
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: nDoQPtst8uboXCXwuKisp
+ sortOrder: 2
+ fieldKey: time
+ label: Time
+ type: DATETIME
+ description: >-
+ When this event occurred. By default, the time the request was received
+ will be used.
+ The time is truncated to the second. The time must be after the year 2000 and can only
+ be up to 1 year in the future.
+
+ placeholder: ''
+ defaultValue:
+ '@path': $.timestamp
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 9LbSJsAbjibZ1RsT7yiu5d
+ sortOrder: 3
+ fieldKey: value
+ label: Value
+ type: NUMBER
+ description: >-
+ A numeric value to associate with this event. For example, the dollar
+ amount of a purchase.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: r8hbYvyF9truwou2fgWHYg
+ sortOrder: 4
+ fieldKey: unique_id
+ label: Unique ID
+ type: STRING
+ description: >-
+ A unique identifier for an event. If the unique_id is repeated for the
+ same
+ profile and metric, only the first processed event will be recorded. If this is not
+ present, this will use the time to the second. Using the default, this limits only one
+ event per profile per second.
+
+ placeholder: ''
+ defaultValue:
+ '@path': $.messageId
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: rcrX17AnCa4eBdjDiK6xL7
+ sortOrder: 5
+ fieldKey: products
+ label: Products
+ type: OBJECT
+ description: List of products purchased in the order.
+ placeholder: ''
+ required: false
+ multiple: true
+ choices: null
+ dynamic: false
+ allowNull: false
- id: f5syVWBeSA4KrrH3Yv5Q2N
name: Track Event
slug: trackEvent
@@ -52760,6 +52615,151 @@ items:
choices: null
dynamic: false
allowNull: false
+ - id: 88kMUHcA4pyvAyVUVNztL2
+ name: Remove profile from list
+ slug: removeProfileFromList
+ description: Remove profile from list
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: event = "Audience Exited"
+ fields:
+ - id: rYJwV38E5Z4rzCvKwEP82o
+ sortOrder: 0
+ fieldKey: email
+ label: Email
+ type: STRING
+ description: The user's email to send to Klavio.
+ placeholder: ''
+ defaultValue:
+ '@path': $.context.traits.email
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: hNCHqSegRF2LGJKbhg16VH
+ sortOrder: 1
+ fieldKey: external_id
+ label: External ID
+ type: STRING
+ description: >-
+ A unique identifier used by customers to associate Klaviyo profiles with
+ profiles in an external system. One of External ID and Email required.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: bcTogP3k6Gj48vWnVduvMx
+ sortOrder: 2
+ fieldKey: list_id
+ label: List Id
+ type: STRING
+ description: >-
+ 'Insert the ID of the default list that you'd like to subscribe users to
+ when you call .identify().'
+ placeholder: ''
+ defaultValue:
+ '@path': $.context.personas.external_audience_id
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 3iQVw5DFkvuW3Q59f5Ftx2
+ sortOrder: 3
+ fieldKey: enable_batching
+ label: Batch Data to Klaviyo
+ type: BOOLEAN
+ description: When enabled, the action will use the klaviyo batch API.
+ placeholder: ''
+ defaultValue: true
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 9XeQC7vecFTQE17eM1DeLN
+ name: Add Profile To List
+ slug: addProfileToList
+ description: Add Profile To List
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: event = "Audience Entered"
+ fields:
+ - id: iTYyPhCX4KDiWQmFFwRWC5
+ sortOrder: 0
+ fieldKey: email
+ label: Email
+ type: STRING
+ description: The user's email to send to Klavio.
+ placeholder: ''
+ defaultValue:
+ '@path': $.context.traits.email
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 9doQo1G8a71EgTqQbALNzw
+ sortOrder: 1
+ fieldKey: list_id
+ label: List Id
+ type: STRING
+ description: >-
+ 'Insert the ID of the default list that you'd like to subscribe users to
+ when you call .identify().'
+ placeholder: ''
+ defaultValue:
+ '@path': $.context.personas.external_audience_id
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 4pTMBxWFkAseyz47erLLcH
+ sortOrder: 2
+ fieldKey: external_id
+ label: External ID
+ type: STRING
+ description: >-
+ A unique identifier used by customers to associate Klaviyo profiles with
+ profiles in an external system. One of External ID and Email required.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 6Xs2McWHXRRSzN4B6Mq1S9
+ sortOrder: 3
+ fieldKey: enable_batching
+ label: Batch Data to Klaviyo
+ type: BOOLEAN
+ description: When enabled, the action will use the klaviyo batch API.
+ placeholder: ''
+ defaultValue: true
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: fEucaT9w93sGoKS6zihpjG
+ sortOrder: 4
+ fieldKey: batch_size
+ label: Batch Size
+ type: NUMBER
+ description: >-
+ Maximum number of events to include in each batch. Actual batch sizes
+ may be lower.
+ placeholder: ''
+ defaultValue: 10000
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
presets: []
- id: 6230c835c0d6535357ee950d
display_name: Koala
@@ -57127,30 +57127,86 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: a6YW8RCSKobYuCSEaiYKqY
- name: Track Purchase
- slug: trackPurchase
- description: Send an 'Order Completed' Event to Mixpanel.
+ - id: drUNmF6UifiVmB9NStLWS1
+ name: Group Identify User
+ slug: groupIdentifyUser
+ description: >-
+ Updates or adds properties to a group profile. The profile is created if
+ it does not exist. [Learn more about Group
+ Analytics.](https://help.mixpanel.com/hc/en-us/articles/360025333632-Group-Analytics?source=segment-actions)
platform: CLOUD
hidden: false
- defaultTrigger: type = "track"
+ defaultTrigger: type = "group"
fields:
- - id: 53Rwd9XQHEhNzyFDhGRtdG
+ - id: tj9z6XZQvaHKFizwpyCRxA
sortOrder: 0
- fieldKey: generatePurchaseEventPerProduct
- label: Generate Purchase Event Per Product
- type: BOOLEAN
+ fieldKey: group_key
+ label: Group Key
+ type: STRING
description: >-
- When enabled, send "Product Purchased" with each product within the
- event.
+ The group key you specified in Mixpanel under Project settings. If this
+ is not specified, it will be defaulted to "$group_id".
placeholder: ''
- defaultValue: true
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: chMGMRzqvcDvE2e9nPzy4W
+ - id: 3kLGD1VEPhTUtm29fZN8nw
+ sortOrder: 1
+ fieldKey: group_id
+ label: Group ID
+ type: STRING
+ description: >-
+ The unique identifier of the group. If there is a trait that matches the
+ group key, it will override this value.
+ placeholder: ''
+ defaultValue:
+ '@path': $.groupId
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: iPwBs6LYvyjDm6LjX2p3eQ
+ sortOrder: 2
+ fieldKey: traits
+ label: Group Properties
+ type: OBJECT
+ description: The properties to set on the group profile.
+ placeholder: ''
+ defaultValue:
+ '@path': $.traits
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: etDoZEKaPvjgeXw6c84cvi
+ name: Track Event
+ slug: trackEvent
+ description: >-
+ Send an event to Mixpanel. [Learn more about Events in
+ Mixpanel](https://help.mixpanel.com/hc/en-us/articles/360041995352-Mixpanel-Concepts-Events?source=segment-actions)
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: type = "track"
+ fields:
+ - id: gRm5z9ZvTKUwxB4pMtK6TY
+ sortOrder: 0
+ fieldKey: event
+ label: Event Name
+ type: STRING
+ description: The name of the action being performed.
+ placeholder: ''
+ defaultValue:
+ '@path': $.event
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: w7yoHPf9Mpu1Msc4xG89TG
sortOrder: 1
fieldKey: distinct_id
label: Distinct ID
@@ -57170,7 +57226,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: dQBRAAqhTpat7RQu8QXrhd
+ - id: 3FoRu9QTdxVx1kabK5QyTA
sortOrder: 2
fieldKey: anonymous_id
label: Anonymous ID
@@ -57184,7 +57240,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 7LsYRuywfnKDqskBXcYN1V
+ - id: 21q7dmwjeEzPcDpwZJ6qSf
sortOrder: 3
fieldKey: user_id
label: User ID
@@ -57198,7 +57254,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: sMSySVYa4QygdiWUgdM9DW
+ - id: jceKitrbM7rCz29MwARbBH
sortOrder: 4
fieldKey: group_id
label: Group ID
@@ -57212,7 +57268,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: oVHvXebJS5GTpsagvuudqR
+ - id: gdeQeunC2inXXAXFwnib6F
sortOrder: 5
fieldKey: insert_id
label: Insert ID
@@ -57228,7 +57284,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: wxvsJq3ZtTTVk6Q41oovuo
+ - id: p7jX6BfpkT2fWbeoQBLDYQ
sortOrder: 6
fieldKey: time
label: Timestamp
@@ -57246,7 +57302,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 7LAcVBYQe4wkTi4Fz24M52
+ - id: fiDfQptfuxKTBeCb5Qx9xq
sortOrder: 7
fieldKey: app_name
label: App Name
@@ -57260,7 +57316,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 6Vpp1xGHjjPYWWvetqitS1
+ - id: qcLC9ueVGQF2evmx2qKKjr
sortOrder: 8
fieldKey: app_namespace
label: App Namespace
@@ -57274,7 +57330,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: dngqfFeiNhu8unfAUVeudY
+ - id: dd9AzFCcN5MmmLP9zoSbct
sortOrder: 9
fieldKey: app_build
label: App Build
@@ -57288,7 +57344,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 8qEqiAeJmyRcmjUJHNpUyJ
+ - id: 2WdLdiMkv4PG34JCk7JT92
sortOrder: 10
fieldKey: app_version
label: App Version
@@ -57302,7 +57358,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 8xge5r37konvUpfCHhs61b
+ - id: sQxToyBdzwW6vPyvzKGq3P
sortOrder: 11
fieldKey: os_name
label: OS Name
@@ -57318,7 +57374,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: tQL3s88RJF2gHGjAKDcBs7
+ - id: rbKZqLMyoT3Fko3t4JT7dD
sortOrder: 12
fieldKey: os_version
label: OS Version
@@ -57332,7 +57388,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: cNvBZDuHDoMRUUcMfkFKFr
+ - id: 2VSPY72FmGVsY9XfiPNVgv
sortOrder: 13
fieldKey: device_id
label: Device ID
@@ -57346,7 +57402,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 3CtebQUUg3jmGfLSEDggS3
+ - id: hQdk1ygJ4jx1e8ZCjpCADz
sortOrder: 14
fieldKey: device_type
label: Device Type
@@ -57360,7 +57416,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: ghQHKq9eYdP46Qw64XQZCa
+ - id: mbeXjqWF9xBtDdVywkM1J9
sortOrder: 15
fieldKey: device_name
label: Device Name
@@ -57374,7 +57430,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: gHz5eFQ1Fyt5pr5FvrGoqb
+ - id: 42rMJLC5za8fzcYoUBDYq8
sortOrder: 16
fieldKey: device_manufacturer
label: Device Manufacturer
@@ -57388,7 +57444,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: uZCXX9Zzaqrz7dD5TtbPpM
+ - id: as15U3xxXCruRnSq9gqhjS
sortOrder: 17
fieldKey: device_model
label: Device Model
@@ -57402,7 +57458,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 8ZFwTrG2hibFMjvXtKs96j
+ - id: 3qdx1FtvYQoKVd2GufEQLz
sortOrder: 18
fieldKey: bluetooth
label: Bluetooth Enabled
@@ -57416,7 +57472,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: axzxtpFzKUMqRznMfspLhp
+ - id: k8avj2JcLQ6jxujiyaqhe
sortOrder: 19
fieldKey: carrier
label: Carrier
@@ -57430,7 +57486,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: mP14eooypcmw8U3JJSN3Tv
+ - id: tjrCsyb6brWc3CnqkTgWn2
sortOrder: 20
fieldKey: cellular
label: Cellular Enabled
@@ -57444,7 +57500,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 9kVDevtVPV1XKqxh7WDcCT
+ - id: 9hH2vMR6xq2fGsHoKX9T7s
sortOrder: 21
fieldKey: wifi
label: Wifi
@@ -57460,7 +57516,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: qjY19HZ5tPDWXYZkNptLp3
+ - id: 4K1txzqgiN3afXy7NDrTSX
sortOrder: 22
fieldKey: country
label: Country
@@ -57474,7 +57530,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: ajUHqYRH5oP63NrEZaYdf3
+ - id: jERb2e8m7Phi9Jzp6aUBdp
sortOrder: 23
fieldKey: region
label: Region
@@ -57488,7 +57544,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 6xTVFVsTKxtu9XsZLV1rTi
+ - id: oQrR6DjAJ5FWXkVaQ5s5hs
sortOrder: 24
fieldKey: language
label: Language
@@ -57502,7 +57558,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: cksom5cEFGDEr373cFD7oo
+ - id: nRK3yhLsj8PnHyUV7jLuBq
sortOrder: 25
fieldKey: library_name
label: Library Name
@@ -57516,7 +57572,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: abSTAkjCr8FNLNAp1tmnFq
+ - id: pFg6HrKeFHQEFVjK3D3cS8
sortOrder: 26
fieldKey: library_version
label: Library Version
@@ -57530,7 +57586,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: sw4E4UgQa5BqQLyGvBLHGw
+ - id: pbxT4fUnrURniY3HoK8auu
sortOrder: 27
fieldKey: ip
label: IP Address
@@ -57546,7 +57602,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: a5gBKQBAUKjTQe5TuX3cEM
+ - id: rWd79ir8KPm6AddXhKV1JD
sortOrder: 28
fieldKey: idfa
label: Identifier For Advertiser (IDFA)
@@ -57566,7 +57622,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: goRDxTvac2zDaHeic279Gc
+ - id: dDzSNDk23PfbPtQozUaGUi
sortOrder: 29
fieldKey: url
label: URL
@@ -57580,7 +57636,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 4VLV8zjRf5jaNFjgn6yinF
+ - id: uAeWRaCt8zRTpmyjqjLihJ
sortOrder: 30
fieldKey: screen_width
label: Screen width
@@ -57594,7 +57650,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: vvPoTXHR9RLRLr3q1zEeSH
+ - id: sU7KxTrda2FybBw6brT354
sortOrder: 31
fieldKey: screen_height
label: Screen height
@@ -57608,7 +57664,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: vKFMR5gV3kRkueJ1v1UeK8
+ - id: bMXjGoStyTDDuZhvRWbHZg
sortOrder: 32
fieldKey: screen_density
label: Screen density
@@ -57622,7 +57678,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: bpjTu2JuyGdPte3ZM7P889
+ - id: drNa8qSfTtsdCC3rV4yogs
sortOrder: 33
fieldKey: referrer
label: Referrer
@@ -57636,7 +57692,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: a99VHyuptiFV4miEvf6Ybo
+ - id: 6pXJKkkvv6QA5AMVpW6X6C
sortOrder: 34
fieldKey: userAgent
label: User Agent
@@ -57650,7 +57706,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 9Z82WpqBZhNZN3x4E7LDzQ
+ - id: uUrbja32hWKXTDBMWrnxfX
sortOrder: 35
fieldKey: advertising_id
label: Advertising ID
@@ -57664,7 +57720,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: nRFbccjhh322ggFzYCVZn1
+ - id: t5qgck4CTxk3bmM3pjR5iH
sortOrder: 36
fieldKey: ad_tracking_enabled
label: Ad Tracking Enabled
@@ -57678,7 +57734,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: sdzSHRxR4QUSTaDSqNcmtF
+ - id: dNEjf9Um4KLtvmieYVuX55
sortOrder: 37
fieldKey: timezone
label: Timezone
@@ -57692,7 +57748,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: upRTrBHyDZh3znJmJiHR3L
+ - id: 7ieqekDVp53Gu5yxXuYiCn
sortOrder: 38
fieldKey: app_platform
label: App Platform
@@ -57706,7 +57762,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: hVNfHmw5JA2ECYBKV2xdSA
+ - id: n1FrArBYCmGMNAmqgy9ezd
sortOrder: 39
fieldKey: name
label: Event Original Name
@@ -57726,7 +57782,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 3S5MGrWp9ngJF96hGNvPcb
+ - id: xyDVL4kDoiEHYoQPwsjYiX
sortOrder: 40
fieldKey: event_properties
label: Event Properties
@@ -57742,7 +57798,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: yH548ntoYzX9Hde5v9fA8
+ - id: w7Tn9g3nyDQuhrW2BvCHQG
sortOrder: 41
fieldKey: context
label: Event context
@@ -57758,7 +57814,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: brvaZ3GJkLddNc2VXG3goM
+ - id: cHvLCBACz1AE7MY8Z4BKqH
sortOrder: 42
fieldKey: utm_properties
label: UTM Properties
@@ -57781,7 +57837,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: qRiFCTJqby9jRhGTqWMaAP
+ - id: rjDjecswD9KZ4CvHRTj7v
sortOrder: 43
fieldKey: enable_batching
label: Batch Data to Mixpanel
@@ -57794,7 +57850,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 5gFU9P9qAFUzF9HaSUwBpB
+ - id: vBhDe7LW9yx9MVQVn3naF
sortOrder: 44
fieldKey: userAgentData
label: User Agent Data
@@ -57823,70 +57879,20 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 9BDqBzJJC3HULwu2dSSzeg
- sortOrder: 45
- fieldKey: products
- label: Products
- type: OBJECT
- description: Products in the order.
- placeholder: ''
- defaultValue:
- '@arrayPath':
- - $.properties.products
- - product_id:
- '@path': product_id
- sku:
- '@path': sku
- category:
- '@path': category
- name:
- '@path': name
- brand:
- '@path': brand
- variant:
- '@path': variant
- price:
- '@path': price
- quantity:
- '@path': quantity
- coupon:
- '@path': coupon
- position:
- '@path': position
- url:
- '@path': url
- image_url:
- '@path': image_url
- required: false
- multiple: true
- choices: null
- dynamic: false
- allowNull: false
- - id: 8H9YTsSCQVbJqhhUxhDwwN
- sortOrder: 46
- fieldKey: event
- label: Event Name
- type: STRING
- description: The name of the action being performed.
- placeholder: ''
- defaultValue:
- '@path': $.event
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: dHXRdCjZdnX8RRThn5FgY8
- name: Increment Properties
- slug: incrementProperties
+ - id: iLgPGgELNm5SgSVaqztJeJ
+ name: Identify User
+ slug: identifyUser
description: >-
- Increment the value of a user profile property. [Learn
- More](https://developer.mixpanel.com/reference/profile-numerical-add).
+ Set the user ID for a particular device ID or update user properties.
+ Learn more about [User
+ Profiles](https://help.mixpanel.com/hc/en-us/articles/115004501966?source=segment-actions)
+ and [Identity
+ Management](https://help.mixpanel.com/hc/en-us/articles/360041039771-Getting-Started-with-Identity-Management?source=segment-actions).
platform: CLOUD
hidden: false
- defaultTrigger: type = "track"
+ defaultTrigger: type = "identify"
fields:
- - id: ufRCgRuLgYe5MU43MsZYTM
+ - id: 8azrERfxM9tXYxR1MYBt95
sortOrder: 0
fieldKey: ip
label: IP Address
@@ -57902,7 +57908,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 2aSDwJWsHCmGpRUqGdqJKP
+ - id: 5kFd6aabYx2Fnyevxd9S57
sortOrder: 1
fieldKey: user_id
label: User ID
@@ -57916,7 +57922,7 @@ items:
choices: null
dynamic: false
allowNull: true
- - id: 75HrFTjBdi4X3GS5R5GG1C
+ - id: kby6Qqav1oxhBDvQr1uUeo
sortOrder: 2
fieldKey: anonymous_id
label: Anonymous ID
@@ -57930,69 +57936,12 @@ items:
choices: null
dynamic: false
allowNull: true
- - id: jXkaTPvAHDTUm7WYT4EfEu
+ - id: xgAMiVPKUuf3fZe32Q9uiX
sortOrder: 3
- fieldKey: increment
- label: Increment Numerical Properties
- type: OBJECT
- description: >-
- Object of properties and the values to increment or decrement. For
- example: `{"purchases": 1, "items": 6}}.
- placeholder: ''
- defaultValue:
- '@path': $.properties.increment
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: drUNmF6UifiVmB9NStLWS1
- name: Group Identify User
- slug: groupIdentifyUser
- description: >-
- Updates or adds properties to a group profile. The profile is created if
- it does not exist. [Learn more about Group
- Analytics.](https://help.mixpanel.com/hc/en-us/articles/360025333632-Group-Analytics?source=segment-actions)
- platform: CLOUD
- hidden: false
- defaultTrigger: type = "group"
- fields:
- - id: tj9z6XZQvaHKFizwpyCRxA
- sortOrder: 0
- fieldKey: group_key
- label: Group Key
- type: STRING
- description: >-
- The group key you specified in Mixpanel under Project settings. If this
- is not specified, it will be defaulted to "$group_id".
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 3kLGD1VEPhTUtm29fZN8nw
- sortOrder: 1
- fieldKey: group_id
- label: Group ID
- type: STRING
- description: >-
- The unique identifier of the group. If there is a trait that matches the
- group key, it will override this value.
- placeholder: ''
- defaultValue:
- '@path': $.groupId
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: iPwBs6LYvyjDm6LjX2p3eQ
- sortOrder: 2
fieldKey: traits
- label: Group Properties
+ label: User Properties
type: OBJECT
- description: The properties to set on the group profile.
+ description: Properties to set on the user profile
placeholder: ''
defaultValue:
'@path': $.traits
@@ -58001,31 +57950,30 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: etDoZEKaPvjgeXw6c84cvi
- name: Track Event
- slug: trackEvent
- description: >-
- Send an event to Mixpanel. [Learn more about Events in
- Mixpanel](https://help.mixpanel.com/hc/en-us/articles/360041995352-Mixpanel-Concepts-Events?source=segment-actions)
+ - id: a6YW8RCSKobYuCSEaiYKqY
+ name: Track Purchase
+ slug: trackPurchase
+ description: Send an 'Order Completed' Event to Mixpanel.
platform: CLOUD
hidden: false
defaultTrigger: type = "track"
fields:
- - id: gRm5z9ZvTKUwxB4pMtK6TY
+ - id: 53Rwd9XQHEhNzyFDhGRtdG
sortOrder: 0
- fieldKey: event
- label: Event Name
- type: STRING
- description: The name of the action being performed.
+ fieldKey: generatePurchaseEventPerProduct
+ label: Generate Purchase Event Per Product
+ type: BOOLEAN
+ description: >-
+ When enabled, send "Product Purchased" with each product within the
+ event.
placeholder: ''
- defaultValue:
- '@path': $.event
- required: true
+ defaultValue: true
+ required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: w7yoHPf9Mpu1Msc4xG89TG
+ - id: chMGMRzqvcDvE2e9nPzy4W
sortOrder: 1
fieldKey: distinct_id
label: Distinct ID
@@ -58045,7 +57993,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 3FoRu9QTdxVx1kabK5QyTA
+ - id: dQBRAAqhTpat7RQu8QXrhd
sortOrder: 2
fieldKey: anonymous_id
label: Anonymous ID
@@ -58059,7 +58007,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 21q7dmwjeEzPcDpwZJ6qSf
+ - id: 7LsYRuywfnKDqskBXcYN1V
sortOrder: 3
fieldKey: user_id
label: User ID
@@ -58073,7 +58021,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: jceKitrbM7rCz29MwARbBH
+ - id: sMSySVYa4QygdiWUgdM9DW
sortOrder: 4
fieldKey: group_id
label: Group ID
@@ -58087,7 +58035,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: gdeQeunC2inXXAXFwnib6F
+ - id: oVHvXebJS5GTpsagvuudqR
sortOrder: 5
fieldKey: insert_id
label: Insert ID
@@ -58103,7 +58051,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: p7jX6BfpkT2fWbeoQBLDYQ
+ - id: wxvsJq3ZtTTVk6Q41oovuo
sortOrder: 6
fieldKey: time
label: Timestamp
@@ -58121,7 +58069,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: fiDfQptfuxKTBeCb5Qx9xq
+ - id: 7LAcVBYQe4wkTi4Fz24M52
sortOrder: 7
fieldKey: app_name
label: App Name
@@ -58135,7 +58083,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: qcLC9ueVGQF2evmx2qKKjr
+ - id: 6Vpp1xGHjjPYWWvetqitS1
sortOrder: 8
fieldKey: app_namespace
label: App Namespace
@@ -58149,7 +58097,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: dd9AzFCcN5MmmLP9zoSbct
+ - id: dngqfFeiNhu8unfAUVeudY
sortOrder: 9
fieldKey: app_build
label: App Build
@@ -58163,7 +58111,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 2WdLdiMkv4PG34JCk7JT92
+ - id: 8qEqiAeJmyRcmjUJHNpUyJ
sortOrder: 10
fieldKey: app_version
label: App Version
@@ -58177,7 +58125,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: sQxToyBdzwW6vPyvzKGq3P
+ - id: 8xge5r37konvUpfCHhs61b
sortOrder: 11
fieldKey: os_name
label: OS Name
@@ -58193,7 +58141,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: rbKZqLMyoT3Fko3t4JT7dD
+ - id: tQL3s88RJF2gHGjAKDcBs7
sortOrder: 12
fieldKey: os_version
label: OS Version
@@ -58207,7 +58155,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 2VSPY72FmGVsY9XfiPNVgv
+ - id: cNvBZDuHDoMRUUcMfkFKFr
sortOrder: 13
fieldKey: device_id
label: Device ID
@@ -58221,7 +58169,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: hQdk1ygJ4jx1e8ZCjpCADz
+ - id: 3CtebQUUg3jmGfLSEDggS3
sortOrder: 14
fieldKey: device_type
label: Device Type
@@ -58235,7 +58183,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: mbeXjqWF9xBtDdVywkM1J9
+ - id: ghQHKq9eYdP46Qw64XQZCa
sortOrder: 15
fieldKey: device_name
label: Device Name
@@ -58249,7 +58197,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 42rMJLC5za8fzcYoUBDYq8
+ - id: gHz5eFQ1Fyt5pr5FvrGoqb
sortOrder: 16
fieldKey: device_manufacturer
label: Device Manufacturer
@@ -58263,7 +58211,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: as15U3xxXCruRnSq9gqhjS
+ - id: uZCXX9Zzaqrz7dD5TtbPpM
sortOrder: 17
fieldKey: device_model
label: Device Model
@@ -58277,7 +58225,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 3qdx1FtvYQoKVd2GufEQLz
+ - id: 8ZFwTrG2hibFMjvXtKs96j
sortOrder: 18
fieldKey: bluetooth
label: Bluetooth Enabled
@@ -58291,7 +58239,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: k8avj2JcLQ6jxujiyaqhe
+ - id: axzxtpFzKUMqRznMfspLhp
sortOrder: 19
fieldKey: carrier
label: Carrier
@@ -58305,7 +58253,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: tjrCsyb6brWc3CnqkTgWn2
+ - id: mP14eooypcmw8U3JJSN3Tv
sortOrder: 20
fieldKey: cellular
label: Cellular Enabled
@@ -58319,7 +58267,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 9hH2vMR6xq2fGsHoKX9T7s
+ - id: 9kVDevtVPV1XKqxh7WDcCT
sortOrder: 21
fieldKey: wifi
label: Wifi
@@ -58335,7 +58283,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 4K1txzqgiN3afXy7NDrTSX
+ - id: qjY19HZ5tPDWXYZkNptLp3
sortOrder: 22
fieldKey: country
label: Country
@@ -58349,7 +58297,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: jERb2e8m7Phi9Jzp6aUBdp
+ - id: ajUHqYRH5oP63NrEZaYdf3
sortOrder: 23
fieldKey: region
label: Region
@@ -58363,7 +58311,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: oQrR6DjAJ5FWXkVaQ5s5hs
+ - id: 6xTVFVsTKxtu9XsZLV1rTi
sortOrder: 24
fieldKey: language
label: Language
@@ -58377,7 +58325,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: nRK3yhLsj8PnHyUV7jLuBq
+ - id: cksom5cEFGDEr373cFD7oo
sortOrder: 25
fieldKey: library_name
label: Library Name
@@ -58391,7 +58339,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: pFg6HrKeFHQEFVjK3D3cS8
+ - id: abSTAkjCr8FNLNAp1tmnFq
sortOrder: 26
fieldKey: library_version
label: Library Version
@@ -58405,7 +58353,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: pbxT4fUnrURniY3HoK8auu
+ - id: sw4E4UgQa5BqQLyGvBLHGw
sortOrder: 27
fieldKey: ip
label: IP Address
@@ -58421,7 +58369,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: rWd79ir8KPm6AddXhKV1JD
+ - id: a5gBKQBAUKjTQe5TuX3cEM
sortOrder: 28
fieldKey: idfa
label: Identifier For Advertiser (IDFA)
@@ -58441,7 +58389,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: dDzSNDk23PfbPtQozUaGUi
+ - id: goRDxTvac2zDaHeic279Gc
sortOrder: 29
fieldKey: url
label: URL
@@ -58455,7 +58403,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: uAeWRaCt8zRTpmyjqjLihJ
+ - id: 4VLV8zjRf5jaNFjgn6yinF
sortOrder: 30
fieldKey: screen_width
label: Screen width
@@ -58469,7 +58417,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: sU7KxTrda2FybBw6brT354
+ - id: vvPoTXHR9RLRLr3q1zEeSH
sortOrder: 31
fieldKey: screen_height
label: Screen height
@@ -58483,7 +58431,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: bMXjGoStyTDDuZhvRWbHZg
+ - id: vKFMR5gV3kRkueJ1v1UeK8
sortOrder: 32
fieldKey: screen_density
label: Screen density
@@ -58497,7 +58445,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: drNa8qSfTtsdCC3rV4yogs
+ - id: bpjTu2JuyGdPte3ZM7P889
sortOrder: 33
fieldKey: referrer
label: Referrer
@@ -58511,7 +58459,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 6pXJKkkvv6QA5AMVpW6X6C
+ - id: a99VHyuptiFV4miEvf6Ybo
sortOrder: 34
fieldKey: userAgent
label: User Agent
@@ -58525,7 +58473,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: uUrbja32hWKXTDBMWrnxfX
+ - id: 9Z82WpqBZhNZN3x4E7LDzQ
sortOrder: 35
fieldKey: advertising_id
label: Advertising ID
@@ -58539,7 +58487,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: t5qgck4CTxk3bmM3pjR5iH
+ - id: nRFbccjhh322ggFzYCVZn1
sortOrder: 36
fieldKey: ad_tracking_enabled
label: Ad Tracking Enabled
@@ -58553,7 +58501,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: dNEjf9Um4KLtvmieYVuX55
+ - id: sdzSHRxR4QUSTaDSqNcmtF
sortOrder: 37
fieldKey: timezone
label: Timezone
@@ -58567,7 +58515,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 7ieqekDVp53Gu5yxXuYiCn
+ - id: upRTrBHyDZh3znJmJiHR3L
sortOrder: 38
fieldKey: app_platform
label: App Platform
@@ -58581,7 +58529,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: n1FrArBYCmGMNAmqgy9ezd
+ - id: hVNfHmw5JA2ECYBKV2xdSA
sortOrder: 39
fieldKey: name
label: Event Original Name
@@ -58601,7 +58549,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: xyDVL4kDoiEHYoQPwsjYiX
+ - id: 3S5MGrWp9ngJF96hGNvPcb
sortOrder: 40
fieldKey: event_properties
label: Event Properties
@@ -58617,7 +58565,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: w7Tn9g3nyDQuhrW2BvCHQG
+ - id: yH548ntoYzX9Hde5v9fA8
sortOrder: 41
fieldKey: context
label: Event context
@@ -58633,7 +58581,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: cHvLCBACz1AE7MY8Z4BKqH
+ - id: brvaZ3GJkLddNc2VXG3goM
sortOrder: 42
fieldKey: utm_properties
label: UTM Properties
@@ -58656,7 +58604,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: rjDjecswD9KZ4CvHRTj7v
+ - id: qRiFCTJqby9jRhGTqWMaAP
sortOrder: 43
fieldKey: enable_batching
label: Batch Data to Mixpanel
@@ -58669,7 +58617,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: vBhDe7LW9yx9MVQVn3naF
+ - id: 5gFU9P9qAFUzF9HaSUwBpB
sortOrder: 44
fieldKey: userAgentData
label: User Agent Data
@@ -58698,20 +58646,70 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: iLgPGgELNm5SgSVaqztJeJ
- name: Identify User
- slug: identifyUser
+ - id: 9BDqBzJJC3HULwu2dSSzeg
+ sortOrder: 45
+ fieldKey: products
+ label: Products
+ type: OBJECT
+ description: Products in the order.
+ placeholder: ''
+ defaultValue:
+ '@arrayPath':
+ - $.properties.products
+ - product_id:
+ '@path': product_id
+ sku:
+ '@path': sku
+ category:
+ '@path': category
+ name:
+ '@path': name
+ brand:
+ '@path': brand
+ variant:
+ '@path': variant
+ price:
+ '@path': price
+ quantity:
+ '@path': quantity
+ coupon:
+ '@path': coupon
+ position:
+ '@path': position
+ url:
+ '@path': url
+ image_url:
+ '@path': image_url
+ required: false
+ multiple: true
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 8H9YTsSCQVbJqhhUxhDwwN
+ sortOrder: 46
+ fieldKey: event
+ label: Event Name
+ type: STRING
+ description: The name of the action being performed.
+ placeholder: ''
+ defaultValue:
+ '@path': $.event
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: dHXRdCjZdnX8RRThn5FgY8
+ name: Increment Properties
+ slug: incrementProperties
description: >-
- Set the user ID for a particular device ID or update user properties.
- Learn more about [User
- Profiles](https://help.mixpanel.com/hc/en-us/articles/115004501966?source=segment-actions)
- and [Identity
- Management](https://help.mixpanel.com/hc/en-us/articles/360041039771-Getting-Started-with-Identity-Management?source=segment-actions).
+ Increment the value of a user profile property. [Learn
+ More](https://developer.mixpanel.com/reference/profile-numerical-add).
platform: CLOUD
hidden: false
- defaultTrigger: type = "identify"
+ defaultTrigger: type = "track"
fields:
- - id: 8azrERfxM9tXYxR1MYBt95
+ - id: ufRCgRuLgYe5MU43MsZYTM
sortOrder: 0
fieldKey: ip
label: IP Address
@@ -58727,7 +58725,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 5kFd6aabYx2Fnyevxd9S57
+ - id: 2aSDwJWsHCmGpRUqGdqJKP
sortOrder: 1
fieldKey: user_id
label: User ID
@@ -58741,7 +58739,7 @@ items:
choices: null
dynamic: false
allowNull: true
- - id: kby6Qqav1oxhBDvQr1uUeo
+ - id: 75HrFTjBdi4X3GS5R5GG1C
sortOrder: 2
fieldKey: anonymous_id
label: Anonymous ID
@@ -58755,16 +58753,18 @@ items:
choices: null
dynamic: false
allowNull: true
- - id: xgAMiVPKUuf3fZe32Q9uiX
+ - id: jXkaTPvAHDTUm7WYT4EfEu
sortOrder: 3
- fieldKey: traits
- label: User Properties
+ fieldKey: increment
+ label: Increment Numerical Properties
type: OBJECT
- description: Properties to set on the user profile
+ description: >-
+ Object of properties and the values to increment or decrement. For
+ example: `{"purchases": 1, "items": 6}}.
placeholder: ''
defaultValue:
- '@path': $.traits
- required: false
+ '@path': $.properties.increment
+ required: true
multiple: false
choices: null
dynamic: false
@@ -66494,6 +66494,54 @@ items:
choices: null
dynamic: false
allowNull: false
+ - id: u3JwUn6SECofbhY2y7FThX
+ name: Start a workflow in Qualtrics
+ slug: triggerXflowWorkflow
+ description: This action is used to kick off a workflow in Qualtrics
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: null
+ fields:
+ - id: cZiKKbBtAJeomTE3Q1auXm
+ sortOrder: 0
+ fieldKey: workflowUrl
+ label: Workflow URL
+ type: STRING
+ description: >-
+ Enter the full URL as you see in your Xflow trigger. [See more details
+ on setting up an xflow trigger and getting the
+ URL.](https://static-assets.qualtrics.com/static/integrations-external/twilio_segment_event_webhook_setup_instructions.pdf)
+ placeholder: ''
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: JTSAvq3qiwFP1zM73xsns
+ sortOrder: 1
+ fieldKey: eventPayload
+ label: Event payload
+ type: OBJECT
+ description: A mapping of key values to send to Qualtrics xflow.
+ placeholder: ''
+ defaultValue:
+ event:
+ '@path': $.event
+ type:
+ '@path': $.type
+ userId:
+ '@path': $.userId
+ properties:
+ '@path': $.properties
+ traits:
+ '@path': $.traits
+ context:
+ '@path': $.context
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
- id: t4PdQkXWdNV7haYmMMAN9P
name: Upsert contact transaction
slug: upsertContactTransaction
@@ -66726,54 +66774,6 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: u3JwUn6SECofbhY2y7FThX
- name: Start a workflow in Qualtrics
- slug: triggerXflowWorkflow
- description: This action is used to kick off a workflow in Qualtrics
- platform: CLOUD
- hidden: false
- defaultTrigger: null
- fields:
- - id: cZiKKbBtAJeomTE3Q1auXm
- sortOrder: 0
- fieldKey: workflowUrl
- label: Workflow URL
- type: STRING
- description: >-
- Enter the full URL as you see in your Xflow trigger. [See more details
- on setting up an xflow trigger and getting the
- URL.](https://static-assets.qualtrics.com/static/integrations-external/twilio_segment_event_webhook_setup_instructions.pdf)
- placeholder: ''
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: JTSAvq3qiwFP1zM73xsns
- sortOrder: 1
- fieldKey: eventPayload
- label: Event payload
- type: OBJECT
- description: A mapping of key values to send to Qualtrics xflow.
- placeholder: ''
- defaultValue:
- event:
- '@path': $.event
- type:
- '@path': $.type
- userId:
- '@path': $.userId
- properties:
- '@path': $.properties
- traits:
- '@path': $.traits
- context:
- '@path': $.context
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
presets: []
- id: 54521fda25e721e32a72eeeb
display_name: Quantcast
@@ -70557,17 +70557,15 @@ items:
required: true
label: Sandbox Instance
actions:
- - id: 52yB9Xs7pWZ3VcsSqjpFFv
- name: Custom Object
- slug: customObject
- description: >-
- Create, update, or upsert records in any custom or standard object in
- Salesforce.
+ - id: goFLcVAjNaQf1qMUuStjk4
+ name: Lead
+ slug: lead
+ description: Create, update, or upsert leads in Salesforce.
platform: CLOUD
hidden: false
- defaultTrigger: null
+ defaultTrigger: type = "identify"
fields:
- - id: qKxd7YKK6Sa4FMJhpvYFGB
+ - id: q6VTEGJP4aZqFLhu3jkEyZ
sortOrder: 0
fieldKey: operation
label: Operation
@@ -70589,7 +70587,7 @@ items:
value: delete
dynamic: false
allowNull: false
- - id: pSowNopPE17sVfB6dtYbQm
+ - id: 8ypgCkzfUXTK9RXsT3CFD8
sortOrder: 1
fieldKey: recordMatcherOperator
label: Record Matchers Operator
@@ -70610,7 +70608,7 @@ items:
value: AND
dynamic: false
allowNull: false
- - id: rWx5wxYKqh3MYQBAefJqNC
+ - id: 4LS6mu68Dbaaqr48bAB5Du
sortOrder: 2
fieldKey: enable_batching
label: Use Salesforce Bulk API
@@ -70628,7 +70626,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: kxm46dhKS13aXigVhMb2XX
+ - id: prMgWYeXDfGX9hBX4PEN5Y
sortOrder: 3
fieldKey: batch_size
label: Batch Size
@@ -70643,7 +70641,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: qve6oLEgi3weZwairZcZxt
+ - id: pFVi5Uj9bzStvKuf4XZNJS
sortOrder: 4
fieldKey: traits
label: Record Matchers
@@ -70665,7 +70663,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 2SjhyWkv1dKkfXjgL3RKnD
+ - id: 6DzV3uP356jQUnAGn1Yr5X
sortOrder: 5
fieldKey: bulkUpsertExternalId
label: Bulk Upsert External Id
@@ -70677,7 +70675,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: nZgHxJ6E9M9KL6HQBDpsLm
+ - id: fLHCGjPkHYycYq3XaCHufC
sortOrder: 6
fieldKey: bulkUpdateRecordId
label: Bulk Update Record Id
@@ -70689,23 +70687,188 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: rEjo1JLRREPAMEa1tL2KLq
+ - id: Mrms8G7t6rTrwh6NP2wVh
sortOrder: 7
- fieldKey: customObjectName
- label: Salesforce Object
+ fieldKey: company
+ label: Company
type: STRING
- description: >-
- The API name of the Salesforce object that records will be added or
- updated within. This can be a standard or custom object. Custom objects
- must be predefined in your Salesforce account and should end with "__c".
+ description: The lead's company. **This is required to create a lead.**
placeholder: ''
- required: true
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.traits.company
+ then:
+ '@path': $.traits.company
+ else:
+ '@path': $.properties.company
+ required: false
multiple: false
choices: null
- dynamic: true
+ dynamic: false
allowNull: false
- - id: 4FHi3SZ9L6fpsiWJZNuwMi
+ - id: vVb6g2zth7YxVRgVBrDcMn
sortOrder: 8
+ fieldKey: last_name
+ label: Last Name
+ type: STRING
+ description: The lead's last name. **This is required to create a lead.**
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.traits.last_name
+ then:
+ '@path': $.traits.last_name
+ else:
+ '@path': $.properties.last_name
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: cuTjx8ikdREQRMoussEBhH
+ sortOrder: 9
+ fieldKey: first_name
+ label: First Name
+ type: STRING
+ description: The lead's first name.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.traits.first_name
+ then:
+ '@path': $.traits.first_name
+ else:
+ '@path': $.properties.first_name
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: bH1v8EnHbFNPzGUcE3PGBu
+ sortOrder: 10
+ fieldKey: email
+ label: Email
+ type: STRING
+ description: The lead's email address.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.traits.email
+ then:
+ '@path': $.traits.email
+ else:
+ '@path': $.properties.email
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: gGHazgTW1AYcnEHpsqp3sW
+ sortOrder: 11
+ fieldKey: city
+ label: City
+ type: STRING
+ description: City for the lead's address.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.traits.address.city
+ then:
+ '@path': $.traits.address.city
+ else:
+ '@path': $.properties.address.city
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 5Rkyk7jYXiK2kXnw7iitVc
+ sortOrder: 12
+ fieldKey: postal_code
+ label: Postal Code
+ type: STRING
+ description: Postal code for the lead's address.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.traits.address.postal_code
+ then:
+ '@path': $.traits.address.postal_code
+ else:
+ '@path': $.properties.address.postal_code
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: xtfuWEXR9WJx34CYD2gsTV
+ sortOrder: 13
+ fieldKey: country
+ label: Country
+ type: STRING
+ description: Country for the lead's address.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.traits.address.country
+ then:
+ '@path': $.traits.address.country
+ else:
+ '@path': $.properties.address.country
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: vgZmxXMvRbGoPj4HWZgZhM
+ sortOrder: 14
+ fieldKey: street
+ label: Street
+ type: STRING
+ description: Street number and name for the lead's address.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.traits.address.street
+ then:
+ '@path': $.traits.address.street
+ else:
+ '@path': $.properties.address.street
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: fHniZ9uEL7n6kayDM84tyY
+ sortOrder: 15
+ fieldKey: state
+ label: State
+ type: STRING
+ description: State for the lead's address.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.traits.address.state
+ then:
+ '@path': $.traits.address.state
+ else:
+ '@path': $.properties.address.state
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: eTaMWpZH9vq8mis7k7fNXD
+ sortOrder: 16
fieldKey: customFields
label: Other Fields
type: OBJECT
@@ -70724,15 +70887,17 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 5DAMQ5qUaF2rZoyVNiReCa
- name: Contact
- slug: contact
- description: Create, update, or upsert contacts in Salesforce.
+ - id: 52yB9Xs7pWZ3VcsSqjpFFv
+ name: Custom Object
+ slug: customObject
+ description: >-
+ Create, update, or upsert records in any custom or standard object in
+ Salesforce.
platform: CLOUD
hidden: false
defaultTrigger: null
fields:
- - id: fnkWNpRtt7qSGi6dh9dENm
+ - id: qKxd7YKK6Sa4FMJhpvYFGB
sortOrder: 0
fieldKey: operation
label: Operation
@@ -70754,7 +70919,7 @@ items:
value: delete
dynamic: false
allowNull: false
- - id: tnQVDsF2vqFhR8FQ7cxDLf
+ - id: pSowNopPE17sVfB6dtYbQm
sortOrder: 1
fieldKey: recordMatcherOperator
label: Record Matchers Operator
@@ -70775,7 +70940,7 @@ items:
value: AND
dynamic: false
allowNull: false
- - id: 795x8vq2fCHsVVe31RhXSu
+ - id: rWx5wxYKqh3MYQBAefJqNC
sortOrder: 2
fieldKey: enable_batching
label: Use Salesforce Bulk API
@@ -70793,7 +70958,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: eZsAKmV2Mrm5htFhc7tygb
+ - id: kxm46dhKS13aXigVhMb2XX
sortOrder: 3
fieldKey: batch_size
label: Batch Size
@@ -70808,7 +70973,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 62pqrZrxcExPjUuEra6LZe
+ - id: qve6oLEgi3weZwairZcZxt
sortOrder: 4
fieldKey: traits
label: Record Matchers
@@ -70830,7 +70995,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: vdYNKRWSdZmGJFKZ52Guqg
+ - id: 2SjhyWkv1dKkfXjgL3RKnD
sortOrder: 5
fieldKey: bulkUpsertExternalId
label: Bulk Upsert External Id
@@ -70842,7 +71007,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 8m4X4A2KvwjtwLstEzyCZS
+ - id: nZgHxJ6E9M9KL6HQBDpsLm
sortOrder: 6
fieldKey: bulkUpdateRecordId
label: Bulk Update Record Id
@@ -70854,185 +71019,185 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: sxDT1kry5bzoscj31JGX5M
+ - id: rEjo1JLRREPAMEa1tL2KLq
sortOrder: 7
- fieldKey: last_name
- label: Last Name
+ fieldKey: customObjectName
+ label: Salesforce Object
type: STRING
description: >-
- The contact's last name up to 80 characters. **This is required to
- create a contact.**
+ The API name of the Salesforce object that records will be added or
+ updated within. This can be a standard or custom object. Custom objects
+ must be predefined in your Salesforce account and should end with "__c".
placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.last_name
- then:
- '@path': $.traits.last_name
- else:
- '@path': $.properties.last_name
- required: false
+ required: true
multiple: false
choices: null
- dynamic: false
+ dynamic: true
allowNull: false
- - id: wMxRGX9qvoTqKfyR1C7wd2
+ - id: 4FHi3SZ9L6fpsiWJZNuwMi
sortOrder: 8
- fieldKey: first_name
- label: First Name
- type: STRING
- description: The contact's first name up to 40 characters.
+ fieldKey: customFields
+ label: Other Fields
+ type: OBJECT
+ description: |2-
+
+ Additional fields to send to Salesforce. On the left-hand side, input the Salesforce field API name. On the right-hand side, map the Segment field that contains the value.
+
+ This can include standard or custom fields. Custom fields must be predefined in your Salesforce account and the API field name should have __c appended.
+
+ ---
+
+
placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.first_name
- then:
- '@path': $.traits.first_name
- else:
- '@path': $.properties.first_name
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: dP4HERo8Xtf13feDXjd9mY
- sortOrder: 9
- fieldKey: account_id
- label: Account ID
+ - id: ivbhXmVSSycDBKDDrZnCwh
+ name: Case
+ slug: cases
+ description: Create, update, or upsert cases in Salesforce.
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: null
+ fields:
+ - id: mHcVrRg77jvCCf3h68Lnrh
+ sortOrder: 0
+ fieldKey: operation
+ label: Operation
type: STRING
description: >-
- The ID of the account that this contact is associated with. This is the
- Salesforce-generated ID assigned to the account during creation (i.e.
- 0018c00002CDThnAAH).
+ The Salesforce operation performed. The available operations are Create,
+ Delete, Update or Upsert records in Salesforce.
placeholder: ''
- required: false
+ required: true
multiple: false
- choices: null
+ choices:
+ - label: Create new record
+ value: create
+ - label: Update existing record
+ value: update
+ - label: Update or create a record if one doesn't exist
+ value: upsert
+ - label: Delete existing record
+ value: delete
dynamic: false
allowNull: false
- - id: ctRZR26UuMJeRg71iKUKNc
- sortOrder: 10
- fieldKey: email
- label: Email
+ - id: e9aYBnsK2g3Axg6m6G9At3
+ sortOrder: 1
+ fieldKey: recordMatcherOperator
+ label: Record Matchers Operator
type: STRING
- description: The contact's email address.
+ description: >-
+ This field affects how Segment uses the record matchers to query
+ Salesforce records. By default, Segment uses the "OR" operator to query
+ Salesforce for a record. If you would like to query Salesforce records
+ using a combination of multiple record matchers, change this to "AND".
placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.email
- then:
- '@path': $.traits.email
- else:
- '@path': $.properties.email
+ defaultValue: OR
+ required: false
+ multiple: false
+ choices:
+ - label: OR
+ value: OR
+ - label: AND
+ value: AND
+ dynamic: false
+ allowNull: false
+ - id: 6EvuKvkYYf85wDoFBpz6YW
+ sortOrder: 2
+ fieldKey: enable_batching
+ label: Use Salesforce Bulk API
+ type: BOOLEAN
+ description: >-
+ If true, events are sent to [Salesforce’s Bulk API
+ 2.0](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_intro.htm)
+ rather than their streaming REST API. Once enabled, Segment will collect
+ events into batches of 1000 before sending to Salesforce. *Enabling Bulk
+ API is not compatible with the `create` operation*.
+ placeholder: ''
+ defaultValue: false
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: 2wnq4rL487ZjmXryUyLu1w
- sortOrder: 11
- fieldKey: mailing_city
- label: Mailing City
- type: STRING
- description: City for the contact's mailing address.
+ - id: 65hFgkC74Z9UsQRfWDpx
+ sortOrder: 3
+ fieldKey: batch_size
+ label: Batch Size
+ type: NUMBER
+ description: >-
+ Maximum number of events to include in each batch. Actual batch sizes
+ may be lower.
placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.address.city
- then:
- '@path': $.traits.address.city
- else:
- '@path': $.properties.address.city
+ defaultValue: 5000
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: 6DUfAeNcioXPB4p5t6zsUt
- sortOrder: 12
- fieldKey: mailing_postal_code
- label: Mailing Postal Code
- type: STRING
- description: Postal Code for the contact's mailing address.
+ - id: vyaQLQtZezgk8VFQJfZXxU
+ sortOrder: 4
+ fieldKey: traits
+ label: Record Matchers
+ type: OBJECT
+ description: >-
+ The fields used to find Salesforce records for updates. **This is
+ required if the operation is Delete, Update or Upsert.**
+
+ Any field can function as a matcher, including Record ID, External IDs, standard fields and custom fields. On the left-hand side, input the Salesforce field API name. On the right-hand side, map the Segment field that contains the value.
+
+ If multiple records are found, no changes will be made. **Please use fields that result in unique records.**
+
+ ---
+
+
placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.address.postal_code
- then:
- '@path': $.traits.address.postal_code
- else:
- '@path': $.properties.address.postal_code
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: pHDU5Dn7JUrLwgV3poLUNm
- sortOrder: 13
- fieldKey: mailing_country
- label: Mailing Country
- type: STRING
- description: Country for the contact's mailing address.
+ - id: qvy6nh6u7aDEihaZPRq4JM
+ sortOrder: 5
+ fieldKey: bulkUpsertExternalId
+ label: Bulk Upsert External Id
+ type: OBJECT
+ description: The external id field name and mapping to use for bulk upsert.
placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.address.country
- then:
- '@path': $.traits.address.country
- else:
- '@path': $.properties.address.country
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: bA7SdSzKHjyXvgKnVG5JUk
- sortOrder: 14
- fieldKey: mailing_street
- label: Mailing Street
+ - id: q4X5zsFspN4b8NnXUeX6ey
+ sortOrder: 6
+ fieldKey: bulkUpdateRecordId
+ label: Bulk Update Record Id
type: STRING
- description: Street number and name for the contact's mailing address.
+ description: The record id value to use for bulk update.
placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.address.street
- then:
- '@path': $.traits.address.street
- else:
- '@path': $.properties.address.street
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: jhbSAJVckg5Bj4PcuGXMzp
- sortOrder: 15
- fieldKey: mailing_state
- label: Mailing State
+ - id: oHdkAk338vewfD8jVphEpu
+ sortOrder: 7
+ fieldKey: description
+ label: Description
type: STRING
- description: State for the contact's mailing address.
+ description: A text description of the case.
placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.address.state
- then:
- '@path': $.traits.address.state
- else:
- '@path': $.properties.address.state
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: fShUZVeafUxA6x4Dk817aG
- sortOrder: 16
+ - id: hTmJawbJysohGdCV5wseV5
+ sortOrder: 8
fieldKey: customFields
label: Other Fields
type: OBJECT
@@ -71687,345 +71852,15 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: goFLcVAjNaQf1qMUuStjk4
- name: Lead
- slug: lead
- description: Create, update, or upsert leads in Salesforce.
- platform: CLOUD
- hidden: false
- defaultTrigger: type = "identify"
- fields:
- - id: q6VTEGJP4aZqFLhu3jkEyZ
- sortOrder: 0
- fieldKey: operation
- label: Operation
- type: STRING
- description: >-
- The Salesforce operation performed. The available operations are Create,
- Delete, Update or Upsert records in Salesforce.
- placeholder: ''
- required: true
- multiple: false
- choices:
- - label: Create new record
- value: create
- - label: Update existing record
- value: update
- - label: Update or create a record if one doesn't exist
- value: upsert
- - label: Delete existing record
- value: delete
- dynamic: false
- allowNull: false
- - id: 8ypgCkzfUXTK9RXsT3CFD8
- sortOrder: 1
- fieldKey: recordMatcherOperator
- label: Record Matchers Operator
- type: STRING
- description: >-
- This field affects how Segment uses the record matchers to query
- Salesforce records. By default, Segment uses the "OR" operator to query
- Salesforce for a record. If you would like to query Salesforce records
- using a combination of multiple record matchers, change this to "AND".
- placeholder: ''
- defaultValue: OR
- required: false
- multiple: false
- choices:
- - label: OR
- value: OR
- - label: AND
- value: AND
- dynamic: false
- allowNull: false
- - id: 4LS6mu68Dbaaqr48bAB5Du
- sortOrder: 2
- fieldKey: enable_batching
- label: Use Salesforce Bulk API
- type: BOOLEAN
- description: >-
- If true, events are sent to [Salesforce’s Bulk API
- 2.0](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_intro.htm)
- rather than their streaming REST API. Once enabled, Segment will collect
- events into batches of 1000 before sending to Salesforce. *Enabling Bulk
- API is not compatible with the `create` operation*.
- placeholder: ''
- defaultValue: false
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: prMgWYeXDfGX9hBX4PEN5Y
- sortOrder: 3
- fieldKey: batch_size
- label: Batch Size
- type: NUMBER
- description: >-
- Maximum number of events to include in each batch. Actual batch sizes
- may be lower.
- placeholder: ''
- defaultValue: 5000
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: pFVi5Uj9bzStvKuf4XZNJS
- sortOrder: 4
- fieldKey: traits
- label: Record Matchers
- type: OBJECT
- description: >-
- The fields used to find Salesforce records for updates. **This is
- required if the operation is Delete, Update or Upsert.**
-
- Any field can function as a matcher, including Record ID, External IDs, standard fields and custom fields. On the left-hand side, input the Salesforce field API name. On the right-hand side, map the Segment field that contains the value.
-
- If multiple records are found, no changes will be made. **Please use fields that result in unique records.**
-
- ---
-
-
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 6DzV3uP356jQUnAGn1Yr5X
- sortOrder: 5
- fieldKey: bulkUpsertExternalId
- label: Bulk Upsert External Id
- type: OBJECT
- description: The external id field name and mapping to use for bulk upsert.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: fLHCGjPkHYycYq3XaCHufC
- sortOrder: 6
- fieldKey: bulkUpdateRecordId
- label: Bulk Update Record Id
- type: STRING
- description: The record id value to use for bulk update.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: Mrms8G7t6rTrwh6NP2wVh
- sortOrder: 7
- fieldKey: company
- label: Company
- type: STRING
- description: The lead's company. **This is required to create a lead.**
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.company
- then:
- '@path': $.traits.company
- else:
- '@path': $.properties.company
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: vVb6g2zth7YxVRgVBrDcMn
- sortOrder: 8
- fieldKey: last_name
- label: Last Name
- type: STRING
- description: The lead's last name. **This is required to create a lead.**
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.last_name
- then:
- '@path': $.traits.last_name
- else:
- '@path': $.properties.last_name
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: cuTjx8ikdREQRMoussEBhH
- sortOrder: 9
- fieldKey: first_name
- label: First Name
- type: STRING
- description: The lead's first name.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.first_name
- then:
- '@path': $.traits.first_name
- else:
- '@path': $.properties.first_name
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: bH1v8EnHbFNPzGUcE3PGBu
- sortOrder: 10
- fieldKey: email
- label: Email
- type: STRING
- description: The lead's email address.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.email
- then:
- '@path': $.traits.email
- else:
- '@path': $.properties.email
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: gGHazgTW1AYcnEHpsqp3sW
- sortOrder: 11
- fieldKey: city
- label: City
- type: STRING
- description: City for the lead's address.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.address.city
- then:
- '@path': $.traits.address.city
- else:
- '@path': $.properties.address.city
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 5Rkyk7jYXiK2kXnw7iitVc
- sortOrder: 12
- fieldKey: postal_code
- label: Postal Code
- type: STRING
- description: Postal code for the lead's address.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.address.postal_code
- then:
- '@path': $.traits.address.postal_code
- else:
- '@path': $.properties.address.postal_code
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: xtfuWEXR9WJx34CYD2gsTV
- sortOrder: 13
- fieldKey: country
- label: Country
- type: STRING
- description: Country for the lead's address.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.address.country
- then:
- '@path': $.traits.address.country
- else:
- '@path': $.properties.address.country
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: vgZmxXMvRbGoPj4HWZgZhM
- sortOrder: 14
- fieldKey: street
- label: Street
- type: STRING
- description: Street number and name for the lead's address.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.address.street
- then:
- '@path': $.traits.address.street
- else:
- '@path': $.properties.address.street
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: fHniZ9uEL7n6kayDM84tyY
- sortOrder: 15
- fieldKey: state
- label: State
- type: STRING
- description: State for the lead's address.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.traits.address.state
- then:
- '@path': $.traits.address.state
- else:
- '@path': $.properties.address.state
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: eTaMWpZH9vq8mis7k7fNXD
- sortOrder: 16
- fieldKey: customFields
- label: Other Fields
- type: OBJECT
- description: |2-
-
- Additional fields to send to Salesforce. On the left-hand side, input the Salesforce field API name. On the right-hand side, map the Segment field that contains the value.
-
- This can include standard or custom fields. Custom fields must be predefined in your Salesforce account and the API field name should have __c appended.
-
- ---
-
-
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: ivbhXmVSSycDBKDDrZnCwh
- name: Case
- slug: cases
- description: Create, update, or upsert cases in Salesforce.
+ - id: 5DAMQ5qUaF2rZoyVNiReCa
+ name: Contact
+ slug: contact
+ description: Create, update, or upsert contacts in Salesforce.
platform: CLOUD
hidden: false
defaultTrigger: null
fields:
- - id: mHcVrRg77jvCCf3h68Lnrh
+ - id: fnkWNpRtt7qSGi6dh9dENm
sortOrder: 0
fieldKey: operation
label: Operation
@@ -72047,7 +71882,7 @@ items:
value: delete
dynamic: false
allowNull: false
- - id: e9aYBnsK2g3Axg6m6G9At3
+ - id: tnQVDsF2vqFhR8FQ7cxDLf
sortOrder: 1
fieldKey: recordMatcherOperator
label: Record Matchers Operator
@@ -72068,7 +71903,7 @@ items:
value: AND
dynamic: false
allowNull: false
- - id: 6EvuKvkYYf85wDoFBpz6YW
+ - id: 795x8vq2fCHsVVe31RhXSu
sortOrder: 2
fieldKey: enable_batching
label: Use Salesforce Bulk API
@@ -72086,7 +71921,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 65hFgkC74Z9UsQRfWDpx
+ - id: eZsAKmV2Mrm5htFhc7tygb
sortOrder: 3
fieldKey: batch_size
label: Batch Size
@@ -72101,7 +71936,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: vyaQLQtZezgk8VFQJfZXxU
+ - id: 62pqrZrxcExPjUuEra6LZe
sortOrder: 4
fieldKey: traits
label: Record Matchers
@@ -72123,7 +71958,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: qvy6nh6u7aDEihaZPRq4JM
+ - id: vdYNKRWSdZmGJFKZ52Guqg
sortOrder: 5
fieldKey: bulkUpsertExternalId
label: Bulk Upsert External Id
@@ -72135,7 +71970,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: q4X5zsFspN4b8NnXUeX6ey
+ - id: 8m4X4A2KvwjtwLstEzyCZS
sortOrder: 6
fieldKey: bulkUpdateRecordId
label: Bulk Update Record Id
@@ -72147,20 +71982,185 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: oHdkAk338vewfD8jVphEpu
+ - id: sxDT1kry5bzoscj31JGX5M
sortOrder: 7
- fieldKey: description
- label: Description
+ fieldKey: last_name
+ label: Last Name
type: STRING
- description: A text description of the case.
+ description: >-
+ The contact's last name up to 80 characters. **This is required to
+ create a contact.**
placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.traits.last_name
+ then:
+ '@path': $.traits.last_name
+ else:
+ '@path': $.properties.last_name
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: hTmJawbJysohGdCV5wseV5
+ - id: wMxRGX9qvoTqKfyR1C7wd2
sortOrder: 8
+ fieldKey: first_name
+ label: First Name
+ type: STRING
+ description: The contact's first name up to 40 characters.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.traits.first_name
+ then:
+ '@path': $.traits.first_name
+ else:
+ '@path': $.properties.first_name
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: dP4HERo8Xtf13feDXjd9mY
+ sortOrder: 9
+ fieldKey: account_id
+ label: Account ID
+ type: STRING
+ description: >-
+ The ID of the account that this contact is associated with. This is the
+ Salesforce-generated ID assigned to the account during creation (i.e.
+ 0018c00002CDThnAAH).
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: ctRZR26UuMJeRg71iKUKNc
+ sortOrder: 10
+ fieldKey: email
+ label: Email
+ type: STRING
+ description: The contact's email address.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.traits.email
+ then:
+ '@path': $.traits.email
+ else:
+ '@path': $.properties.email
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 2wnq4rL487ZjmXryUyLu1w
+ sortOrder: 11
+ fieldKey: mailing_city
+ label: Mailing City
+ type: STRING
+ description: City for the contact's mailing address.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.traits.address.city
+ then:
+ '@path': $.traits.address.city
+ else:
+ '@path': $.properties.address.city
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 6DUfAeNcioXPB4p5t6zsUt
+ sortOrder: 12
+ fieldKey: mailing_postal_code
+ label: Mailing Postal Code
+ type: STRING
+ description: Postal Code for the contact's mailing address.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.traits.address.postal_code
+ then:
+ '@path': $.traits.address.postal_code
+ else:
+ '@path': $.properties.address.postal_code
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: pHDU5Dn7JUrLwgV3poLUNm
+ sortOrder: 13
+ fieldKey: mailing_country
+ label: Mailing Country
+ type: STRING
+ description: Country for the contact's mailing address.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.traits.address.country
+ then:
+ '@path': $.traits.address.country
+ else:
+ '@path': $.properties.address.country
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: bA7SdSzKHjyXvgKnVG5JUk
+ sortOrder: 14
+ fieldKey: mailing_street
+ label: Mailing Street
+ type: STRING
+ description: Street number and name for the contact's mailing address.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.traits.address.street
+ then:
+ '@path': $.traits.address.street
+ else:
+ '@path': $.properties.address.street
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: jhbSAJVckg5Bj4PcuGXMzp
+ sortOrder: 15
+ fieldKey: mailing_state
+ label: Mailing State
+ type: STRING
+ description: State for the contact's mailing address.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.traits.address.state
+ then:
+ '@path': $.traits.address.state
+ else:
+ '@path': $.properties.address.state
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: fShUZVeafUxA6x4Dk817aG
+ sortOrder: 16
fieldKey: customFields
label: Other Fields
type: OBJECT
@@ -75521,7 +75521,7 @@ items:
mobile: false
server: true
warehouse: true
- cloudAppObject: false
+ cloudAppObject: true
components: []
browserUnbundlingSupported: false
browserUnbundlingPublic: false
@@ -75537,17 +75537,17 @@ items:
server: true
settings: []
actions:
- - id: bJDm8aeYaQaGLVGtnRa28W
- name: Send Subscriptions
- slug: sendSubscription
+ - id: zfCkGpUYbWN9ns5jr1jvU
+ name: Send Group
+ slug: sendGroup
description: >-
- Send an identify call to Segment’s tracking API. This is used to get user
- channel subscription data into Engage.
+ Send a group call to Segment’s tracking API. This is used to associate an
+ individual user with a group
platform: CLOUD
hidden: false
- defaultTrigger: type = "identify"
+ defaultTrigger: type = "group"
fields:
- - id: dfBpRBByxh3gKiwqGXiEwF
+ - id: 79EmtjnuE9ZNKDqAhmDhrD
sortOrder: 0
fieldKey: engage_space
label: Profile Space
@@ -75564,168 +75564,48 @@ items:
choices: null
dynamic: true
allowNull: false
- - id: a3j5PUyULTpp5ACdtTFHCn
+ - id: sp1Z2gxEdnSC2pf2vNZfe5
sortOrder: 1
fieldKey: user_id
label: User ID
type: STRING
- description: Unique identifier for the user in your database.
+ description: >-
+ Unique identifier for the user in your database. A userId or an
+ anonymousId is required.
placeholder: ''
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: awHQ5Bn7Y9SDQ7kFW1necN
+ - id: cdQ41MbXfBySgMuVXKVx9q
sortOrder: 2
fieldKey: anonymous_id
label: Anonymous ID
type: STRING
description: >-
A pseudo-unique substitute for a User ID, for cases when you don’t have
- an absolutely unique identifier.
+ an absolutely unique identifier. A userId or an anonymousId is required.
placeholder: ''
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: uETK31qTvfUzegdDRJkjqs
+ - id: iqieyaxxbd5ZWdUFUAxTr2
sortOrder: 3
- fieldKey: email
- label: Email
+ fieldKey: group_id
+ label: Group ID
type: STRING
- description: Email of the user
+ description: The group or account ID a user is associated with.
placeholder: ''
- required: false
+ required: true
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: nMBXkMtRSgmZshjgSANv26
+ - id: mLNNjcCXAo9V4dM5ppMhhe
sortOrder: 4
- fieldKey: email_subscription_status
- label: Email Subscription Status
- type: STRING
- description: >-
- Global status of the email subscription. True is subscribed, false is
- unsubscribed, and did_not_subscribe is did_not_subscribe.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: true
- - id: 3wscFGUQSMWW6uLjvpsT89
- sortOrder: 5
- fieldKey: subscription_groups
- label: Email Subscription Groups
- type: OBJECT
- description: >-
- Group Subscription statuses are supported for the email channel. This
- object contains group names as keys and statuses as values. True is
- subscribed, false is unsubscribed, and did_not_subscribe is
- did_not_subscribe.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 39f8Wm9eg9Gv89aUpow7oP
- sortOrder: 6
- fieldKey: phone
- label: Phone
- type: STRING
- description: Phone number of the user
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: iWP2xjNEm4YoVLDtdghBcE
- sortOrder: 7
- fieldKey: sms_subscription_status
- label: SMS Subscription Status
- type: STRING
- description: >-
- Global status of the SMS subscription. True is subscribed, false is
- unsubscribed, and did_not_subscribe is did_not_subscribe.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: true
- - id: 3bsirVujuu7uYAKi3dkT5y
- sortOrder: 8
- fieldKey: whatsapp_subscription_status
- label: WhatsApp Subscription Status
- type: STRING
- description: >-
- Global status of the WhatsApp subscription. True is subscribed, false is
- unsubscribed, and did_not_subscribe is did_not_subscribe.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: true
- - id: irRjqn2BzsRd5wrize9dy9
- sortOrder: 9
- fieldKey: android_push_token
- label: Android Push Token
- type: STRING
- description: Android Push Token of the user
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 2Hwb37qKbV8UMQA88vJnqM
- sortOrder: 10
- fieldKey: android_push_subscription_status
- label: Android Push Subscription Status
- type: STRING
- description: >-
- Global status of the android push subscription. True is subscribed,
- false is unsubscribed, and did_not_subscribe is did_not_subscribe.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: true
- - id: tA1zH8Vy5UtWCK7Sxor8qH
- sortOrder: 11
- fieldKey: ios_push_token
- label: Ios Push Token
- type: STRING
- description: Ios Push Token of the user
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: o3oYmACsWz5JdeiJyrCpGg
- sortOrder: 12
- fieldKey: ios_push_subscription_status
- label: Ios Push Subscription Status
- type: STRING
- description: >-
- Global status of the ios push subscription. True is subscribed, false is
- unsubscribed, and did_not_subscribe is did_not_subscribe.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: true
- - id: kU7kduYY5N5ZJR4ydD3Eoj
- sortOrder: 13
fieldKey: traits
label: Traits
type: OBJECT
@@ -75736,8 +75616,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: gvuYrawXLsC4AG45DTpmv6
- sortOrder: 14
+ - id: d8DMSYmCuqqeu6H97XSut3
+ sortOrder: 5
fieldKey: timestamp
label: Timestamp
type: DATETIME
@@ -75843,17 +75723,17 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: zfCkGpUYbWN9ns5jr1jvU
- name: Send Group
- slug: sendGroup
+ - id: bJDm8aeYaQaGLVGtnRa28W
+ name: Send Subscriptions
+ slug: sendSubscription
description: >-
- Send a group call to Segment’s tracking API. This is used to associate an
- individual user with a group
+ Send an identify call to Segment’s tracking API. This is used to get user
+ channel subscription data into Engage.
platform: CLOUD
hidden: false
- defaultTrigger: type = "group"
+ defaultTrigger: type = "identify"
fields:
- - id: 79EmtjnuE9ZNKDqAhmDhrD
+ - id: dfBpRBByxh3gKiwqGXiEwF
sortOrder: 0
fieldKey: engage_space
label: Profile Space
@@ -75870,48 +75750,168 @@ items:
choices: null
dynamic: true
allowNull: false
- - id: sp1Z2gxEdnSC2pf2vNZfe5
+ - id: a3j5PUyULTpp5ACdtTFHCn
sortOrder: 1
fieldKey: user_id
label: User ID
type: STRING
- description: >-
- Unique identifier for the user in your database. A userId or an
- anonymousId is required.
+ description: Unique identifier for the user in your database.
placeholder: ''
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: cdQ41MbXfBySgMuVXKVx9q
+ - id: awHQ5Bn7Y9SDQ7kFW1necN
sortOrder: 2
fieldKey: anonymous_id
label: Anonymous ID
type: STRING
description: >-
A pseudo-unique substitute for a User ID, for cases when you don’t have
- an absolutely unique identifier. A userId or an anonymousId is required.
+ an absolutely unique identifier.
placeholder: ''
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: iqieyaxxbd5ZWdUFUAxTr2
+ - id: uETK31qTvfUzegdDRJkjqs
sortOrder: 3
- fieldKey: group_id
- label: Group ID
+ fieldKey: email
+ label: Email
type: STRING
- description: The group or account ID a user is associated with.
+ description: Email of the user
placeholder: ''
- required: true
+ required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: mLNNjcCXAo9V4dM5ppMhhe
+ - id: nMBXkMtRSgmZshjgSANv26
sortOrder: 4
+ fieldKey: email_subscription_status
+ label: Email Subscription Status
+ type: STRING
+ description: >-
+ Global status of the email subscription. True is subscribed, false is
+ unsubscribed, and did_not_subscribe is did_not_subscribe.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: true
+ - id: 3wscFGUQSMWW6uLjvpsT89
+ sortOrder: 5
+ fieldKey: subscription_groups
+ label: Email Subscription Groups
+ type: OBJECT
+ description: >-
+ Group Subscription statuses are supported for the email channel. This
+ object contains group names as keys and statuses as values. True is
+ subscribed, false is unsubscribed, and did_not_subscribe is
+ did_not_subscribe.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 39f8Wm9eg9Gv89aUpow7oP
+ sortOrder: 6
+ fieldKey: phone
+ label: Phone
+ type: STRING
+ description: Phone number of the user
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: iWP2xjNEm4YoVLDtdghBcE
+ sortOrder: 7
+ fieldKey: sms_subscription_status
+ label: SMS Subscription Status
+ type: STRING
+ description: >-
+ Global status of the SMS subscription. True is subscribed, false is
+ unsubscribed, and did_not_subscribe is did_not_subscribe.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: true
+ - id: 3bsirVujuu7uYAKi3dkT5y
+ sortOrder: 8
+ fieldKey: whatsapp_subscription_status
+ label: WhatsApp Subscription Status
+ type: STRING
+ description: >-
+ Global status of the WhatsApp subscription. True is subscribed, false is
+ unsubscribed, and did_not_subscribe is did_not_subscribe.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: true
+ - id: irRjqn2BzsRd5wrize9dy9
+ sortOrder: 9
+ fieldKey: android_push_token
+ label: Android Push Token
+ type: STRING
+ description: Android Push Token of the user
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 2Hwb37qKbV8UMQA88vJnqM
+ sortOrder: 10
+ fieldKey: android_push_subscription_status
+ label: Android Push Subscription Status
+ type: STRING
+ description: >-
+ Global status of the android push subscription. True is subscribed,
+ false is unsubscribed, and did_not_subscribe is did_not_subscribe.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: true
+ - id: tA1zH8Vy5UtWCK7Sxor8qH
+ sortOrder: 11
+ fieldKey: ios_push_token
+ label: Ios Push Token
+ type: STRING
+ description: Ios Push Token of the user
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: o3oYmACsWz5JdeiJyrCpGg
+ sortOrder: 12
+ fieldKey: ios_push_subscription_status
+ label: Ios Push Subscription Status
+ type: STRING
+ description: >-
+ Global status of the ios push subscription. True is subscribed, false is
+ unsubscribed, and did_not_subscribe is did_not_subscribe.
+ placeholder: ''
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: true
+ - id: kU7kduYY5N5ZJR4ydD3Eoj
+ sortOrder: 13
fieldKey: traits
label: Traits
type: OBJECT
@@ -75922,8 +75922,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: d8DMSYmCuqqeu6H97XSut3
- sortOrder: 5
+ - id: gvuYrawXLsC4AG45DTpmv6
+ sortOrder: 14
fieldKey: timestamp
label: Timestamp
type: DATETIME
@@ -80608,166 +80608,31 @@ items:
cloudAppObject: false
components: []
browserUnbundlingSupported: false
- browserUnbundlingPublic: false
- replay: false
- connection_modes:
- device:
- web: false
- mobile: false
- server: false
- cloud:
- web: true
- mobile: false
- server: true
- settings:
- - name: apiKey
- type: string
- defaultValue: ''
- description: Created under Developer Settings in the Talon.One Campaign Manager.
- required: true
- label: API Key
- - name: deployment
- type: string
- defaultValue: ''
- description: The base URL of your Talon.One deployment.
- required: true
- label: Deployment
- actions:
- - id: 2boWRtktKhqiuK9a2bZApN
- name: '[Deprecated] Update customer session'
- slug: updateCustomerSession
- description: >-
- This updates a customer session. **Important:** This Action is deprecated.
- Use the **Update customer session** Action instead.
- platform: CLOUD
- hidden: false
- defaultTrigger: null
- fields:
- - id: 4776FALurmrWhNQQQNNi1d
- sortOrder: 0
- fieldKey: customerSessionId
- label: Customer Session ID
- type: STRING
- description: The customer session integration identifier to use in Talon.One.
- placeholder: ''
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 2z4fx7KFyNmCdtHga2c22X
- sortOrder: 1
- fieldKey: callbackDestination
- label: Callback Destination URI
- type: STRING
- description: >-
- This specifies the address of the service and its endpoint to do
- callback request.
- placeholder: http://mydomain.com/api/callback_here
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: pXomxvSQQrK3xTuLdmsKRg
- sortOrder: 2
- fieldKey: callbackAPIKey
- label: Callback API Key
- type: STRING
- description: >-
- This specifies API key and relative header. The header is specified
- optionally
- placeholder: X-API-Key 123456789123456789123456789123456789
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: pH8DRDW5s7brgK5CRDTHYu
- sortOrder: 3
- fieldKey: contentFields
- label: Content Fields
- type: STRING
- description: >-
- This specifies a list of the fields from the response you need to
- receive. Comma character is separator. If omitted, all the fields will
- be forwarded from the response to the callback destination.
- placeholder: effects,customerProfile
- defaultValue: effects
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: tei5VBJNXVdFEy8uR8JaC3
- sortOrder: 4
- fieldKey: callbackCorrelationId
- label: Correlation ID
- type: STRING
- description: >-
- This specifies ID of the request that will be forwarded to the
- destination URI with the callback request with the same header name. If
- omitted, the X-Correlation-ID will not be in the callback request.
- placeholder: ''
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: nYgn46PZXDFfWSkYTCb4J
- sortOrder: 5
- fieldKey: customerSession
- label: Customer Session Data
- type: OBJECT
- description: This contains all the data related to customer session.
- placeholder: ''
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: jZB1GDRr2gLDf9U5VqZSiu
- sortOrder: 6
- fieldKey: sessionAttributesInfo
- label: Session Attributes info
- type: OBJECT
- description: >-
- Use this field if you want to identify a session attribute with a
- specific type
- placeholder: ''
- defaultValue:
- '@arrayPath':
- - $.properties.attributesInfo
- - name:
- '@path': $.name
- type:
- '@path': $.type
- required: false
- multiple: true
- choices: null
- dynamic: false
- allowNull: false
- - id: xwKvi2tmugc1S3YgjiDYkL
- sortOrder: 7
- fieldKey: cartItemsAttributesInfo
- label: Cart Items Attributes info
- type: OBJECT
- description: >-
- Use this field if you want to identify a cart item attribute with a
- specific type
- placeholder: ''
- defaultValue:
- '@arrayPath':
- - $.properties.attributesInfo
- - name:
- '@path': $.name
- type:
- '@path': $.type
- required: false
- multiple: true
- choices: null
- dynamic: false
- allowNull: false
+ browserUnbundlingPublic: false
+ replay: false
+ connection_modes:
+ device:
+ web: false
+ mobile: false
+ server: false
+ cloud:
+ web: true
+ mobile: false
+ server: true
+ settings:
+ - name: apiKey
+ type: string
+ defaultValue: ''
+ description: Created under Developer Settings in the Talon.One Campaign Manager.
+ required: true
+ label: API Key
+ - name: deployment
+ type: string
+ defaultValue: ''
+ description: The base URL of your Talon.One deployment.
+ required: true
+ label: Deployment
+ actions:
- id: 9f9ULnyoFhzXZAo2FNYNpG
name: Create Audience
slug: createAudience
@@ -80800,78 +80665,6 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: JxX3aD1RPa7zMn6FmwH8F
- name: Track event
- slug: trackEventV2
- description: >-
- This records a custom event in Talon.One. Create the event and all the
- required attributes before using this Action.
- platform: CLOUD
- hidden: false
- defaultTrigger: null
- fields:
- - id: fq5ujnx2hpj5CtqZxonWYW
- sortOrder: 0
- fieldKey: skipNonExistingAttributes
- label: Skip Non-existing Attributes Flag
- type: BOOLEAN
- description: >-
- Indicates whether to skip non-existing attributes. If `Yes`, the
- non-existing attributes are skipped and a 400 error is not returned. If
- `No`, a 400 error is returned in case of non-existing attributes.
- placeholder: ''
- defaultValue: false
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: gKLJcjGqiCtXjDzWfd2Yse
- sortOrder: 1
- fieldKey: customerProfileId
- label: Customer Profile ID
- type: STRING
- description: >-
- The customer profile integration ID to use in Talon.One. It is the
- identifier of the customer profile associated to the event.
- placeholder: ''
- defaultValue:
- '@path': $.userId
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: vsWtQJWdkQqi7hrQv6u95E
- sortOrder: 2
- fieldKey: eventType
- label: Event Type
- type: STRING
- description: The name of the event sent to Talon.One.
- placeholder: ''
- defaultValue:
- '@path': $.event
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: wRR1xagGNaUUtP1DJZMJQb
- sortOrder: 3
- fieldKey: attributes
- label: Attribute-Value pairs
- type: OBJECT
- description: >-
- Extra attributes associated with the event. [See more
- info](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes).
- placeholder: ''
- defaultValue:
- '@path': $.properties.attributes
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- id: aBasBxDewdhgRjDGvNbEwL
name: '[Deprecated] Track event'
slug: trackEvent
@@ -81140,98 +80933,194 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: nEzS6B255TiBsk4n2aTGP6
- name: Update customer profile
- slug: updateCustomerProfileV3
- description: >-
- This updates attributes and audiences for a single customer profile.
- Create all the required attributes and audiences before using this Action.
+ - id: uZ8mzsLo5KFgwoSQsDXnKK
+ name: Update Audience Name
+ slug: updateAudience
+ description: This updates the audience name if there is an existing audience entity.
platform: CLOUD
hidden: false
defaultTrigger: null
fields:
- - id: p7xyBx4xDqGhDJTYwmyviU
+ - id: nrb8UBcDpp87L5q4LmcDSv
sortOrder: 0
- fieldKey: customerProfileId
- label: Customer Profile ID
+ fieldKey: audienceId
+ label: Segment Audience ID
type: STRING
- description: The customer profile integration identifier to use in Talon.One.
+ description: You should get this audience ID from Segment.
placeholder: ''
- defaultValue:
- '@path': $.userId
required: true
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: xz4d6BDbxJj71m2B5cQntt
+ - id: cgCKCcijwN7bz83hU4YtNd
sortOrder: 1
- fieldKey: skipNonExistingAttributes
- label: Skip Non-existing Attributes Flag
- type: BOOLEAN
+ fieldKey: audienceName
+ label: Audience Name
+ type: STRING
+ description: You should get this audience name from Segment.
+ placeholder: ''
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: x1VDfGjR5NPmPkhCF5a8WN
+ name: Update Multiple Customer Profiles’ Audiences
+ slug: updateCustomerProfilesAudiences
+ description: This updates audiences for multiple customer profiles.
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: null
+ fields:
+ - id: rp3JSDvNLDgK2CPGEhXjct
+ sortOrder: 0
+ fieldKey: data
+ label: Data item to change customer profile audiences
+ type: OBJECT
description: >-
- Indicates whether to skip non-existing attributes. If `Yes`, the
- non-existing attributes are skipped and a 400 error is not returned. If
- `No`, a 400 error is returned in case of non-existing attributes.
+ An array of JSON objects that contains customer profile identifier and
+ list of audiences to associate and dissociate with the indicated
+ customer profile. Customer profile ID and at least one audience ID are
+ required.
placeholder: ''
- defaultValue: false
+ required: true
+ multiple: true
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 2boWRtktKhqiuK9a2bZApN
+ name: '[Deprecated] Update customer session'
+ slug: updateCustomerSession
+ description: >-
+ This updates a customer session. **Important:** This Action is deprecated.
+ Use the **Update customer session** Action instead.
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: null
+ fields:
+ - id: 4776FALurmrWhNQQQNNi1d
+ sortOrder: 0
+ fieldKey: customerSessionId
+ label: Customer Session ID
+ type: STRING
+ description: The customer session integration identifier to use in Talon.One.
+ placeholder: ''
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 2z4fx7KFyNmCdtHga2c22X
+ sortOrder: 1
+ fieldKey: callbackDestination
+ label: Callback Destination URI
+ type: STRING
+ description: >-
+ This specifies the address of the service and its endpoint to do
+ callback request.
+ placeholder: http://mydomain.com/api/callback_here
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: 335bQmB7ydxsgQfJViYKcw
+ - id: pXomxvSQQrK3xTuLdmsKRg
sortOrder: 2
- fieldKey: deleteAudienceIds
- label: List of audience ID to dissociate with the customer profile.
- type: INTEGER
- description: You should get these audience IDs from Talon.One.
- placeholder: ''
+ fieldKey: callbackAPIKey
+ label: Callback API Key
+ type: STRING
+ description: >-
+ This specifies API key and relative header. The header is specified
+ optionally
+ placeholder: X-API-Key 123456789123456789123456789123456789
required: false
- multiple: true
+ multiple: false
choices: null
dynamic: false
allowNull: false
- - id: nCuoVz4CbFDeCvE2ny9F3E
+ - id: pH8DRDW5s7brgK5CRDTHYu
sortOrder: 3
- fieldKey: addAudienceIds
- label: List of audience ID to associate with the customer profile.
- type: INTEGER
- description: You should get these audience IDs from Talon.One.
- placeholder: ''
+ fieldKey: contentFields
+ label: Content Fields
+ type: STRING
+ description: >-
+ This specifies a list of the fields from the response you need to
+ receive. Comma character is separator. If omitted, all the fields will
+ be forwarded from the response to the callback destination.
+ placeholder: effects,customerProfile
+ defaultValue: effects
required: false
- multiple: true
+ multiple: false
choices: null
dynamic: false
allowNull: false
- - id: nuY8kHz13ajr9xJ5fiwXfA
+ - id: tei5VBJNXVdFEy8uR8JaC3
sortOrder: 4
- fieldKey: runRuleEngine
- label: Run rule engine
- type: BOOLEAN
+ fieldKey: callbackCorrelationId
+ label: Correlation ID
+ type: STRING
description: >-
- This runs rule engine in Talon.One upon updating customer profile. Set
- to true to trigger rules.
+ This specifies ID of the request that will be forwarded to the
+ destination URI with the callback request with the same header name. If
+ omitted, the X-Correlation-ID will not be in the callback request.
placeholder: ''
- defaultValue: true
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: xteVAjpWvraYnPMT1mDK1f
+ - id: nYgn46PZXDFfWSkYTCb4J
sortOrder: 5
- fieldKey: attributes
- label: Attribute-Value pairs
+ fieldKey: customerSession
+ label: Customer Session Data
+ type: OBJECT
+ description: This contains all the data related to customer session.
+ placeholder: ''
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: jZB1GDRr2gLDf9U5VqZSiu
+ sortOrder: 6
+ fieldKey: sessionAttributesInfo
+ label: Session Attributes info
type: OBJECT
description: >-
- Extra attributes associated with the customer profile. [See more
- info](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes).
+ Use this field if you want to identify a session attribute with a
+ specific type
placeholder: ''
defaultValue:
- '@path': $.traits
+ '@arrayPath':
+ - $.properties.attributesInfo
+ - name:
+ '@path': $.name
+ type:
+ '@path': $.type
required: false
- multiple: false
+ multiple: true
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: xwKvi2tmugc1S3YgjiDYkL
+ sortOrder: 7
+ fieldKey: cartItemsAttributesInfo
+ label: Cart Items Attributes info
+ type: OBJECT
+ description: >-
+ Use this field if you want to identify a cart item attribute with a
+ specific type
+ placeholder: ''
+ defaultValue:
+ '@arrayPath':
+ - $.properties.attributesInfo
+ - name:
+ '@path': $.name
+ type:
+ '@path': $.type
+ required: false
+ multiple: true
choices: null
dynamic: false
allowNull: false
@@ -81348,6 +81237,173 @@ items:
choices: null
dynamic: false
allowNull: false
+ - id: JxX3aD1RPa7zMn6FmwH8F
+ name: Track event
+ slug: trackEventV2
+ description: >-
+ This records a custom event in Talon.One. Create the event and all the
+ required attributes before using this Action.
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: null
+ fields:
+ - id: fq5ujnx2hpj5CtqZxonWYW
+ sortOrder: 0
+ fieldKey: skipNonExistingAttributes
+ label: Skip Non-existing Attributes Flag
+ type: BOOLEAN
+ description: >-
+ Indicates whether to skip non-existing attributes. If `Yes`, the
+ non-existing attributes are skipped and a 400 error is not returned. If
+ `No`, a 400 error is returned in case of non-existing attributes.
+ placeholder: ''
+ defaultValue: false
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: gKLJcjGqiCtXjDzWfd2Yse
+ sortOrder: 1
+ fieldKey: customerProfileId
+ label: Customer Profile ID
+ type: STRING
+ description: >-
+ The customer profile integration ID to use in Talon.One. It is the
+ identifier of the customer profile associated to the event.
+ placeholder: ''
+ defaultValue:
+ '@path': $.userId
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: vsWtQJWdkQqi7hrQv6u95E
+ sortOrder: 2
+ fieldKey: eventType
+ label: Event Type
+ type: STRING
+ description: The name of the event sent to Talon.One.
+ placeholder: ''
+ defaultValue:
+ '@path': $.event
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: wRR1xagGNaUUtP1DJZMJQb
+ sortOrder: 3
+ fieldKey: attributes
+ label: Attribute-Value pairs
+ type: OBJECT
+ description: >-
+ Extra attributes associated with the event. [See more
+ info](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes).
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.attributes
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: nEzS6B255TiBsk4n2aTGP6
+ name: Update customer profile
+ slug: updateCustomerProfileV3
+ description: >-
+ This updates attributes and audiences for a single customer profile.
+ Create all the required attributes and audiences before using this Action.
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: null
+ fields:
+ - id: p7xyBx4xDqGhDJTYwmyviU
+ sortOrder: 0
+ fieldKey: customerProfileId
+ label: Customer Profile ID
+ type: STRING
+ description: The customer profile integration identifier to use in Talon.One.
+ placeholder: ''
+ defaultValue:
+ '@path': $.userId
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: xz4d6BDbxJj71m2B5cQntt
+ sortOrder: 1
+ fieldKey: skipNonExistingAttributes
+ label: Skip Non-existing Attributes Flag
+ type: BOOLEAN
+ description: >-
+ Indicates whether to skip non-existing attributes. If `Yes`, the
+ non-existing attributes are skipped and a 400 error is not returned. If
+ `No`, a 400 error is returned in case of non-existing attributes.
+ placeholder: ''
+ defaultValue: false
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 335bQmB7ydxsgQfJViYKcw
+ sortOrder: 2
+ fieldKey: deleteAudienceIds
+ label: List of audience ID to dissociate with the customer profile.
+ type: INTEGER
+ description: You should get these audience IDs from Talon.One.
+ placeholder: ''
+ required: false
+ multiple: true
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: nCuoVz4CbFDeCvE2ny9F3E
+ sortOrder: 3
+ fieldKey: addAudienceIds
+ label: List of audience ID to associate with the customer profile.
+ type: INTEGER
+ description: You should get these audience IDs from Talon.One.
+ placeholder: ''
+ required: false
+ multiple: true
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: nuY8kHz13ajr9xJ5fiwXfA
+ sortOrder: 4
+ fieldKey: runRuleEngine
+ label: Run rule engine
+ type: BOOLEAN
+ description: >-
+ This runs rule engine in Talon.One upon updating customer profile. Set
+ to true to trigger rules.
+ placeholder: ''
+ defaultValue: true
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: xteVAjpWvraYnPMT1mDK1f
+ sortOrder: 5
+ fieldKey: attributes
+ label: Attribute-Value pairs
+ type: OBJECT
+ description: >-
+ Extra attributes associated with the customer profile. [See more
+ info](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes).
+ placeholder: ''
+ defaultValue:
+ '@path': $.traits
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
- id: sXKEzLehvdKW7R1g1SmTun
name: Update customer session
slug: updateCustomerSessionV2
@@ -81583,62 +81639,6 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: uZ8mzsLo5KFgwoSQsDXnKK
- name: Update Audience Name
- slug: updateAudience
- description: This updates the audience name if there is an existing audience entity.
- platform: CLOUD
- hidden: false
- defaultTrigger: null
- fields:
- - id: nrb8UBcDpp87L5q4LmcDSv
- sortOrder: 0
- fieldKey: audienceId
- label: Segment Audience ID
- type: STRING
- description: You should get this audience ID from Segment.
- placeholder: ''
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: cgCKCcijwN7bz83hU4YtNd
- sortOrder: 1
- fieldKey: audienceName
- label: Audience Name
- type: STRING
- description: You should get this audience name from Segment.
- placeholder: ''
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: x1VDfGjR5NPmPkhCF5a8WN
- name: Update Multiple Customer Profiles’ Audiences
- slug: updateCustomerProfilesAudiences
- description: This updates audiences for multiple customer profiles.
- platform: CLOUD
- hidden: false
- defaultTrigger: null
- fields:
- - id: rp3JSDvNLDgK2CPGEhXjct
- sortOrder: 0
- fieldKey: data
- label: Data item to change customer profile audiences
- type: OBJECT
- description: >-
- An array of JSON objects that contains customer profile identifier and
- list of audiences to associate and dissociate with the indicated
- customer profile. Customer profile ID and at least one audience ID are
- required.
- placeholder: ''
- required: true
- multiple: true
- choices: null
- dynamic: false
- allowNull: false
presets: []
- id: 5c8ad1622b2a130001a7664a
display_name: Tamber
@@ -82134,16 +82134,43 @@ items:
server: true
settings: []
actions:
- - id: 6CJWiKySEoUgoboXtznkK3
- name: Add to Audience
- slug: addToAudience
- description: Add records from an Engage Audience to a TikTok Audience Segment.
+ - id: hHwktvrTqqBDpD7pCfcB1L
+ name: Add Users
+ slug: addUser
+ description: Add contacts from an Engage Audience to a TikTok Audience Segment.
platform: CLOUD
hidden: false
defaultTrigger: event = "Audience Entered"
fields:
- - id: 3vxQrSbCZZWUvo2KUJ3tVr
+ - id: 2eY58Qa3XZAg6bUZyAUnki
sortOrder: 0
+ fieldKey: selected_advertiser_id
+ label: Advertiser ID
+ type: STRING
+ description: The advertiser ID to use when syncing audiences.
+ placeholder: ''
+ required: true
+ multiple: false
+ choices: null
+ dynamic: true
+ allowNull: false
+ - id: gff5vVWeHcHj3TRoHtJa97
+ sortOrder: 1
+ fieldKey: audience_id
+ label: Audience ID
+ type: STRING
+ description: >-
+ Audience ID for the TikTok Audience you want to sync your Engage
+ audience to. This is returned after you create an audience and can also
+ be found in the TikTok Audiences dashboard.
+ placeholder: ''
+ required: true
+ multiple: false
+ choices: null
+ dynamic: true
+ allowNull: false
+ - id: bLFEnrKkS6GrYW2LDyxfy3
+ sortOrder: 2
fieldKey: email
label: User Email
type: STRING
@@ -82162,8 +82189,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: weNAX2Cr3Cy77Mk2LZZRaa
- sortOrder: 1
+ - id: tYF6Rb9xW8seYquBMbEsm5
+ sortOrder: 3
fieldKey: phone
label: User Phone Number
type: STRING
@@ -82182,8 +82209,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: a7hQfQoKE6H5egknfAP7tL
- sortOrder: 2
+ - id: 9ix1TyAfzxmh6wGk91Qa9d
+ sortOrder: 4
fieldKey: advertising_id
label: User Advertising ID
type: STRING
@@ -82198,8 +82225,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: pvpbMfTPr46XaXJduLgTeT
- sortOrder: 3
+ - id: mn1Xy9D5rL7AAwDWK9vmV9
+ sortOrder: 5
fieldKey: send_email
label: Send Email?
type: BOOLEAN
@@ -82211,8 +82238,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: uFSuLskyTn2N2fjVZR3AQc
- sortOrder: 4
+ - id: ipgnzcgyuH8hskYQG85kHL
+ sortOrder: 6
fieldKey: send_phone
label: Send Phone Number?
type: BOOLEAN
@@ -82224,8 +82251,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 6afgUVp3L74M8cf8PPumBW
- sortOrder: 5
+ - id: ayMVwTMWmTxRCV2HnjFjVP
+ sortOrder: 7
fieldKey: send_advertising_id
label: Send Mobile Advertising ID?
type: BOOLEAN
@@ -82239,8 +82266,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: dS7PeozD5tBg9VUo9Eb9iM
- sortOrder: 6
+ - id: unKWfoTc7pk5YFzP1Fvjz3
+ sortOrder: 8
fieldKey: event_name
label: Event Name
type: STRING
@@ -82253,8 +82280,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: tru4k7Y8dcf1ACSY6ScvAb
- sortOrder: 7
+ - id: joYYLTXPYmeyw3n34THeC4
+ sortOrder: 9
fieldKey: enable_batching
label: Enable Batching
type: BOOLEAN
@@ -82266,15 +82293,160 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: oJaFW7ymqdTmG4CdUsaziL
+ - id: qaHW7xW6EGyUaaDrstiPjL
+ name: Remove Users
+ slug: removeUser
+ description: Remove contacts from an Engage Audience to a TikTok Audience Segment.
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: event = "Audience Exited"
+ fields:
+ - id: o3odHdStXFeoaZN3mMPXyw
+ sortOrder: 0
+ fieldKey: selected_advertiser_id
+ label: Advertiser ID
+ type: STRING
+ description: The advertiser ID to use when syncing audiences.
+ placeholder: ''
+ required: true
+ multiple: false
+ choices: null
+ dynamic: true
+ allowNull: false
+ - id: gdBRqbLdW9ANg8fizMw4sh
+ sortOrder: 1
+ fieldKey: audience_id
+ label: Audience ID
+ type: STRING
+ description: >-
+ Audience ID for the TikTok Audience you want to sync your Engage
+ audience to. This is returned after you create an audience and can also
+ be found in the TikTok Audiences dashboard.
+ placeholder: ''
+ required: true
+ multiple: false
+ choices: null
+ dynamic: true
+ allowNull: false
+ - id: vmK5xPMGXm3in4pNTAGxo9
+ sortOrder: 2
+ fieldKey: email
+ label: User Email
+ type: STRING
+ description: The user's email address to send to TikTok.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.context.traits.email
+ then:
+ '@path': $.context.traits.email
+ else:
+ '@path': $.properties.email
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 5Gs3D9dGTvzYBxCfBDkCNb
+ sortOrder: 3
+ fieldKey: phone
+ label: User Phone Number
+ type: STRING
+ description: The user's phone number to send to TikTok.
+ placeholder: ''
+ defaultValue:
+ '@if':
+ exists:
+ '@path': $.context.traits.phone
+ then:
+ '@path': $.context.traits.phone
+ else:
+ '@path': $.properties.phone
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: kviKoosYKdcTg2V7Fc33C5
+ sortOrder: 4
+ fieldKey: advertising_id
+ label: User Advertising ID
+ type: STRING
+ description: >-
+ The user's mobile advertising ID to send to TikTok. This could be a
+ GAID, IDFA, or AAID
+ placeholder: ''
+ defaultValue:
+ '@path': $.context.device.advertisingId
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: nUXPneiW7kZ78NW8AWgJjB
+ sortOrder: 5
+ fieldKey: send_email
+ label: Send Email?
+ type: BOOLEAN
+ description: Send email to TikTok. Segment will hash this value before sending
+ placeholder: ''
+ defaultValue: true
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: rMPVTmTE3LQntuenV4zo3x
+ sortOrder: 6
+ fieldKey: send_phone
+ label: Send Phone Number?
+ type: BOOLEAN
+ description: Send phone number to TikTok. Segment will hash this value before sending
+ placeholder: ''
+ defaultValue: true
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: eiLnkbBkYKUqfwoZiXskbD
+ sortOrder: 7
+ fieldKey: send_advertising_id
+ label: Send Mobile Advertising ID?
+ type: BOOLEAN
+ description: >-
+ Send mobile advertising ID (IDFA, AAID or GAID) to TikTok. Segment will
+ hash this value before sending.
+ placeholder: ''
+ defaultValue: true
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 3eNDiGQzBNgiq3CaHqnSbP
sortOrder: 8
- fieldKey: external_audience_id
- label: External Audience ID
+ fieldKey: event_name
+ label: Event Name
type: STRING
- description: The Audience ID in TikTok's DB.
+ description: The name of the current Segment event.
placeholder: ''
defaultValue:
- '@path': $.context.personas.external_audience_id
+ '@path': $.event
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: jE5CWv3GSP8GTVZDp6uNLZ
+ sortOrder: 9
+ fieldKey: enable_batching
+ label: Enable Batching
+ type: BOOLEAN
+ description: Enable batching of requests to the TikTok Audiences.
+ placeholder: ''
+ defaultValue: true
required: false
multiple: false
choices: null
@@ -82337,43 +82509,16 @@ items:
value: IDFA_SHA256
dynamic: false
allowNull: false
- - id: hHwktvrTqqBDpD7pCfcB1L
- name: Add Users
- slug: addUser
- description: Add contacts from an Engage Audience to a TikTok Audience Segment.
+ - id: 6CJWiKySEoUgoboXtznkK3
+ name: Add to Audience
+ slug: addToAudience
+ description: Add records from an Engage Audience to a TikTok Audience Segment.
platform: CLOUD
hidden: false
defaultTrigger: event = "Audience Entered"
fields:
- - id: 2eY58Qa3XZAg6bUZyAUnki
+ - id: 3vxQrSbCZZWUvo2KUJ3tVr
sortOrder: 0
- fieldKey: selected_advertiser_id
- label: Advertiser ID
- type: STRING
- description: The advertiser ID to use when syncing audiences.
- placeholder: ''
- required: true
- multiple: false
- choices: null
- dynamic: true
- allowNull: false
- - id: gff5vVWeHcHj3TRoHtJa97
- sortOrder: 1
- fieldKey: audience_id
- label: Audience ID
- type: STRING
- description: >-
- Audience ID for the TikTok Audience you want to sync your Engage
- audience to. This is returned after you create an audience and can also
- be found in the TikTok Audiences dashboard.
- placeholder: ''
- required: true
- multiple: false
- choices: null
- dynamic: true
- allowNull: false
- - id: bLFEnrKkS6GrYW2LDyxfy3
- sortOrder: 2
fieldKey: email
label: User Email
type: STRING
@@ -82392,8 +82537,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: tYF6Rb9xW8seYquBMbEsm5
- sortOrder: 3
+ - id: weNAX2Cr3Cy77Mk2LZZRaa
+ sortOrder: 1
fieldKey: phone
label: User Phone Number
type: STRING
@@ -82412,8 +82557,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 9ix1TyAfzxmh6wGk91Qa9d
- sortOrder: 4
+ - id: a7hQfQoKE6H5egknfAP7tL
+ sortOrder: 2
fieldKey: advertising_id
label: User Advertising ID
type: STRING
@@ -82428,8 +82573,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: mn1Xy9D5rL7AAwDWK9vmV9
- sortOrder: 5
+ - id: pvpbMfTPr46XaXJduLgTeT
+ sortOrder: 3
fieldKey: send_email
label: Send Email?
type: BOOLEAN
@@ -82441,8 +82586,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: ipgnzcgyuH8hskYQG85kHL
- sortOrder: 6
+ - id: uFSuLskyTn2N2fjVZR3AQc
+ sortOrder: 4
fieldKey: send_phone
label: Send Phone Number?
type: BOOLEAN
@@ -82454,8 +82599,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: ayMVwTMWmTxRCV2HnjFjVP
- sortOrder: 7
+ - id: 6afgUVp3L74M8cf8PPumBW
+ sortOrder: 5
fieldKey: send_advertising_id
label: Send Mobile Advertising ID?
type: BOOLEAN
@@ -82469,8 +82614,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: unKWfoTc7pk5YFzP1Fvjz3
- sortOrder: 8
+ - id: dS7PeozD5tBg9VUo9Eb9iM
+ sortOrder: 6
fieldKey: event_name
label: Event Name
type: STRING
@@ -82483,8 +82628,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: joYYLTXPYmeyw3n34THeC4
- sortOrder: 9
+ - id: tru4k7Y8dcf1ACSY6ScvAb
+ sortOrder: 7
fieldKey: enable_batching
label: Enable Batching
type: BOOLEAN
@@ -82496,6 +82641,20 @@ items:
choices: null
dynamic: false
allowNull: false
+ - id: oJaFW7ymqdTmG4CdUsaziL
+ sortOrder: 8
+ fieldKey: external_audience_id
+ label: External Audience ID
+ type: STRING
+ description: The Audience ID in TikTok's DB.
+ placeholder: ''
+ defaultValue:
+ '@path': $.context.personas.external_audience_id
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
- id: hZypr7fRG8jp1AMe2scHut
name: Remove from Audience
slug: removeFromAudience
@@ -82642,165 +82801,6 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: qaHW7xW6EGyUaaDrstiPjL
- name: Remove Users
- slug: removeUser
- description: Remove contacts from an Engage Audience to a TikTok Audience Segment.
- platform: CLOUD
- hidden: false
- defaultTrigger: event = "Audience Exited"
- fields:
- - id: o3odHdStXFeoaZN3mMPXyw
- sortOrder: 0
- fieldKey: selected_advertiser_id
- label: Advertiser ID
- type: STRING
- description: The advertiser ID to use when syncing audiences.
- placeholder: ''
- required: true
- multiple: false
- choices: null
- dynamic: true
- allowNull: false
- - id: gdBRqbLdW9ANg8fizMw4sh
- sortOrder: 1
- fieldKey: audience_id
- label: Audience ID
- type: STRING
- description: >-
- Audience ID for the TikTok Audience you want to sync your Engage
- audience to. This is returned after you create an audience and can also
- be found in the TikTok Audiences dashboard.
- placeholder: ''
- required: true
- multiple: false
- choices: null
- dynamic: true
- allowNull: false
- - id: vmK5xPMGXm3in4pNTAGxo9
- sortOrder: 2
- fieldKey: email
- label: User Email
- type: STRING
- description: The user's email address to send to TikTok.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.context.traits.email
- then:
- '@path': $.context.traits.email
- else:
- '@path': $.properties.email
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 5Gs3D9dGTvzYBxCfBDkCNb
- sortOrder: 3
- fieldKey: phone
- label: User Phone Number
- type: STRING
- description: The user's phone number to send to TikTok.
- placeholder: ''
- defaultValue:
- '@if':
- exists:
- '@path': $.context.traits.phone
- then:
- '@path': $.context.traits.phone
- else:
- '@path': $.properties.phone
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: kviKoosYKdcTg2V7Fc33C5
- sortOrder: 4
- fieldKey: advertising_id
- label: User Advertising ID
- type: STRING
- description: >-
- The user's mobile advertising ID to send to TikTok. This could be a
- GAID, IDFA, or AAID
- placeholder: ''
- defaultValue:
- '@path': $.context.device.advertisingId
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: nUXPneiW7kZ78NW8AWgJjB
- sortOrder: 5
- fieldKey: send_email
- label: Send Email?
- type: BOOLEAN
- description: Send email to TikTok. Segment will hash this value before sending
- placeholder: ''
- defaultValue: true
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: rMPVTmTE3LQntuenV4zo3x
- sortOrder: 6
- fieldKey: send_phone
- label: Send Phone Number?
- type: BOOLEAN
- description: Send phone number to TikTok. Segment will hash this value before sending
- placeholder: ''
- defaultValue: true
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: eiLnkbBkYKUqfwoZiXskbD
- sortOrder: 7
- fieldKey: send_advertising_id
- label: Send Mobile Advertising ID?
- type: BOOLEAN
- description: >-
- Send mobile advertising ID (IDFA, AAID or GAID) to TikTok. Segment will
- hash this value before sending.
- placeholder: ''
- defaultValue: true
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 3eNDiGQzBNgiq3CaHqnSbP
- sortOrder: 8
- fieldKey: event_name
- label: Event Name
- type: STRING
- description: The name of the current Segment event.
- placeholder: ''
- defaultValue:
- '@path': $.event
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: jE5CWv3GSP8GTVZDp6uNLZ
- sortOrder: 9
- fieldKey: enable_batching
- label: Enable Batching
- type: BOOLEAN
- description: Enable batching of requests to the TikTok Audiences.
- placeholder: ''
- defaultValue: true
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
presets: []
- id: 615cae349d109d6b7496a131
display_name: TikTok Conversions
@@ -86386,15 +86386,15 @@ items:
required: true
label: API Key
actions:
- - id: 2MnZ8vTq2xTZAF8sbktDZU
- name: Enrich user
- slug: enrichUser
- description: Enrich the user
+ - id: 4xEBcRag1ZcwcXsGMzBpr5
+ name: Identify user
+ slug: identifyUser
+ description: Identify the user
platform: WEB
hidden: false
defaultTrigger: type = "identify"
fields:
- - id: ho5BbzTHaD9tjwneAqBnhW
+ - id: jVJwhcyWqwjV3dqPJ6FdDv
sortOrder: 0
fieldKey: user_id
label: User ID
@@ -86408,7 +86408,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: hSMYt7WbciKzSKEQ57iJWZ
+ - id: u3LDJgUd6YkQLDUPR5HgED
sortOrder: 1
fieldKey: name
label: Name
@@ -86422,8 +86422,36 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: xd95H5Btebdo3y5dRtuEbS
+ - id: xwb1hQmGGDHjF4FUGjDMpA
sortOrder: 2
+ fieldKey: firstName
+ label: First Name
+ type: STRING
+ description: The user's given name.
+ placeholder: ''
+ defaultValue:
+ '@path': $.traits.firstName
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: 7vXk3Tcmtq6G6xeCQyBmhW
+ sortOrder: 3
+ fieldKey: lastName
+ label: Last Name
+ type: STRING
+ description: The user's surname.
+ placeholder: ''
+ defaultValue:
+ '@path': $.traits.lastName
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: b11ogQbRUvCtjsBXfb3LP
+ sortOrder: 4
fieldKey: email
label: Email Address
type: STRING
@@ -86436,8 +86464,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 95fW3jcioThzNEatCj4t47
- sortOrder: 3
+ - id: pbhBj5hAK3Ka3vkWZGRHTr
+ sortOrder: 5
fieldKey: phone
label: Phone Number
type: STRING
@@ -86450,8 +86478,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: wvzDKbNKSRjKJoLGHXpwCm
- sortOrder: 4
+ - id: mMChxZYVTu4mGfLengZw7J
+ sortOrder: 6
fieldKey: avatar_image_url
label: Avatar
type: STRING
@@ -86464,8 +86492,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: gGYBAHAWivc9j3GbZK2Ydh
- sortOrder: 5
+ - id: 5a5FPt9YeVqEuY1qorZ5eZ
+ sortOrder: 7
fieldKey: custom_traits
label: Custom Attributes
type: OBJECT
@@ -86476,15 +86504,15 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 4xEBcRag1ZcwcXsGMzBpr5
- name: Identify user
- slug: identifyUser
- description: Identify the user
+ - id: 2MnZ8vTq2xTZAF8sbktDZU
+ name: Enrich user
+ slug: enrichUser
+ description: Enrich the user
platform: WEB
hidden: false
defaultTrigger: type = "identify"
fields:
- - id: jVJwhcyWqwjV3dqPJ6FdDv
+ - id: ho5BbzTHaD9tjwneAqBnhW
sortOrder: 0
fieldKey: user_id
label: User ID
@@ -86498,7 +86526,7 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: u3LDJgUd6YkQLDUPR5HgED
+ - id: hSMYt7WbciKzSKEQ57iJWZ
sortOrder: 1
fieldKey: name
label: Name
@@ -86512,36 +86540,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: xwb1hQmGGDHjF4FUGjDMpA
+ - id: xd95H5Btebdo3y5dRtuEbS
sortOrder: 2
- fieldKey: firstName
- label: First Name
- type: STRING
- description: The user's given name.
- placeholder: ''
- defaultValue:
- '@path': $.traits.firstName
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: 7vXk3Tcmtq6G6xeCQyBmhW
- sortOrder: 3
- fieldKey: lastName
- label: Last Name
- type: STRING
- description: The user's surname.
- placeholder: ''
- defaultValue:
- '@path': $.traits.lastName
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: b11ogQbRUvCtjsBXfb3LP
- sortOrder: 4
fieldKey: email
label: Email Address
type: STRING
@@ -86554,8 +86554,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: pbhBj5hAK3Ka3vkWZGRHTr
- sortOrder: 5
+ - id: 95fW3jcioThzNEatCj4t47
+ sortOrder: 3
fieldKey: phone
label: Phone Number
type: STRING
@@ -86568,8 +86568,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: mMChxZYVTu4mGfLengZw7J
- sortOrder: 6
+ - id: wvzDKbNKSRjKJoLGHXpwCm
+ sortOrder: 4
fieldKey: avatar_image_url
label: Avatar
type: STRING
@@ -86582,8 +86582,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 5a5FPt9YeVqEuY1qorZ5eZ
- sortOrder: 7
+ - id: gGYBAHAWivc9j3GbZK2Ydh
+ sortOrder: 5
fieldKey: custom_traits
label: Custom Attributes
type: OBJECT
@@ -88977,70 +88977,6 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: RzH8WC76wNx7K29zxPQkQ
- name: Sync Audience
- slug: syncAudience
- description: Syncs Segment audiences to VWO
- platform: CLOUD
- hidden: false
- defaultTrigger: event = "Audience Entered" or event = "Audience Exited"
- fields:
- - id: macqZu7eqCkV1R4isCrwnk
- sortOrder: 0
- fieldKey: name
- label: Event Name
- type: STRING
- description: Name of the event
- placeholder: ''
- defaultValue:
- '@path': $.event
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: mkuv3KRq87ZZovDmtUJQJV
- sortOrder: 1
- fieldKey: userId
- label: User ID
- type: STRING
- description: An unique identifier for the user
- placeholder: ''
- defaultValue:
- '@path': $.userId
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: wavcfKXR7NhpxtjjnJut3t
- sortOrder: 2
- fieldKey: anonymousId
- label: Anonymous ID
- type: STRING
- description: Anonymous ID for users
- placeholder: ''
- defaultValue:
- '@path': $.anonymousId
- required: false
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: jqWF1B2dy4ReiohP9rNmpx
- sortOrder: 3
- fieldKey: audienceId
- label: Audience ID
- type: STRING
- description: Segment's audience ID
- placeholder: ''
- defaultValue:
- '@path': $.properties.audience_key
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- id: n79NZEq8nbvqPkh1WwQZ2z
name: Page Visit
slug: pageVisit
@@ -89241,6 +89177,70 @@ items:
choices: null
dynamic: false
allowNull: false
+ - id: RzH8WC76wNx7K29zxPQkQ
+ name: Sync Audience
+ slug: syncAudience
+ description: Syncs Segment audiences to VWO
+ platform: CLOUD
+ hidden: false
+ defaultTrigger: event = "Audience Entered" or event = "Audience Exited"
+ fields:
+ - id: macqZu7eqCkV1R4isCrwnk
+ sortOrder: 0
+ fieldKey: name
+ label: Event Name
+ type: STRING
+ description: Name of the event
+ placeholder: ''
+ defaultValue:
+ '@path': $.event
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: mkuv3KRq87ZZovDmtUJQJV
+ sortOrder: 1
+ fieldKey: userId
+ label: User ID
+ type: STRING
+ description: An unique identifier for the user
+ placeholder: ''
+ defaultValue:
+ '@path': $.userId
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: wavcfKXR7NhpxtjjnJut3t
+ sortOrder: 2
+ fieldKey: anonymousId
+ label: Anonymous ID
+ type: STRING
+ description: Anonymous ID for users
+ placeholder: ''
+ defaultValue:
+ '@path': $.anonymousId
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: jqWF1B2dy4ReiohP9rNmpx
+ sortOrder: 3
+ fieldKey: audienceId
+ label: Audience ID
+ type: STRING
+ description: Segment's audience ID
+ placeholder: ''
+ defaultValue:
+ '@path': $.properties.audience_key
+ required: true
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
presets:
- actionId: RzH8WC76wNx7K29zxPQkQ
name: Sync Audience
diff --git a/src/_data/catalog/destinations_private.yml b/src/_data/catalog/destinations_private.yml
index 9e23b10e00..031a10d090 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-01-25
+# destination data last updated 2024-01-30
items:
- id: 54521fd725e721e32a72eec6
display_name: Intercom
@@ -1599,84 +1599,86 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: oPWRb2J53D99hbWYZe8CAo
- name: Page
- slug: page
- description: Send pageview events to Usermaven.
+ - id: qg6REVpUrbDEyU9oS6M9nZ
+ name: Group
+ slug: group
+ description: Send company attributes to Usermaven.
platform: CLOUD
hidden: false
defaultTrigger: null
fields:
- - id: gqKuCczrypPscaZDsbd1Xb
+ - id: sh3owu8c1aCPoYEJjfv2Qo
sortOrder: 0
- fieldKey: user_id
- label: User id
+ fieldKey: company_id
+ label: Company id
type: STRING
- description: The user id, to uniquely identify the user
+ description: The company id, to uniquely identify the company
placeholder: ''
defaultValue:
- '@path': $.userId
- required: false
+ '@path': $.groupId
+ required: true
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: dvRSNK2pXM7EcLbeVqg9sE
+ - id: wPa3KGt7kqYvKsbtoC9qqC
sortOrder: 1
- fieldKey: user_email
- label: Email address
+ fieldKey: user_id
+ label: User id
type: STRING
- description: The user email address
+ description: The user id, to uniquely identify the user
placeholder: ''
defaultValue:
- '@if':
- exists:
- '@path': $.properties.email
- then:
- '@path': $.properties.email
- else:
- '@path': $.context.traits.email
- required: false
+ '@path': $.userId
+ required: true
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: c9pMdDurL25jq8xLPuo3R4
+ - id: wKq54EoNb2N8nQRgeRUa2r
sortOrder: 2
- fieldKey: user_created_at
- label: Created at
+ fieldKey: company_name
+ label: Company name
type: STRING
- description: The timestamp when the user was created
+ description: The company name
placeholder: ''
defaultValue:
- '@if':
- exists:
- '@path': $.properties.created_at
- then:
- '@path': $.properties.created_at
- else:
- '@path': $.context.traits.created_at
+ '@path': $.traits.name
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: cRw19qoPZAH9YDxbedBAys
+ - id: 9aansDTgo4axVtxDwYtGUb
sortOrder: 3
- fieldKey: page_name
- label: Page Name
+ fieldKey: company_created_at
+ label: Company created at
type: STRING
- description: The name of the page
+ description: The timestamp when the company was created
placeholder: ''
defaultValue:
- '@path': $.properties.name
+ '@path': $.traits.created_at
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: jT1j6YiJx3T9uAg95iJAXc
+ - id: 8RChgfe4udobJ53NFPk2ny
sortOrder: 4
+ fieldKey: company_custom_attributes
+ label: Company custom attributes
+ type: OBJECT
+ description: The company custom attributes
+ placeholder: ''
+ defaultValue:
+ '@path': $.traits
+ required: false
+ multiple: false
+ choices: null
+ dynamic: false
+ allowNull: false
+ - id: fkEU3emnuTBgQNqz197Pbf
+ sortOrder: 5
fieldKey: user_anonymous_id
label: Anonymous ID
type: STRING
@@ -1689,8 +1691,8 @@ items:
choices: null
dynamic: false
allowNull: true
- - id: pZnPSTHCrjMUmaQdbZeVHN
- sortOrder: 5
+ - id: b8Grxf47tgaymCrFYxdKC2
+ sortOrder: 6
fieldKey: event_id
label: Event ID
type: STRING
@@ -1703,8 +1705,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: skBwtvoErnzcFnQmboKrwo
- sortOrder: 6
+ - id: tqeBxjh5tygVJxcuNQap6W
+ sortOrder: 7
fieldKey: doc_path
label: Document Path
type: STRING
@@ -1717,8 +1719,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 7E4LnrCaYRLDrJuFoKn7cC
- sortOrder: 7
+ - id: n1tz8y7Vk7eHkCqVGqDqpG
+ sortOrder: 8
fieldKey: doc_search
label: Document Search
type: STRING
@@ -1731,8 +1733,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: sXbG92qvkcVENkJBWbnGo3
- sortOrder: 8
+ - id: 8SzzyK4YJSXmYD677x48YY
+ sortOrder: 9
fieldKey: event_type
label: Event Type
type: STRING
@@ -1745,8 +1747,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 6JerdPkPH9F2zzLRasmGVa
- sortOrder: 9
+ - id: ir8k3oeMxfwZ1qCxfL1A78
+ sortOrder: 10
fieldKey: page_title
label: Page Title
type: STRING
@@ -1759,8 +1761,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: h6Z5GRoMSJ3f9ekh8apmP9
- sortOrder: 10
+ - id: 6vjReNP8CS37MuVw4aQxje
+ sortOrder: 11
fieldKey: referer
label: Referrer
type: STRING
@@ -1773,8 +1775,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 9ACL7AHihYvUzV7jjGyM5C
- sortOrder: 11
+ - id: uoPEkMnNAsiUiUh2kbkzR8
+ sortOrder: 12
fieldKey: url
label: URL
type: STRING
@@ -1787,8 +1789,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 96Lhr6inykPkBs5Z8TiBK5
- sortOrder: 12
+ - id: qEtNvAsLT7XoZNX4NYQse2
+ sortOrder: 13
fieldKey: user_agent
label: User Agent
type: STRING
@@ -1801,8 +1803,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: hNXpSEx4eYjkQXWEdyMFRs
- sortOrder: 13
+ - id: 6fhugx5B84z4Lx6SkXfKor
+ sortOrder: 14
fieldKey: user_language
label: User Language
type: STRING
@@ -1815,8 +1817,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 2oyfB4ayAtYWU7mqinnroE
- sortOrder: 14
+ - id: gYvqqhf4iMwgN185B3hMuX
+ sortOrder: 15
fieldKey: utc_time
label: UTC Time
type: STRING
@@ -1829,8 +1831,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: kwdo9Ea2DtACznKXLSmU5X
- sortOrder: 15
+ - id: oxT7SYKvLMN424Wdz1x1sM
+ sortOrder: 16
fieldKey: utm
label: UTM
type: OBJECT
@@ -1852,8 +1854,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: vwR6kCrJqg64iBJo3egnEy
- sortOrder: 16
+ - id: 3ust1dkkdzvtshCbBcYhBW
+ sortOrder: 17
fieldKey: screen
label: Screen
type: OBJECT
@@ -1871,8 +1873,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: kcouWQ4RcRwB7Vzqb9ZDPw
- sortOrder: 17
+ - id: sjvgwBKB9iKWykF7EwmWyd
+ sortOrder: 18
fieldKey: timezone
label: Timezone
type: STRING
@@ -1891,8 +1893,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: kNpF1HohXZH2FMnA7kJrKa
- sortOrder: 18
+ - id: fyADYUMXK7L4G6ZcrKXTBg
+ sortOrder: 19
fieldKey: source_ip
label: IP Address
type: STRING
@@ -1905,30 +1907,16 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: qg6REVpUrbDEyU9oS6M9nZ
- name: Group
- slug: group
- description: Send company attributes to Usermaven.
+ - id: oPWRb2J53D99hbWYZe8CAo
+ name: Page
+ slug: page
+ description: Send pageview events to Usermaven.
platform: CLOUD
hidden: false
defaultTrigger: null
fields:
- - id: sh3owu8c1aCPoYEJjfv2Qo
+ - id: gqKuCczrypPscaZDsbd1Xb
sortOrder: 0
- fieldKey: company_id
- label: Company id
- type: STRING
- description: The company id, to uniquely identify the company
- placeholder: ''
- defaultValue:
- '@path': $.groupId
- required: true
- multiple: false
- choices: null
- dynamic: false
- allowNull: false
- - id: wPa3KGt7kqYvKsbtoC9qqC
- sortOrder: 1
fieldKey: user_id
label: User id
type: STRING
@@ -1936,55 +1924,67 @@ items:
placeholder: ''
defaultValue:
'@path': $.userId
- required: true
+ required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: wKq54EoNb2N8nQRgeRUa2r
- sortOrder: 2
- fieldKey: company_name
- label: Company name
+ - id: dvRSNK2pXM7EcLbeVqg9sE
+ sortOrder: 1
+ fieldKey: user_email
+ label: Email address
type: STRING
- description: The company name
+ description: The user email address
placeholder: ''
defaultValue:
- '@path': $.traits.name
+ '@if':
+ exists:
+ '@path': $.properties.email
+ then:
+ '@path': $.properties.email
+ else:
+ '@path': $.context.traits.email
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: 9aansDTgo4axVtxDwYtGUb
- sortOrder: 3
- fieldKey: company_created_at
- label: Company created at
+ - id: c9pMdDurL25jq8xLPuo3R4
+ sortOrder: 2
+ fieldKey: user_created_at
+ label: Created at
type: STRING
- description: The timestamp when the company was created
+ description: The timestamp when the user was created
placeholder: ''
defaultValue:
- '@path': $.traits.created_at
+ '@if':
+ exists:
+ '@path': $.properties.created_at
+ then:
+ '@path': $.properties.created_at
+ else:
+ '@path': $.context.traits.created_at
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: 8RChgfe4udobJ53NFPk2ny
- sortOrder: 4
- fieldKey: company_custom_attributes
- label: Company custom attributes
- type: OBJECT
- description: The company custom attributes
+ - id: cRw19qoPZAH9YDxbedBAys
+ sortOrder: 3
+ fieldKey: page_name
+ label: Page Name
+ type: STRING
+ description: The name of the page
placeholder: ''
defaultValue:
- '@path': $.traits
+ '@path': $.properties.name
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- - id: fkEU3emnuTBgQNqz197Pbf
- sortOrder: 5
+ - id: jT1j6YiJx3T9uAg95iJAXc
+ sortOrder: 4
fieldKey: user_anonymous_id
label: Anonymous ID
type: STRING
@@ -1997,8 +1997,8 @@ items:
choices: null
dynamic: false
allowNull: true
- - id: b8Grxf47tgaymCrFYxdKC2
- sortOrder: 6
+ - id: pZnPSTHCrjMUmaQdbZeVHN
+ sortOrder: 5
fieldKey: event_id
label: Event ID
type: STRING
@@ -2011,8 +2011,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: tqeBxjh5tygVJxcuNQap6W
- sortOrder: 7
+ - id: skBwtvoErnzcFnQmboKrwo
+ sortOrder: 6
fieldKey: doc_path
label: Document Path
type: STRING
@@ -2025,8 +2025,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: n1tz8y7Vk7eHkCqVGqDqpG
- sortOrder: 8
+ - id: 7E4LnrCaYRLDrJuFoKn7cC
+ sortOrder: 7
fieldKey: doc_search
label: Document Search
type: STRING
@@ -2039,8 +2039,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 8SzzyK4YJSXmYD677x48YY
- sortOrder: 9
+ - id: sXbG92qvkcVENkJBWbnGo3
+ sortOrder: 8
fieldKey: event_type
label: Event Type
type: STRING
@@ -2053,8 +2053,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: ir8k3oeMxfwZ1qCxfL1A78
- sortOrder: 10
+ - id: 6JerdPkPH9F2zzLRasmGVa
+ sortOrder: 9
fieldKey: page_title
label: Page Title
type: STRING
@@ -2067,8 +2067,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 6vjReNP8CS37MuVw4aQxje
- sortOrder: 11
+ - id: h6Z5GRoMSJ3f9ekh8apmP9
+ sortOrder: 10
fieldKey: referer
label: Referrer
type: STRING
@@ -2081,8 +2081,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: uoPEkMnNAsiUiUh2kbkzR8
- sortOrder: 12
+ - id: 9ACL7AHihYvUzV7jjGyM5C
+ sortOrder: 11
fieldKey: url
label: URL
type: STRING
@@ -2095,8 +2095,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: qEtNvAsLT7XoZNX4NYQse2
- sortOrder: 13
+ - id: 96Lhr6inykPkBs5Z8TiBK5
+ sortOrder: 12
fieldKey: user_agent
label: User Agent
type: STRING
@@ -2109,8 +2109,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 6fhugx5B84z4Lx6SkXfKor
- sortOrder: 14
+ - id: hNXpSEx4eYjkQXWEdyMFRs
+ sortOrder: 13
fieldKey: user_language
label: User Language
type: STRING
@@ -2123,8 +2123,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: gYvqqhf4iMwgN185B3hMuX
- sortOrder: 15
+ - id: 2oyfB4ayAtYWU7mqinnroE
+ sortOrder: 14
fieldKey: utc_time
label: UTC Time
type: STRING
@@ -2137,8 +2137,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: oxT7SYKvLMN424Wdz1x1sM
- sortOrder: 16
+ - id: kwdo9Ea2DtACznKXLSmU5X
+ sortOrder: 15
fieldKey: utm
label: UTM
type: OBJECT
@@ -2160,8 +2160,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: 3ust1dkkdzvtshCbBcYhBW
- sortOrder: 17
+ - id: vwR6kCrJqg64iBJo3egnEy
+ sortOrder: 16
fieldKey: screen
label: Screen
type: OBJECT
@@ -2179,8 +2179,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: sjvgwBKB9iKWykF7EwmWyd
- sortOrder: 18
+ - id: kcouWQ4RcRwB7Vzqb9ZDPw
+ sortOrder: 17
fieldKey: timezone
label: Timezone
type: STRING
@@ -2199,8 +2199,8 @@ items:
choices: null
dynamic: false
allowNull: false
- - id: fyADYUMXK7L4G6ZcrKXTBg
- sortOrder: 19
+ - id: kNpF1HohXZH2FMnA7kJrKa
+ sortOrder: 18
fieldKey: source_ip
label: IP Address
type: STRING
diff --git a/src/_data/catalog/regional-supported.yml b/src/_data/catalog/regional-supported.yml
index 213237a2ae..77c6947081 100644
--- a/src/_data/catalog/regional-supported.yml
+++ b/src/_data/catalog/regional-supported.yml
@@ -773,6 +773,15 @@ sources:
- us
endpoints:
- us
+ - id: P1kUrzj9pv
+ display_name: RateHighly
+ hidden: true
+ slug: ratehighly
+ url: connections/sources/catalog/cloud-apps/ratehighly
+ regions:
+ - us
+ endpoints:
+ - us
- id: B0X0QmvMny
display_name: React Native
hidden: false
@@ -922,6 +931,15 @@ sources:
endpoints:
- us
- eu
+ - id: di2sOHoscX
+ display_name: SurveySparrow
+ hidden: true
+ slug: surveysparrow
+ url: connections/sources/catalog/cloud-apps/surveysparrow
+ regions:
+ - us
+ endpoints:
+ - us
- id: 43bb279b7
display_name: Twilio
hidden: false
diff --git a/src/_data/catalog/source_categories.yml b/src/_data/catalog/source_categories.yml
index 9d1b486fb6..d0788a35db 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-01-25
+# source categories last updated 2024-01-30
items:
- display_name: A/B Testing
slug: a-b-testing
@@ -31,6 +31,8 @@ items:
slug: marketing-automation
- display_name: Mobile
slug: mobile
+ - display_name: Object Destination
+ slug: object-destination
- display_name: Ott
slug: ott
- display_name: Payments
diff --git a/src/_data/catalog/sources.yml b/src/_data/catalog/sources.yml
index 7e2ec9310e..d9689f2be4 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-01-25
+# sources last updated 2024-01-30
items:
- id: 8HWbgPTt3k
display_name: .NET
@@ -1602,6 +1602,24 @@ items:
url: https://cdn.filepicker.io/api/file/uuJxztQ2QjuSQEyrCNfj
categories:
- Enrichment
+ - id: P1kUrzj9pv
+ display_name: RateHighly
+ isCloudEventSource: true
+ slug: ratehighly
+ url: connections/sources/catalog/cloud-apps/ratehighly
+ hidden: true
+ regions:
+ - us
+ endpoints:
+ - us
+ source_type: cloud-app
+ description: Collect reviews and generate demand
+ logo:
+ url: >-
+ https://cdn-devcenter.segment.com/c7581fde-a6ab-4690-845e-ef8f4647305e.svg
+ categories:
+ - Marketing Automation
+ - Surveys
- id: B0X0QmvMny
display_name: React Native
isCloudEventSource: false
@@ -1739,6 +1757,7 @@ items:
url: https://d3hotuclm6if1r.cloudfront.net/logos/salesforce-default.svg
categories:
- CRM
+ - Object Destination
- id: oQ5dZPW0Ii
display_name: Salesforce Marketing Cloud
isCloudEventSource: false
@@ -1896,6 +1915,24 @@ items:
url: https://cdn.filepicker.io/api/file/jp2UV0RtRU2FZaGxX4qF
categories:
- Payments
+ - id: di2sOHoscX
+ display_name: SurveySparrow
+ isCloudEventSource: true
+ slug: surveysparrow
+ url: connections/sources/catalog/cloud-apps/surveysparrow
+ hidden: true
+ regions:
+ - us
+ endpoints:
+ - us
+ source_type: cloud-app
+ description: Seamless Surveys Meet Powerful Analytics
+ logo:
+ url: >-
+ https://cdn-devcenter.segment.com/278e564b-13e9-4a4a-bb10-7ff8b1aadee2.svg
+ categories:
+ - Surveys
+ - Customer Success
- id: 43bb279b7
display_name: Twilio
isCloudEventSource: false
diff --git a/src/connections/destinations/catalog/actions-display-video-360/index.md b/src/connections/destinations/catalog/actions-display-video-360/index.md
new file mode 100644
index 0000000000..e54ddf0f5b
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-display-video-360/index.md
@@ -0,0 +1,223 @@
+---
+title: Display and Video 360 (Actions) Destination
+strat: google
+hide-settings: true
+id: 65302a3acb309a8a3d5593f2
+beta: true
+---
+
+> info ""
+> Display and Video 360 (Actions) operates using third-party cookies, and its match rates are influenced by the extent to which these cookies are supported by browsers.
+
+Google's [Display & Video (DV360)](https://marketingplatform.google.com/about/display-video-360/){:target="_blank"} service is an end-to-end campaign management tool that enables enterprise customers to plan, measure, and run display and video advertisements.
+
+> info ""
+> You can connect to a Google Ad Manager account. For more information, see [4. Create an audience and finish DV360 configuration](#4-create-an-audience-and-finish-dv360-configuration) below. Set **User-Role Granted** to `Publisher` if you plan to connect to Google Ad Manager.
+
+Segment's integration with DV360 enables Segment customers to sync audiences created in Engage with DV360 for centralized audience management and improved retargeting.
+
+> warning ""
+> You must meet certain implementation criteria to use the DV360 integration:
+> - For web traffic, you must have a client-side `analytics.js` source.
+> - For mobile app traffic, you must have a mobile source.
+
+> info ""
+> Since the release of `analytics-ios` version 4, Segment no longer collects IDFA automatically. To collect and pass IDFA to your DV360 integration, follow the steps for Ad Tracking and IDFA in the [Analytics-iOS mobile source](/docs/connections/sources/catalog/libraries/mobile/ios#ad-tracking-and-idfa) documentation.
+
+## Details
+
+> info ""
+> For users detected to originate from US states with privacy restrictions, using a Google User ID to populate user lists is deprecated, and will be eventually sunset. It's recommended that bidders populate user lists with their hosted match data for these users.
+
+Keep the following settings and requirements in mind as you set up your DV360 (Actions) Destination.
+
+- **Audience appears as**: An audience list with the name of your Engage Audience on the **DV360 All Audiences** screen
+- **Destination rate limit**: None
+- **Lookback window allowed**: 30 days
+- **Historical backfill supported**: No
+- **Identifiers required (one of the following)**:
+ - `idfa` (iOS)
+ - `advertisingId` (Android)
+ - `anonymousId` (Web)
+- **Connection type**:
+ - Client-side (DoubleClick Floodlight)
+ - Server-side (DV360)
+- **Aliasing supported**: No
+
+- **Requirements**:
+ - Business tier Segment customers with Engage
+ - One of the following sources, depending on type:
+ - For web: analytics.js
+ - For mobile app: a mobile source that passes an advertising identifier
+ - A Google Marketing Platform account
+
+## Components
+
+The Segment DV360 integration uses two components, the [DoubleClick Floodlight tag](/docs/connections/destinations/catalog/doubleclick-floodlight/) and Display & Video 360 (Actions) integration.
+
+### DoubleClick Floodlight tag
+
+Segment users must add this tag to their web properties. The tag performs several functions, but when enabled for the DV360 integration, it allows Segment to send information about users directly to Google client-side.
+
+> info ""
+> This component is required only if you want to sync audiences based on web traffic.
+
+### DV360 destination
+
+The DV360 Destination syncs audience data between Segment and Google Display & Video 360. For more information about enabling the DV360 Destination, [view the setup instructions below](#set-up) below.
+
+## Set up the DV360 Destination
+
+Configuring this integration requires action by both you in your Segment workspace, and Google in your Google Marketing Platform account. As a result, the time required to finish configuration and setup can vary.
+
+### Configure client integration for web traffic
+
+> info ""
+> This step is necessary only if you want to use Google User IDs to build audiences based on website traffic. If you plan to use mobile identifiers only, continue to [Enable and configure the DV360 Destination](enable-and-configure-the-dv360-destination).
+
+Segment requires the [DoubleClick Floodlight](/docs/connections/destinations/catalog/doubleclick-floodlight/) tag on your website to enable the creation of audiences based on website traffic. This allows Segment to send Google the appropriate identifier (typically `anonymousId`) for users that are in an audience. Google stores these identifiers on its servers and matches them against `google_id`.
+
+To configure DoubleClick Floodlight:
+
+> warning ""
+> **Prerequisite**: Create a [JavaScript Website](/docs/connections/sources/catalog/libraries/website/javascript/) source in your Segment workspace if one does not exist. Ensure that this source is configured to track visitors to your website. For more information about configuring Javascript sources, see the [Analytics.js Quickstart guide](/docs/connections/sources/catalog/libraries/website/javascript/quickstart/).
+
+1. In your workspace, visit the **Catalog** and search for the **DoubleClick Floodlight** Destination.
+2. Connect your JavaScript website source to the DoubleClick Floodlight destination, and configure the following settings:
+ 1. **Get DoubleClickID**: `On`
+ 2. **Google Network Id**: `segment`
+ 3. Your [Segment write key](/docs/connections/find-writekey/). You can retrieve your write key from the Settings tab in the source.
+ 4. **DoubleClick Advertiser ID**
+ - If you use DoubleClick Floodlight for DV360 only, enter `DV360`.
+ - If you use DoubleClick Floodlight for other use cases in addition to DV360, enter the Advertiser ID from your Doubleclick Floodlight account.
+3. Switch the toggle to enable the destination.
+
+### Enable and configure the DV360 Destination
+
+1. From your Segment workspace, navigate to **Engage > Engage Settings > Destinations > Add Destination**, then search for **Display and Video 360 (Actions)**.
+2. Authenticate using OAuth.
+3. Switch the toggle to enable the destination.
+4. Navigate to the **Mappings** tab, click **Add Mapping** and select **Add to Audience**.
+5. Click **Save** and make sure to enable the mapping.
+6. On the **Mappings** tab, click **Add Mapping** and select **Remove from Audience**.
+7. Click **Save** and make sure you enable the mapping.
+
+> info ""
+> The destination does not have configurable settings until you create an audience, described [here](#create-an-audience-and-finish-dv360-configuration).
+
+### Create an audience and finish DV360 configuration
+
+[Create an audience](/docs/personas/audiences) in a new or existing Engage space. After you create the audience, you can select the Display & Video 360 (Actions) Destination you created before.
+
+> info ""
+> These settings are tied to a single audience. Each additional audience you send to DV360 requires you to input these values.
+
+When you select the destination, you're prompted to enter the destination settings:
+
+| Setting | Description |
+| ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Account Type | The type of DV360 account used to sync. Either `Advertiser`, `Partner`, or `Publisher`. **Note:** Select `Publisher` only if you plan to connect to Google Ad Manager. |
+| Advertiser ID | The ID of your DV360 Advertiser account. Can be found in your Google Account under **Advertiser Settings > Basic Details > Advertiser ID**. |
+
+You'll also need to toggle on the Send Track setting.
+
+
+After you complete the set up process, allow up to 24 hours for Google to create the new audience list. Once the list is created, Segment can begin to sync users to that list. Google may require additional time to process the initial audience additions. The entire first sync to DV360 may require 24-48 hours to complete. As a result, the first few audience syncs after you create the audience may fail.
+
+{% include content/sync-frequency-note.md %}
+
+## Migrate from Personas Google Display & Video 360 Destination
+
+Segment will copy all of your existing Personas Display & Video 360 Destination configurations to Display and Video 360 (Actions). Once the migration is completed , you will be notified by email.
+
+The sole mandatory action involves **re-authenticating** for each migrated Personans Display & Video 360 Destination. While you may already possess OAuth credentials, it is essential to undergo reauthentication. This step is necessary to seamlessly integrate new audiences or implement updates to existing ones.
+
+Segment is disabling all existing Personas Display and Video 360 destinations. You can still access your existing configuration, but please refrain from enabling the destination, as it is set to be deprecated. You will no longer be able to create new instances of Personas Display and Video 360.
+
+
+
+
+## FAQ
+### What is Segment's relationship with Google DV360 and is the data that Segment sends considered to be First or Third party?
+
+Google considers Segment to be a DMP or Data Onboarder. Audience information pushed from Segment to your DV360 account is considered to be **First-Party** data.
+
+
+### When will my data appear in DV360?
+
+When you complete the connection between Segment and DV360, it can take from 24 to 48 hours for Google to create the user list. This must complete before Segment can begin to sync users into that list.
+
+
+### What identifiers are needed to enable this integration?
+
+Google's [documentation](https://developers.google.com/authorized-buyers/rtb/downloads/cookie-bulk-upload-proto){:target="_blank"} provides information about the accepted identifiers for this integration.
+
+
+- To use DV360 with web traffic, you must collect `anonymous_id` through the client-side `analytics.js` source.
+- To use DV360 with mobile traffic, you must collect `IDFA`s through Segment's mobile sources.
+
+
+### Why is my audience in DV360 smaller than the audience that I see in Engage? What affects match rates?
+
+Match rates may differ between Engage and DV360 for the following reasons:
+
+#### Go-forward data
+
+When you first preview and create an audience in Engage, the audience may contain many audience members. This is more likely if you select the **Historical Backfill** option. This does not reflect the audience that syncs to DV360 for the following reasons:
+
+
+1. During an audience sync, Segment sends a list of `anon_id` values to Google. Google attempts to match those values in their match table, to find an associated `google_user_id`.
+2. To complete this lookup, Google must have both the `anon_id` and have it store along side a matched `google_user_id`. This occurs when a user visits your website with both the Doubleclick Floodlight tag installed, and the DV360 integration completed.
+
+As a result, you must have Doubleclick Floodlight and the DV360 integration in place before Google can match users and make them available for retargeting.
+
+To help reduce the difference between Engage and DV360 audience sizes, Segment recommends that you deselect the `Historical Backfill` option when you create the audience that syncs to DV360.
+
+#### Impact to third-party cookies: browser policies
+
+The DV360 integration for web traffic relies on Doubleclick Floodlight, which itself relies on a `google_user_id` cookie. While this cookie is “yours”, browsers treat this as a third-party cookie because it is served from Google's servers, and not the same domain as your website. As browsers become more privacy-oriented, they block third-party cookies by default.
+
+Users who visit your website in Firefox and Safari, and who do not specifically allow third-party cookies, are not identifiable by Doubleclick Floodlight (`google_user_id`). This prevents Google from identifying a match between an `anon_id` sent from Segment, and results in lower match rates.
+
+#### Impact to third-party cookies: adblockers
+
+All browser-based adblocking software intentionally blocks most third-party cookies, including the Doubleclick Floodlight cookie necessary for identification. As a result, Google cannot match users who employ adblocking software in their browsers.
+
+#### IDFA impact: recent Apple announcements
+
+Apple has announced an updated privacy policy that, while not rolled out yet, impacts the way businesses collect IDFA data. When enacted, this privacy policy will significantly reduce the percentage of users for which IDFA data is collected. This change will result in lower match rates, as both Segment and Google will see a decline in the number of IDFA values sent by Segment, and matched by Google.
+
+#### Invalid Google IDs
+
+Sometimes, Google denies IDFA or `google_user_id` values when they consider them to be invalid or inactive.
+
+#### Modifying list configuration in DV360
+
+Any changes to a DV360 list's configuration (for example, modifying the membership expiration from 540 days to a value that matches the time window on the audience) is **very risky** and **will likely** cause mismatches between Engage audiences and the lists in Google. Segment ensures that the integration works successfully only if there are no changes made to the configurations in DV360. DV360 lists are created with parameters that are known to be compatible with Engage. Configurations that differ from Segment's can cause mismatches by removing more users than intended, or by not accepting valid uploads.
+
+
+### Why is the audience size larger in DV360 than in Engage?
+
+Engage syncs every IDFA or `anonymous_id` value for each user in an audience. When DV360 receives this data, it does not de-duplicate in the event that multiple identifiers map to the same unique user. This may result in a larger audience list in Google compared to Engage.
+
+
+### Why don't I see matches in DV360?
+
+The most common cause of matches not appearing in DV360 is an error with Doubleclick Floodlight. From the website where tracking is enabled, open the Network inspector, and confirm that outgoing requests to `idsync.segment.com` appear.
+
+
+### How does third-party cookie eradication impact the DV360 Destination?
+
+Google Chrome has committed to replacing third-party cookies with an alternative, but has not announced a timeframe for that alternative. Segment will not update this integration until these updates from Google are announced.
+
+
+### Can I use Engage audiences to target YouTube ads with this integration?
+
+No. YouTube (through DV360) does not support the type of lists that Segment provides.
+
+### Why do I see destination settings after I add my audience, but not when I first enable the destination?
+
+The DV360 Destination works on a per-audience basis. This enables you to:
+
+- Send data from different audiences to different DV360 accounts.
+- Send data to Google Ad Manager with the same destination.
diff --git a/src/connections/destinations/catalog/actions-equals/index.md b/src/connections/destinations/catalog/actions-equals/index.md
new file mode 100644
index 0000000000..4416280fde
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-equals/index.md
@@ -0,0 +1,33 @@
+---
+title: Equals Destination
+beta: true
+id: 659eb6903c4d201ebd9e2f5c
+---
+
+{% include content/plan-grid.md name="actions" %}
+
+[Equals](https://equals.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is the only spreadsheet with built-in connections to any database, versioning, and collaboration. Connect your Segment data to Equals and build dashboards or your revenue reports, CAC/LTV analyses, top of funnel conversions, and more based on live data.
+
+This destination is maintained by Equals. For any issues with the destination, [contact their Support team](mailto:help@equals.com).
+
+Equals enables anyone, regardless of technical ability, to set up live dashboards and reports that push to Slack, email or Google Slides directly from live Segment event data.
+
+## Getting started
+
+Follow the instructions below, or on [Equals' Segment Connection Guide](https://help.equals.com/en/articles/8688872-segment-connection-guide){:target="_blank”} to get started.
+Note that Segment is an Enterprise Connection; you will be prompted to schedule a call with an Equals team member after step 2 in the instructions below.
+
+1. Use your Email Address to sign in to [Equals](https://go.equals.com){:target="_blank”}.
+2. Navigate to the [Data Sources page](https://go.equals.com/datasources/new){:target="_blank”}, then select 'Segment'.
+3. Click the 'Connect to Segment' button.
+4. On the popup screen, copy the URL. It will be used in a later step.
+5. Click the Save button on the popup, then click the Save button on the Equals page.
+6. From your Segment workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for "Equals".
+7. Select Equals and click **Add Destination**.
+8. Select an existing Source to connect to Equals.
+9. Name your Destination.
+10. On the Destination's Settings page, paste in the Equals URL from step 4 then turn on the 'Enable Destination' using the toggle.
+11. Click the Save Changes button.
+12. Optionally, to configure the data to be sent to Segment, navigate to the Mappings tab and edit the 'Send' Mapping.
+
+{% include components/actions-fields.html %}
\ No newline at end of file
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 959270aa53..54b7c8ed19 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
@@ -95,6 +95,8 @@ The **Set Configuration Fields** mapping is required for data to be sent downstr
If you are sending multiple `config` commands that your Google Tag has to account for, you may see duplicate `page_view` events in your Analytics workspace. If this is the case, please refer to Google's documentation on [Ignoring duplicate instances of on-page configuration](https://support.google.com/analytics/answer/9973999?hl=en#:~:text=as%20described%20below.-,Ignore%20duplicate%20instances%20of%20on%2Dpage%20configuration,Click%20Save.,-Give%20feedback%20about){:target="_blank"}.
+If you are manually sending `page_view` events, disable **Page changes based on browser history events** under the advanced settings of the **pageviews** section to avoid double counting pageviews on history state changes. More in Google's documentation on [Manual Pageviews](https://developers.google.com/analytics/devguides/collection/ga4/views?client_type=gtag#manual_pageviews){:target="_blank"}.
+
### Manually send `page_view` events
If you prefer to keep the **Page Views** setting disabled and manually send a `page_view`, please see this Google Doc for more on [Manual Pageviews](https://developers.google.com/analytics/devguides/collection/ga4/views?client_type=gtag#manually_send_page_view_events).
diff --git a/src/connections/destinations/catalog/actions-qualtrics/index.md b/src/connections/destinations/catalog/actions-qualtrics/index.md
index f0c9ec8e6e..3b14967b9a 100644
--- a/src/connections/destinations/catalog/actions-qualtrics/index.md
+++ b/src/connections/destinations/catalog/actions-qualtrics/index.md
@@ -24,6 +24,11 @@ Qualtrics (Actions) provides the following benefits:
+### Limitations
+The Qualtrics destination is only available to customers on a Business Tier plan with Segment.
+
+To link your Qualtrics destination in Segment to your Qualtrics workspace, [Qualtrics](https://www.qualtrics.com/support/integrations/twilio-segment/twilio-segment-task/){:target="_blank"} requires a [Segment Token](https://app.segment.com/goto-my-workspace/settings/access-management/tokens){:target="_blank"} that can only be generated by Business Tier customers who have access to the [Public API](https://segment.com/docs/api/public-api/){:target="_blank"}.
+
## Getting started
1. From the Segment web app, click **Catalog**, then click **Destinations**.
diff --git a/src/connections/destinations/catalog/actions-surveysparrow/index.md b/src/connections/destinations/catalog/actions-surveysparrow/index.md
new file mode 100644
index 0000000000..73f2ca53c4
--- /dev/null
+++ b/src/connections/destinations/catalog/actions-surveysparrow/index.md
@@ -0,0 +1,22 @@
+---
+title: SurveySparrow (Actions) Destination
+hidden: true
+beta: true
+---
+{% include content/plan-grid.md name="actions" %}
+
+[SurveySparrow](https://surveysparrow.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} is an end-to-end omnichannel experience management platform that bundles Customer Experience and Employee Experience tools such as NPS, Offline, Chat, Classic, and 360 Surveys which are mobile-first, highly engaging, and user-friendly.
+
+This destination is maintained by SurveySparrow. For any issues with the destination, [contact their Support team](mailto:support@surveysparrow.com).
+
+## Getting started
+
+1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank"} search for "SurveySparrow"
+2. Select SurveySparrow and click **Add Destination**
+3. Select an existing Source to connect to SurveySparrow (Actions).
+4. Log in to your [SurveySparrow](https://app.surveysparrow.com/) account, then navigate to **Settings > Apps and Integrations > Create a Custom app**.
+5. Fill in the details for the custom app and choose **Select all** under Scope. Later, you can remove any scopes that are not required.
+6. Click **Save** and copy the **Access Token**.
+7. Enter the **Access Token** in the SurveySparrow destination settings in Segment.
+
+{% include components/actions-fields.html %}
\ No newline at end of file
diff --git a/src/connections/destinations/catalog/appsflyer/index.md b/src/connections/destinations/catalog/appsflyer/index.md
index 77b623561e..9fce94cd2f 100644
--- a/src/connections/destinations/catalog/appsflyer/index.md
+++ b/src/connections/destinations/catalog/appsflyer/index.md
@@ -14,8 +14,6 @@ Segment's Appsflyer destination code is open source and available on GitHub. You
## Getting Started
-
-
1. From the Segment web app, click **Catalog**.
2. Search for "AppsFlyer" in the Catalog, select it, and choose which of your sources to connect the destination to.
3. In the destination settings, enter your `AppsFlyer Dev Key`, which can be retrieved from the App Settings section of your AppsFlyer account.
@@ -154,6 +152,12 @@ All other `properties` will be sent to AppsFlyer as custom properties inside `ev
> info ""
> Be sure to calibrate/update the time window in AppsFlyer's dashboard to see your events!
+### Send in-app events to Appsflyer v3 Endpoint
+
+When transmitting data serverside to Appsflyer, you have the option to enhance security by enabling the transmission of in-app events to [Appsflyer's v3 endpoint](https://dev.appsflyer.com/hc/reference/s2s-events-api3-post){:target="_blank"}, which authenticates requests using a more secure [S2S token](https://support.appsflyer.com/hc/en-us/articles/360004562377-Managing-API-and-Server-to-server-S2S-tokens){:target="_blank"}.
+
+To activate this feature, simply input your S2S token in the destination settings and toggle the "Use API v3" switch to the enabled position.
+
## Install Attributed
### Client
diff --git a/src/connections/destinations/catalog/kustomer/index.md b/src/connections/destinations/catalog/kustomer/index.md
index 9bc9b47530..f316128aa6 100644
--- a/src/connections/destinations/catalog/kustomer/index.md
+++ b/src/connections/destinations/catalog/kustomer/index.md
@@ -1,6 +1,7 @@
---
title: Kustomer Destination
rewrite: true
+hide-personas-partial: true
id: 5c73feeb9947e900010a60ac
---
[Kustomer](https://www.kustomer.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is the next-generation customer management platform for the people-first enterprise. It enables support teams to get a holistic view of the customers they are engaging with, resulting in meaningful interactions between businesses and customers.
@@ -77,4 +78,8 @@ analytics.track("Registered", {
});
```
-Track calls will sent as a `tracking event` to Kustomer on the timeline of the customer who was tracked. If the `kustomer_session_id` is included, it will cluster this tracking event into a single "session" on the customer's timeline. If no `kustomer_session_id` is supplied, we will automatically generate session IDs based on time between tracking events. (Read why Segment doesn't have session tracking [here](https://segment.com/blog/facts-vs-stories-why-segment-has-no-sessions-api/){:target="_blank”}).
+Track calls send as a `tracking event` to Kustomer on the timeline of the customer who was tracked. If the `kustomer_session_id` is included, it clusters this tracking event into a single "session" on the customer's timeline. If no `kustomer_session_id` is supplied, Segment automatically generates session IDs based on time between tracking events. See why [Segment doesn't have session tracking](https://segment.com/blog/facts-vs-stories-why-segment-has-no-sessions-api/){:target="_blank”}.
+
+
+## Engage limitation
+The Kustomer destination only accepts standard properties such as name, email, and phone. It doesn't support custom properties. Any Audience or Computed Trait created in Engage is considered a customer property by Kustomer destination and isn't supported.
diff --git a/src/connections/destinations/catalog/personas-display-video-360/index.md b/src/connections/destinations/catalog/personas-display-video-360/index.md
index 7d83985f62..b875d6ae7c 100644
--- a/src/connections/destinations/catalog/personas-display-video-360/index.md
+++ b/src/connections/destinations/catalog/personas-display-video-360/index.md
@@ -4,6 +4,17 @@ strat: google
hide-settings: true
id: 5d4dd5b989eda01a09b5cdb1
---
+
+> warning "Deprecation Notice"
+> Due to Google retiring certain APIs on March 6, 2024, Segment is deprecating this destination. In February 2024, Segment will create an instance of the [Display and Video (Actions)](/docs/connections/destinations/catalog/actions-display-video-360/) destination for each version of the Personas Google Display and Video 360 classic destination in your workspace.
+>
+> Settings and configurations will be migrated automatically, but you must take additional action to ensure the destination is properly functioning. For more information, see [Migrate from Personas Google Display & Video 360 Destination ](/docs/connections/destinations/catalog/actions-display-video-360/#migrate-from-personas-google-display-&-video-360-destination)
+>
+> We are disabling all existing Personas Display and Video 360 destinations. You can still access your existing configuration, but please refrain from enabling the destination, as it is set to be deprecated. You will no longer be able to create new instances of Personas Display and Video 360. Please check out [Display and Video (Actions)](/docs/connections/destinations/catalog/actions-display-video-360/) to set up a new instance of Google Display and Video 360.
+>
+> For questions or issues contact [friends@segment.com](mailto:friends@segment.com).
+
+
Google's [Display & Video (DV360)](https://marketingplatform.google.com/about/display-video-360/){:target="_blank"} service is an end-to-end campaign management tool that enables enterprise customers to plan, measure, and run display and video advertisements.
> info ""
diff --git a/src/connections/destinations/catalog/repeater/index.md b/src/connections/destinations/catalog/repeater/index.md
index b8001dc267..7a8f807003 100644
--- a/src/connections/destinations/catalog/repeater/index.md
+++ b/src/connections/destinations/catalog/repeater/index.md
@@ -26,6 +26,14 @@ You can do this for as many sources as you need.
Repeater sends all events it receives to the sources you specified, identified by the write key(s) you added.
+## Replays with a Repeater destination
+
+Running a Replay on a Repeater destination might count toward your MTUs, especially if you are replaying historical data from the source that flows data into your Repeater destination.
+
+Because the API plans count by events sent through the pipeline and the Repeater destination resends an event through the entire pipeline, one event might flow through your source twice which increases the throughput count.
+
+Segment recommends that you notify your team before initiating a Replay if you’re using a Repeater destination.
+
## Repeater FAQ
##### What is the `context.repeatChain` field that I can see on my repeated events?
diff --git a/src/connections/rate-limits.md b/src/connections/rate-limits.md
index 7c4c215770..0c3895bc57 100644
--- a/src/connections/rate-limits.md
+++ b/src/connections/rate-limits.md
@@ -1,7 +1,7 @@
---
title: Product Limits
---
-These limits were updated on February 22, 2023.
+These limits were updated on January 25, 2024.
## Event properties ingestion limit
@@ -9,7 +9,7 @@ Events ingested by Segment have a limit of **10,000** properties per individual
## Inbound data ingestion API rate limit
-If any sources send more than 20,000 events per second in a workspace without prior arrangement, Segment reserves the right to queue any additional events and process those at a rate that doesn't exceed this limit. To request a higher limit, contact [Segment](mailto:friends@segment.com).
+If any sources send more than 1,000 events per second in a workspace without prior arrangement, Segment reserves the right to queue any additional events and process those at a rate that doesn't exceed this limit. To request a higher limit, contact [Segment](mailto:friends@segment.com).
> warning "Engage rate limit"
> Engage has a limit of 1,000 events per second for inbound data. Visit the [Engage Default Limits documentation](/docs/engage/product-limits/) to learn more.
diff --git a/src/connections/sources/about-cloud-sources.md b/src/connections/sources/about-cloud-sources.md
index 7594b66228..4678c3e96e 100644
--- a/src/connections/sources/about-cloud-sources.md
+++ b/src/connections/sources/about-cloud-sources.md
@@ -32,6 +32,8 @@ You enable a cloud source from the Segment web app, and grant Segment access by
Cloud sources attempt to use as few API calls as possible, and (where possible) only fetch data that changed since the last sync. The syncs might take a long time (especially on the first sync), so the cloud source syncs have robust retry and rate limiting logic.
+[Contact Segment Product Support](https://segment.com/help/contact) if you'd like to change the cadence of your source's sync frequency.
+
### API call use and collection selection
We make an effort to be respectful of your API call allotments and limits. For example, in the case of Salesforce, we issue only one query per collection per run, using the absolute minimum number of API calls possible (typically about 350/day).
diff --git a/src/connections/sources/catalog/cloud-apps/engage-events/index.md b/src/connections/sources/catalog/cloud-apps/engage-events/index.md
index 1d58071a57..d8c1dff601 100644
--- a/src/connections/sources/catalog/cloud-apps/engage-events/index.md
+++ b/src/connections/sources/catalog/cloud-apps/engage-events/index.md
@@ -14,7 +14,7 @@ Use the Engage Events Source to sync Engage subscription states and messaging ev
With Twilio Engage, you can [set and update user subscription states](/docs/engage/user-subscriptions/set-user-subscriptions/) with a [CSV file upload](/docs/engage/profiles/csv-upload/) or, programmatically, [using Segment APIs](/docs/engage/user-subscriptions/set-user-subscriptions/#manage-user-subscriptions-with-segment-apis).
-As part of Engage, Segment creates an Engage Events Source that lets you sync subscription states and marketing analytics events [to connected Destinations](/docs/connections/destinations/). When a subscription state changes, Segment sends an update to the Destination. As a result, the subscription states stored in your Destination(s) can serve as a single source of truth for managing user consent in other tools that you may have connected to the Destination.
+As part of Engage, Segment creates an Engage Events Source that lets you sync subscription states and marketing analytics events to [connected Destinations](/docs/connections/destinations/). When a subscription state changes, Segment sends an update to the Destination. As a result, the subscription states stored in your Destination(s) can serve as a single source of truth for managing user consent in other tools that you may have connected to the Destination.
## Working with Engage Events Sources
@@ -108,4 +108,13 @@ SendGrid powers Engage email delivery. For more information, view [SendGrid's Ev
| Group Subscription Updated | A user updated their subscription to a specific group. |
{% endfaqitem %}
+
+{% faqitem Journeys and Broadcast events %}
+
+| Event | Definition |
+| ---------------- | --------------------------------- |
+| Audience Entered | A user entered an Engage audience |
+
+{% endfaqitem %}
+
{% endfaq %}
\ No newline at end of file
diff --git a/src/connections/sources/catalog/cloud-apps/ratehighly/index.md b/src/connections/sources/catalog/cloud-apps/ratehighly/index.md
new file mode 100644
index 0000000000..6fb481e362
--- /dev/null
+++ b/src/connections/sources/catalog/cloud-apps/ratehighly/index.md
@@ -0,0 +1,67 @@
+---
+title: RateHighly Source
+id: P1kUrzj9pv
+beta: true
+hidden: true
+---
+
+[RateHighly](https://ratehighly.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} gets your most engaged users to review your application on G2 and Capterra, leveraging machine learning to predict user sentiment and request reviews.
+
+This is an [Event Cloud Source](/docs/sources/#event-cloud-sources) which can not only export data into your Segment warehouse, but can also federate the exported data into your other enabled Segment Destinations.
+
+This source is maintained by RateHighly. For any issues with the source, [contact their Support team](mailto:support@ratehighly.com).
+
+## Getting started
+
+1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog){:target="_blank”} click **Add Source**.
+2. Search for "RateHighly" in the Sources Catalog, select RateHighly, and click **Add Source**.
+3. On the next screen, give the Source a name configure any other settings.
+
+ - The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name can be anything, but we recommend using something that reflects the source itself (eg. RateHighly).
+
+4. Click **Add Source** to save your settings.
+5. Copy the Write key from the Segment UI.
+6. Log in to your RateHighly account - navigate to [Account > Integrations](https://ratehighly.com/dashboard/account/integrations) > Segment and paste the key to connect.
+
+## Stream
+
+RateHighly uses our stream Source component to send Segment event data. It uses server-side `track` and `identify` methods to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL.
+
+RateHighly will pass the provided user_id as the Segment userId, in addition to context and user details.
+
+## Events
+
+The table below lists events that RateHighly sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations. RateHighly includes the customer-provided `userId` with all events. The `userId` is user-provided string used when sending any event to RateHighly.
+
+| Event Name | Description |
+| ------------------ | -------------------------------------- |
+| User Created | User was detected by RateHighly |
+| Deemed Happy | User is qualified to review your app |
+| Messaged In-App | User was asked to review in-app |
+| Gave Rating | User gave a score in-app |
+| Skipped Rating | User closed the modal without scoring |
+| Gave Review | User shared a review on G2 or Capterra |
+| Gave Feedback | User wrote internal feedback |
+| Sent Email | User received a review request email |
+| Unsubscribed | User clicked an unsubscribe link |
+| Review Completed | User completed the review sequence |
+
+## Event properties
+
+The table below list the properties included in the events listed above.
+
+| Property Name | Description |
+| ----------------- | ------------------------- |
+| `event` | Event type |
+| `userId` | User ID |
+| `email` | User email |
+| `score` | User rating |
+| `predicted_score` | User predicted score |
+
+## Adding destinations
+
+Now that your Source is set up, you can connect it with Destinations.
+
+Log into your downstream tools and check to see that your events appear as expected, and that they contain all of the properties you expect. If your events and properties don’t appear, check the [Event Delivery](/docs/connections/event-delivery/) tool, and refer to the Destination docs for each tool for troubleshooting.
+
+If there are any issues with how the events are arriving to Segment, [contact the RateHighly support team](mailto:support@ratehighly.com).
diff --git a/src/connections/sources/catalog/cloud-apps/surveysparrow/index.md b/src/connections/sources/catalog/cloud-apps/surveysparrow/index.md
new file mode 100644
index 0000000000..21499f67ef
--- /dev/null
+++ b/src/connections/sources/catalog/cloud-apps/surveysparrow/index.md
@@ -0,0 +1,59 @@
+---
+title: SurveySparrow Source
+id: di2sOHoscX
+hidden: true
+beta: true
+---
+[SurveySparrow](https://surveysparrow.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} is an end-to-end omnichannel experience management platform that bundles Customer Experience and Employee Experience tools such as NPS, Offline, Chat, Classic, and 360 Surveys which are mobile-first, highly engaging, and user-friendly.
+
+This is an [Event Cloud Source](/docs/sources/#event-cloud-sources) which can not only export data into your Segment warehouse, but can also federate the exported data into your other enabled Segment Destinations.
+
+This source is maintained by SurveySparrow. For any issues with the source, [contact their Support team](mailto:support@surveysparrow.com).
+
+## Getting started
+
+1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog){:target="_blank"} click **Add Source**.
+2. Search for "SurveySparrow" in the Sources Catalog, select SurveySparrow, and click **Add Source**.
+3. On the next screen, give the Source a name, then configure any other settings.
+
+ - The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. SurveySparrow_Prod, SurveySparrow_Staging, SurveySparrow_Dev).
+
+4. Click **Add Source** to save your settings.
+5. Copy the Write key from the Segment UI.
+6. Log in to your SurveySparrow account - navigate to Settings > Apps and Integrations > Segment Source Integration and paste the Write key and select the Segment data processing region to connect.
+
+## Stream
+
+SurveySparrow uses our stream Source component to send Segment event data. It uses a server-side (`track`) method to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL.
+
+The default behavior is for SurveySparrow to pass the hash value of the email address and mobile number of the respondent as the `anonymousId`. There are cases in which SurveySparrow does not have an associated email address or mobile number, in which case a random hash will be passed in as the `anonymousId`.
+
+## Events
+
+The table below lists events that SurveySparrow sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations. SurveySparrow includes the `anonymousId` if available.
+
+| Event Name | Description |
+| ------------------ | ------------------------------------- |
+| Submission Completed | Survey response was submitted successfully |
+
+## Event Properties
+
+The table below lists the properties included in the events listed above.
+
+| Property Name | Description |
+| --------------- | ------------------------- |
+| `event` | Type of the event |
+| `survey` | Will hold all the properties data including surveys, answers,channel,expressions,variables |
+| `survey` | Meta details about the survey |
+| `contact` | Contact which has created the response |
+| `expressions` | Computed expressions data of the survey |
+| `variables` | Computed variables data of the survey |
+| `answers` | contains answer details of the entire survey |
+
+## Adding Destinations
+
+Now that your Source is set up, you can connect it with Destinations.
+
+Log in to your downstream tools and check to see that your events appear as expected, and that they contain all of the properties you expect. If your events and properties don't appear, check the [Event Delivery](/docs/connections/event-delivery/) tool, and refer to the Destination docs for each tool for troubleshooting.
+
+If there are any issues with how the events are arriving to Segment, [contact the SurveySparrow support team](mailto:support@surveysparrow.com).
\ No newline at end of file
diff --git a/src/connections/sources/catalog/libraries/server/http-api/index.md b/src/connections/sources/catalog/libraries/server/http-api/index.md
index 550e5814e2..9a1810b258 100644
--- a/src/connections/sources/catalog/libraries/server/http-api/index.md
+++ b/src/connections/sources/catalog/libraries/server/http-api/index.md
@@ -38,7 +38,7 @@ Segment welcomes feedback on API responses and error messages. [Reach out to sup
## Rate limits
-For each workspace, Segment recommends you to not exceed 20,000 requests per second with the HTTP API. If you exceed this, Segment reserves the right to queue any additional events and process those at a rate that doesn't exceed the limit. To request a higher limit, contact [Segment](mailto:friends@segment.com).
+For each workspace, Segment recommends you to not exceed 1,000 requests per second with the HTTP API. If you exceed this, Segment reserves the right to queue any additional events and process those at a rate that doesn't exceed the limit. To request a higher limit, contact [Segment](mailto:friends@segment.com).
For [`batch` requests](#batch), there's a limit of 500 KB per request.
diff --git a/src/engage/audiences/index.md b/src/engage/audiences/index.md
index 8fab34d7a2..36d8a67b8b 100644
--- a/src/engage/audiences/index.md
+++ b/src/engage/audiences/index.md
@@ -180,6 +180,9 @@ While Engage is computing, use the Audience Explorer to see users or accounts th
> warning ""
> [Facebook Custom Audiences](/docs/connections/destinations/catalog/personas-facebook-custom-audiences/), [Marketo Lists](/docs/connections/destinations/catalog/marketo-static-lists/), and [Adwords Remarking Lists](/docs/connections/destinations/catalog/adwords-remarketing-lists) impose rate limits on how quickly Segment can update an Audience. Segment syncs at the highest frequency allowed by the tool, which is between one and six hours.
+> warning ""
+> Real-time computations connected to List destinations use a separate sync process that can take 12-15 hours to send changes present in the most recent computation.
+
### Editing Realtime Audiences and Traits
Engage supports the editing of realtime Audiences and Traits, which allows you to make nuanced changes to existing Traits and Audiences in situations where cloning or building from scratch may not suit your use case.
diff --git a/src/engage/settings.md b/src/engage/settings.md
index d08b761277..e637b95cf7 100644
--- a/src/engage/settings.md
+++ b/src/engage/settings.md
@@ -14,14 +14,20 @@ If you see no credentials listed under the Channels tab, it means you've not yet
## Destinations settings
-The **Destinations** tab lists the downstream tools receiving your Engage data. Selecting a Destination from the list gives you a detailed view of the Audiences, Computed Traits, and Journeys that Segment sends to the Destination.
+The **Destinations** tab lists the downstream tools receiving your Engage data. Selecting a destination from the list gives you a detailed view of the audiences, computed traits, and journeys that Segment sends to the destination.
-To add a Destination, select the **+ Add destination** button, or navigate to **Connections > Destinations** within your Segment workspace. To learn more about sending Engage information to Segment Destinations, view the [Using Engage Data](/docs/engage/using-engage-data/) documentation.
+To add a destination, select the **+ Add destination** button, or navigate to **Connections > Destinations** within your Segment workspace. To learn more about sending Engage information to Segment destinations, view the [Using Engage Data](/docs/engage/using-engage-data/) documentation.
-You can delete a Destination from the Destinations tab in the Engage settings (**Engage > Engage settings > Destinations**).
+You can delete a destination from the Destinations tab in the Engage settings (**Engage > Engage settings > Destinations**).
## Warehouse sources
By connecting your existing warehouses to Engage, you can import customer or account data and use it to build SQL traits. The Warehouse sources tab displays the warehouses sending data to Engage.
To add a new data warehouse, select the **+ Add warehouse source** button. For more information on working with your imported warehouse data in Engage, read the [Engage SQL traits](/docs/engage/audiences/sql-traits/) guide.
+
+## Engage Events source
+
+The Engage Events source lets you sync subscription states, messaging events, and marketing analytics to downstream destinations. To find your Engage Events source in your Segment workspace, navigate to **Connections > Sources** and select **Engage Events**.
+
+For more information, view the [Engage Events Source documentation](/docs/connections/sources/catalog/cloud-apps/engage-events/).
diff --git a/src/engage/using-engage-data.md b/src/engage/using-engage-data.md
index 65729b046f..f8bcf40a0d 100644
--- a/src/engage/using-engage-data.md
+++ b/src/engage/using-engage-data.md
@@ -44,7 +44,6 @@ Segment sends an identify or track call for every user in the audience when the
Most destinations require that you configure a column in your schema to receive the audience data, however, some destinations (like Braze and Iterable) allow you to send audiences without doing this. This depends on the individual destination, so consult the destination's documentation for details.
-
### List Destinations
List destinations can only receive Audiences, and cannot receive computed traits.
@@ -56,6 +55,8 @@ When syncing to a list destination Engage uploads lists of users directly to the
User-list destinations can have individual limits on how often Segment can sync with them. For example, an AdWords audience is updated once every six hours or more, because that's what AdWords recommends.
+- **Journeys**: The destination receives a list of users who qualify for the associated journey step. Unlike lists associated with Engage Audiences, users who are added to a journey list cannot be subsequently removed. See [best practices](/docs/engage/journeys/faq-best-practices#suppress-targeting-with-journey-lists) for techniques to suppress targeting with journey lists.
+For more information, see [Using Engage Data](/docs/engage/using-engage-data/).
## What do the payloads look like for Engage data?
@@ -161,8 +162,10 @@ Engage only sends events to the destination if the Computed Trait value has chan
}
```
-### Journey generated events
-_See [this doc](https://segment.com/docs/engage/journeys/send-data/#what-do-i-send-to-destinations) for more information on Journeys events._
+### Journeys generated events
+The data type you send to a destination depends on whether the destination is an event destination or a list destination. For more information, read the [Journeys documentation](/docs/engage/journeys/send-data/#:~:text=a%20List%20destination.-,Event%20destination,%22traits%22%3A%20%7B%0A%20%20%20%20%22j_o_first_purchase__opened_email_dje83h%22%3A%20%22true%22%0A%20%20%7D%0A%7D,-List%20destination) on how Journeys Identity and Track event payloads get formatted when sending to Event destinations.
+
+_See [this doc](/docs/engage/journeys/send-data/#what-do-i-send-to-destinations) for more information on Journeys events._
`Track` events generated by a journey have a key for the journey name "audience_key", and a key for the journey value:
```js
diff --git a/src/engage/warehouses.md b/src/engage/warehouses.md
index 0b73bed521..e4461c4483 100644
--- a/src/engage/warehouses.md
+++ b/src/engage/warehouses.md
@@ -148,5 +148,8 @@ Yes. You can use [Warehouses Selective Sync](/docs/connections/storage/warehouse
### Why are there multiple schemas prefixed with `engage_` in my warehouse when I only have one space?
-Segment currently can only connect a source to one instance of each destination, for example, one source cannot send to two different Amplitude instances. To get around this restriction, Engage creates multiple sources to send events to the destinations connected to your space.
+Segment can only connect a source to one instance of each destination. For example, one source cannot send to two different Amplitude instances. As a workaround, Engage creates multiple sources to send events to the destinations connected to your space.
+
For example, if you have three webhook destinations in your space, Engage creates three different sources to send events to them. This creates three different warehouse schemas, and is usually the reason you have more schemas than spaces.
+
+This approach doesn't apply to messaging destinations, however. Messaging destinations connected from journeys and broadcasts don't generate multiple background sources.
\ No newline at end of file
diff --git a/src/guides/how-to-guides/import-historical-data.md b/src/guides/how-to-guides/import-historical-data.md
index e2ae16df16..b60f56e13f 100644
--- a/src/guides/how-to-guides/import-historical-data.md
+++ b/src/guides/how-to-guides/import-historical-data.md
@@ -6,7 +6,10 @@ When transitioning over to Segment, customers commonly want to import historical
**Note:** Historical imports can only be done into destinations that can accept historical timestamped data. Most analytics tools like Mixpanel, Amplitude, or Kissmetrics can handle that type of data just fine. One common destination that doesn't accept historical data is Google Analytics, since their API cannot accept historical data.
-Use any [server-side library](https://segment.com/docs/connections/sources/#server), which sends requests in batches to improve performance. Once you have data to import, follow the steps below:
+## Method 1: Using a Custom Solution
+
+### General Instructions
+Use any [server-side library](/docs/connections/sources/#server), which sends requests in batches to improve performance. Once you have data to import, follow the steps below:
1. Export or collect the data to be imported.
@@ -14,7 +17,7 @@ Use any [server-side library](https://segment.com/docs/connections/sources/#ser
2. Decide which destinations need to receive the data.
- **By default, data coming into Segment will be relayed to all destinations linked to a given source.** To limit data to specific destinations, the `integrations` object must be modified. With historical data, you often only want to send the data to a specific destination or into your data warehouse. For example, in [Node.js](https://segment.com/docs/connections/sources/catalog/libraries/server/node/#integrations) set the `integrations` object as follows.
+ **By default, data coming into Segment will be forwarded to all destinations connected to a given source.** To limit data to specific destinations, the `integrations` object must be modified. With historical data, you often only want to send the data to a specific destination or into your data warehouse. For example, in [Node.js](https://segment.com/docs/connections/sources/catalog/libraries/server/node/#integrations) set the `integrations` object as follows.
```js
analytics.track({
event: 'Upgraded Membership',
@@ -25,7 +28,13 @@ Use any [server-side library](https://segment.com/docs/connections/sources/#ser
3. Once you've done that, you'll need to write an application or worker to send the data to Segment.
-You will need to cycle through each set of data and map it to a Segment server-side library method or build an array matching the [HTTP Import API format](https://segment.com/docs/connections/sources/catalog/libraries/server/http/#import). **Note**, we recommend using a Segment library for this process, as they will set contextual message fields like `message_id` (used for deduping) and `sent_at` (used for correctly client clock skew) that our API will use to ensure correct behavior upon ingestion. The server-side libraries will automatically batch requests to optimize for performance and prevent linear request volume. This batching behavior is modifiable. Some of the libraries implement a configurable max queue size that may discard messages if you enqueue requests much faster than the client can flush them. We recommend overriding the max queue size parameter for the library to a high value you're comfortable you can remain under in your batch job.
+ You will need to cycle through each set of data and map it to a Segment server-side library method or build an array matching the [HTTP Import API format](/docs/connections/sources/catalog/libraries/server/http/#import).
+
+ **Tip**: Segment recommends using a Segment library for this process, as they set contextual message fields like `message_id` (used for deduping) and `sent_at` (used for correctly client clock skew) that Segment's API uses to correct behavior upon ingestion.
+
+ **Tip**: The server-side libraries will automatically batch requests to optimize for performance and prevent linear request volume. This batching behavior is modifiable, and some of the underlying libraries implement a configurable max queue size that may discard messages if you enqueue requests much faster than the client can flush them. We recommend overriding the max queue size parameter for the library to a high value you're comfortable you can remain under in your batch job.
+
+### Demo projects
One of Segment's Success Engineers wrote an alpha prototype Node.js app for importing data utilizing the HTTP API, which we've included below:
@@ -35,6 +44,13 @@ Additionally, one of Segment's Software Engineers developed a React App with mor
[Desktop React CSV uploader](https://github.com/segmentio/desktop-csv-uploader){:target="_blank"}
-If a server-side library doesn't meet your needs, use the Segment [bulk import HTTP API](https://segment.com/docs/connections/sources/catalog/libraries/server/http/#import). **Note**, if you're using the HTTP API directly to replay data you've exported from Segment, we recommend removing the original `sent_at`, `message_id`, and `project_id` fields from the archived message before forwarding them to Segment.
-
[MarketLytics](http://marketlytics.com/){:target="_blank"} has documented their experience using the alpha prototype importer and offer some [helpful visuals and tips](http://marketlytics.com/blog/import-historic-data-to-segment){:target="_blank"}.
+
+### Alternative solution
+If a server-side library doesn't meet your needs, you can use the Segment [bulk import HTTP API](/docs/connections/sources/catalog/libraries/server/http/#import) directly.
+
+**Note:** When you use the HTTP API to export historical data to upload to Segment, remove all the original `sent_at`, `message_id`, and `project_id` fields from the archived message before forwarding them back to Segment.
+
+## Method 2: Using Reverse ETL
+
+Please refer to the [Reverse ETL guide](/docs/connections/reverse-etl/){:target="_blank"} for more details.
diff --git a/src/guides/regional-segment.md b/src/guides/regional-segment.md
index 93ba277d18..09b060dc98 100644
--- a/src/guides/regional-segment.md
+++ b/src/guides/regional-segment.md
@@ -50,8 +50,14 @@ All Segment client-side SDKs read this setting and update themselves automatical
### Server-side and project sources
When you send data from a server-side or project source, you can use the `host` configuration parameter to send data to the desired region:
-1. Oregon (Default) — `api.segment.io/v1`
-2. Dublin — `events.eu1.segmentapis.com/`
+1. Oregon (Default) — `https://events.segmentapis.com/v1`
+2. Dublin — `https://events.eu1.segmentapis.com/`
+
+Here is an example of how to set the host:
+
+```json
+Analytics.Initialize("", new Config().SetHost("https://events.eu1.segmentapis.com (https://events.eu1.segmentapis.com/)"));
+```
## Create a new workspace with a different region
diff --git a/src/unify/Traits/sql-traits.md b/src/unify/Traits/sql-traits.md
index 108f62ff66..6fc796488a 100644
--- a/src/unify/Traits/sql-traits.md
+++ b/src/unify/Traits/sql-traits.md
@@ -268,5 +268,10 @@ Check that you've configured the identifier that uniquely identifies users in a
Ensure that the name given to the SQL trait is not the same name as the identifier or column name from the query. To use SQL traits to update an identifier, the identifier will need to be a column in the query of your SQL trait. The column name in the query of the SQL trait should be the one that Identity Resolution uses to generate the identifier.
+### Are there any errors in the browser's Network or Console tab?
+
+If you experience issues saving the SQL Trait query or previewing the results of the SQL Trait query, open the browser's Console and Network tabs to see if any errors occurred upon clicking the Save/Preview buttons. If you find any errors, please expand the error and take a screenshot of it. You can then share these details when creating a support ticket.
+
### Why can't I see error messages in SQL traits while other users can?
To see error messages in SQL traits, you will need to have PII Access.
+
diff --git a/styleguide.md b/styleguide.md
index 1ef00829a9..2b12264dc2 100644
--- a/styleguide.md
+++ b/styleguide.md
@@ -32,7 +32,7 @@ Rule | Description |
---- | ----------- |
Field names in any app | **Bold** the use of field names.
Hyperlinks | Link to the noun or topic of the article rather than `here`.
-Numbers | Use digits/numerals in all cases, except at the beginning of a sentnce.
For example, instead of `There are five options to choose from.` → use `There are 5 options to choose from.`
+Numbers | Use digits/numerals in all cases, except at the beginning of a sentence.
For example, instead of `There are five options to choose from.` → use `There are 5 options to choose from.`
Entered text in the app | Use `code format`
Capitalization | Capitalize Segment and Segment product names. For example, "privacy" by itself isn't capitalized, but "Segment Privacy Portal" is. Page titles and other UI text should be in lower case.
Capitalize the words "Sources", "Destinations", and "Warehouses" when referring them as product names (for example: “You can use Sources to…”) but decap them when referring to them generically (“You can connect your warehouse to…”)
`we` and `they` | Avoid using `we` and `they`. Be explicit about naming who is being referenced. Because Segment has such a large footprint of documentation around third-party integrations, it's important to be very clear about who "we" are in any given part of the doc. Instead of using "we", your should refer to our software or processes in the third person: "Segment creates..." "Segment sends..."
@@ -49,6 +49,7 @@ Libraries vs SDKs | Segment Source libraries are libraries, not SDKs. The bundle
Styling Segment Methods | When you refer to a method *outside* of code, use: Page call, Identify call
Avoid styling like inline code: Page() method
`page()`
`.identify()`
`Identify` call
Styling Segment Events | When you refer to an event *outside* of code, format it like inline code. For example: `Product Viewed` or `Clicked Login Button`.
Connection modes | Device-mode and Cloud-mode are always hyphenated. They should be capitalized when referring to the mode in abstract (as a product name), but can be decapped when used in running text about a specific destination.
We’ve had a lot of confusion in the past due to using device-mode and client-side, and cloud-mode and server-side interchangeably when referring to our Connection Modes. There are legitimate uses of both the terms client-side and server-side when referring to things _other than_ our connection modes, so we’re moving to use **Device-mode** and **Cloud-mode** instead.
+Sources and destinations | When you refer broadly to sources or destinations, don't capitalize source/destination. For example, "_A source is a website, server library, mobile SDK, or cloud application..._"
If you're referring to the full name of a source or destination, like Slack (Actions) Destination or Facebook Ads Source, for example, capitalize source/destination.
## Images
@@ -65,7 +66,7 @@ We have some fairly complex CSS, and lists with lots of "stuff" in them. Normall
On top of this, some of the Premonition callouts we use, for some reason, break list ordering. So you can't add an "info" box inside a running list. (Boooo.)
-To get around this, you can let the previous list item end whereever if needs to, then create an entire new ordered list with specific HTML to allow you to override the start number.
+To get around this, you can let the previous list item end wherever if needs to, then create an entire new ordered list with specific HTML to allow you to override the start number.
```html