diff --git a/src/_data/catalog/destination_categories.yml b/src/_data/catalog/destination_categories.yml index 0975319359..c5c7c8fada 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 2023-08-03 +# destination categories last updated 2023-08-08 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 c7134e6b23..34883f41c1 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 2023-08-03 +# destination data last updated 2023-08-08 items: - id: 637e8d185e2dec264895ea89 display_name: 1Flow @@ -63310,6 +63310,900 @@ items: label: API secret actions: [] presets: [] +- id: 63d17a1e6ab3e62212278cd0 + display_name: Saleswings (Actions) + name: Saleswings (Actions) + slug: actions-saleswings + hidden: false + endpoints: + - US + regions: + - us-west-2 + - eu-west-1 + url: connections/destinations/catalog/actions-saleswings + previous_names: + - Saleswings (Actions) + website: >- + https://www.saleswingsapp.com/lead-scoring-segment-com/?utm_campaign=segmentcatalogue&utm_medium=partnerlisting&utm_source=segment + status: PUBLIC_BETA + categories: + - CRM + - Analytics + - Marketing Automation + - Personalization + logo: + url: https://cdn.filepicker.io/api/file/Gs7h3XjXTAW94s1zQbNJ + mark: + url: https://cdn.filepicker.io/api/file/GLANkekxQomkf8a2Kiib + methods: + track: true + identify: true + group: true + alias: true + screen: false + page: true + platforms: + browser: true + mobile: false + server: true + warehouse: 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: password + defaultValue: '' + description: Segment.io API key for your SalesWings project. + required: true + label: API Key + - name: environment + type: select + defaultValue: helium + description: SalesWings environment this destination is connected with. + required: true + label: Environment + actions: + - id: i9ZPqNUo8Qejn8ua5rzkHC + name: Submit Page Event + slug: submitPageEvent + description: >- + Send your Segment Page events to SalesWings to use them for tagging, + scoring and prioritising your leads. + platform: CLOUD + hidden: false + defaultTrigger: type = "page" + fields: + - id: 5USLkCtUepA2rhZ7hUuGoB + sortOrder: 0 + fieldKey: userID + label: Segment User ID + type: STRING + description: Permanent identifier of a Segment user the event is attributed to. + placeholder: '' + defaultValue: + '@path': $.userId + required: false + multiple: false + choices: null + dynamic: true + allowNull: false + - id: t92MgyxithBRrxYQ2K8EPH + sortOrder: 1 + fieldKey: anonymousID + label: Segment Anonymous User ID + type: STRING + description: >- + A pseudo-unique substitute for a Segment user ID the event is attributed + to. + placeholder: '' + defaultValue: + '@path': $.anonymousId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: e2rhKRmemib96U5KAKKjpp + sortOrder: 2 + fieldKey: url + label: URL + type: STRING + description: URL associated with the event. + placeholder: '' + defaultValue: + '@if': + exists: + '@path': $.properties.url + then: + '@path': $.properties.url + else: + '@path': $.context.page.url + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: o6rNyhjp3S9Nqv8kVgtExS + sortOrder: 3 + fieldKey: referrerUrl + label: Referrer URL + type: STRING + description: Referrer URL associated with the event. + placeholder: '' + defaultValue: + '@if': + exists: + '@path': $.properties.referrer + then: + '@path': $.properties.referrer + else: + '@path': $.context.page.referrer + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: hxJvthQJxaL77doLoBh5Nx + sortOrder: 4 + fieldKey: userAgent + label: User Agent + type: STRING + description: User Agent associated with the event. + placeholder: '' + defaultValue: + '@path': $.context.userAgent + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: f6auZyDrWu1rJ1R2d1UxKP + sortOrder: 5 + fieldKey: timestamp + label: Event Timestamp + type: DATETIME + description: When the event was sent. + placeholder: '' + defaultValue: + '@path': $.timestamp + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: kuQ5YKP4rtTwKYCywTi2tp + sortOrder: 6 + fieldKey: enable_batching + label: Enable Batching? + type: BOOLEAN + description: When enabled, Segment will send events in batches. + defaultValue: false + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: jomy8pCbr3SMkdYiYKsBks + name: Submit Screen Event + slug: submitScreenEvent + description: >- + Send your Segment Screen events to SalesWings to use them for tagging, + scoring and prioritising your leads. + platform: CLOUD + hidden: false + defaultTrigger: type = "screen" + fields: + - id: u5woa7cvVHpZvKLMML12EL + sortOrder: 0 + fieldKey: kind + label: Custom Event Kind + type: STRING + description: >- + Type of the SalesWings custom event (a custom event is visualized in + SalesWings cockpit and SalesForce Lead Intent View as "[[Kind]] Data"). + placeholder: '' + defaultValue: Screen + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: sxrvSTgZm6wtDGQY6xFRGM + sortOrder: 1 + fieldKey: data + label: Custom Event Data + type: STRING + description: >- + String description of the SalesWings custom event payload (a custom + event is visualized in SalesWings cockpit and SalesForce Lead Intent + View as "[[Kind]] Data"). + placeholder: '' + defaultValue: + '@path': $.name + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: wseo7DZ8aF91QBzGjB6rMK + sortOrder: 2 + fieldKey: userID + label: Segment User ID + type: STRING + description: Permanent identifier of a Segment user the event is attributed to. + placeholder: '' + defaultValue: + '@path': $.userId + required: false + multiple: false + choices: null + dynamic: true + allowNull: false + - id: i2sDzTdJ9p4SkLyhq1Nejo + sortOrder: 3 + fieldKey: anonymousID + label: Segment Anonymous User ID + type: STRING + description: >- + A pseudo-unique substitute for a Segment user ID the event is attributed + to. + placeholder: '' + defaultValue: + '@path': $.anonymousId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 5mUs1qEmbVdUsUjBv27jGv + sortOrder: 4 + fieldKey: email + label: Email + type: STRING + description: Identified email of the Segment User. + 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: qGHRaUZoF9QBchsBmmSDXK + sortOrder: 5 + fieldKey: url + label: URL + type: STRING + description: URL associated with the event. + placeholder: '' + defaultValue: + '@if': + exists: + '@path': $.properties.url + then: + '@path': $.properties.url + else: + '@path': $.context.page.url + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: vjGr59HsSSKvTuZFb9Sfei + sortOrder: 6 + fieldKey: referrerUrl + label: Referrer URL + type: STRING + description: Referrer URL associated with the event. + placeholder: '' + defaultValue: + '@if': + exists: + '@path': $.properties.referrer + then: + '@path': $.properties.referrer + else: + '@path': $.context.page.referrer + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: hrkbT41z5hgGVCri1oBVok + sortOrder: 7 + fieldKey: userAgent + label: User Agent + type: STRING + description: User Agent associated with the event. + placeholder: '' + defaultValue: + '@path': $.context.userAgent + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: m6whz594VTztEhRPQfV7aY + sortOrder: 8 + fieldKey: timestamp + label: Event Timestamp + type: DATETIME + description: When the event was sent. + placeholder: '' + defaultValue: + '@path': $.timestamp + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: kwFkYQGTAz73fv285ENQ59 + sortOrder: 9 + fieldKey: values + label: Custom Attribute Values + type: OBJECT + description: Custom attribute values associated with the SalesWings custom event. + placeholder: '' + defaultValue: + '@path': $.properties + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: qAodssfKeEjDKhdNGkR972 + sortOrder: 10 + fieldKey: enable_batching + label: Enable Batching? + type: BOOLEAN + description: When enabled, Segment will send events in batches. + defaultValue: false + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: njFVJdPY788RCrzBySAwpc + name: Submit Identify Event + slug: submitIdentifyEvent + description: >- + Send your Segment Identify events to SalesWings to use them for tagging, + scoring and prioritising your leads. + platform: CLOUD + hidden: false + defaultTrigger: type = "identify" + fields: + - id: tTrqMjUXAhKRgpawFSngev + sortOrder: 0 + fieldKey: kind + label: Custom Event Kind + type: STRING + description: >- + Type of the SalesWings custom event (a custom event is visualized in + SalesWings cockpit and SalesForce Lead Intent View as "[[Kind]] Data"). + placeholder: '' + defaultValue: Identify + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: cMszkms3khUjihH3L8fG38 + sortOrder: 1 + fieldKey: data + label: Custom Event Data + type: STRING + description: >- + String description of the SalesWings custom event payload (a custom + event is visualized in SalesWings cockpit and SalesForce Lead Intent + View as "[[Kind]] Data"). + placeholder: '' + defaultValue: + '@path': $.traits.email + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: aaLduptsr3SCc3d7WPvjqZ + sortOrder: 2 + fieldKey: userID + label: Segment User ID + type: STRING + description: Permanent identifier of a Segment user the event is attributed to. + placeholder: '' + defaultValue: + '@path': $.userId + required: false + multiple: false + choices: null + dynamic: true + allowNull: false + - id: mzbFdTBgYkViRAh2oYpNmE + sortOrder: 3 + fieldKey: anonymousID + label: Segment Anonymous User ID + type: STRING + description: >- + A pseudo-unique substitute for a Segment user ID the event is attributed + to. + placeholder: '' + defaultValue: + '@path': $.anonymousId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: iAifMkh4W6JVqRUJoiNbjq + sortOrder: 4 + fieldKey: email + label: Email + type: STRING + description: Identified email of the Segment User. + placeholder: '' + defaultValue: + '@if': + exists: + '@path': $.traits.email + then: + '@path': $.traits.email + else: + '@path': $.properties.email + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 7y4TgkCWGjt6CB2nNySSZS + sortOrder: 5 + fieldKey: url + label: URL + type: STRING + description: URL associated with the event. + placeholder: '' + defaultValue: + '@if': + exists: + '@path': $.properties.url + then: + '@path': $.properties.url + else: + '@path': $.context.page.url + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 6S2hb8s1S5MzLneB2NNppX + sortOrder: 6 + fieldKey: referrerUrl + label: Referrer URL + type: STRING + description: Referrer URL associated with the event. + placeholder: '' + defaultValue: + '@if': + exists: + '@path': $.properties.referrer + then: + '@path': $.properties.referrer + else: + '@path': $.context.page.referrer + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: iASqXrf9YaiCnfmmogjtzr + sortOrder: 7 + fieldKey: userAgent + label: User Agent + type: STRING + description: User Agent associated with the event. + placeholder: '' + defaultValue: + '@path': $.context.userAgent + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: gP6npbA7BHCrmHYx12fy3N + sortOrder: 8 + fieldKey: timestamp + label: Event Timestamp + type: DATETIME + description: When the event was sent. + placeholder: '' + defaultValue: + '@path': $.timestamp + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: cW5se7hugtwnXZn2yfv9xq + sortOrder: 9 + fieldKey: values + label: Custom Attribute Values + type: OBJECT + description: Custom attribute values associated with the SalesWings custom event. + placeholder: '' + defaultValue: + '@path': $.traits + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: aQRJAhhMd9sWpMcJkv7HLf + sortOrder: 10 + fieldKey: enable_batching + label: Enable Batching? + type: BOOLEAN + description: When enabled, Segment will send events in batches. + defaultValue: false + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: tvwDX96FJ1HhbffEAQ6WL6 + name: Submit Track Event + slug: submitTrackEvent + description: >- + Send your Segment Track events to SalesWings to use them for tagging, + scoring and prioritising your leads. + platform: CLOUD + hidden: false + defaultTrigger: type = "track" + fields: + - id: 76ahGUcmJ2AWfSdHT9Bnq6 + sortOrder: 0 + fieldKey: kind + label: Custom Event Kind + type: STRING + description: >- + Type of the SalesWings custom event (a custom event is visualized in + SalesWings cockpit and SalesForce Lead Intent View as "[[Kind]] Data"). + placeholder: '' + defaultValue: Track + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 44kprWDdsvooBedfwPSx2b + sortOrder: 1 + fieldKey: data + label: Custom Event Data + type: STRING + description: >- + String description of the SalesWings custom event payload (a custom + event is visualized in SalesWings cockpit and SalesForce Lead Intent + View as "[[Kind]] Data"). + placeholder: '' + defaultValue: + '@path': $.event + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: vkFdrLZJ7iKFbTbyhAkQdj + sortOrder: 2 + fieldKey: userID + label: Segment User ID + type: STRING + description: Permanent identifier of a Segment user the event is attributed to. + placeholder: '' + defaultValue: + '@path': $.userId + required: false + multiple: false + choices: null + dynamic: true + allowNull: false + - id: aj4oSZMdUFdqZaPAh5xvmA + sortOrder: 3 + fieldKey: anonymousID + label: Segment Anonymous User ID + type: STRING + description: >- + A pseudo-unique substitute for a Segment user ID the event is attributed + to. + placeholder: '' + defaultValue: + '@path': $.anonymousId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: bq8nMgDpjLBCr7sJY1zYtu + sortOrder: 4 + fieldKey: email + label: Email + type: STRING + description: Identified email of the Segment User. + 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: 574LABKpU116JQi64QQNL1 + sortOrder: 5 + fieldKey: url + label: URL + type: STRING + description: URL associated with the event. + placeholder: '' + defaultValue: + '@if': + exists: + '@path': $.properties.url + then: + '@path': $.properties.url + else: + '@path': $.context.page.url + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: tvc8d789qLNJJ4JQZZyv79 + sortOrder: 6 + fieldKey: referrerUrl + label: Referrer URL + type: STRING + description: Referrer URL associated with the event. + placeholder: '' + defaultValue: + '@if': + exists: + '@path': $.properties.referrer + then: + '@path': $.properties.referrer + else: + '@path': $.context.page.referrer + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: tYXFuGeL1xFKwAWAz1yzKb + sortOrder: 7 + fieldKey: userAgent + label: User Agent + type: STRING + description: User Agent associated with the event. + placeholder: '' + defaultValue: + '@path': $.context.userAgent + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 2svzmpzsND9eP2kJGWPFc9 + sortOrder: 8 + fieldKey: timestamp + label: Event Timestamp + type: DATETIME + description: When the event was sent. + placeholder: '' + defaultValue: + '@path': $.timestamp + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: cYSX75LoGemoYoTXoQaKta + sortOrder: 9 + fieldKey: values + label: Custom Attribute Values + type: OBJECT + description: Custom attribute values associated with the SalesWings custom event. + placeholder: '' + defaultValue: + '@path': $.properties + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: t3dN4bmBCgYvXHHbTigNQT + sortOrder: 10 + fieldKey: enable_batching + label: Enable Batching? + type: BOOLEAN + description: When enabled, Segment will send events in batches. + defaultValue: false + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + presets: + - actionId: jomy8pCbr3SMkdYiYKsBks + name: Submit Screen Event + fields: + kind: Screen + data: + '@path': $.name + userID: + '@path': $.userId + anonymousID: + '@path': $.anonymousId + email: + '@if': + exists: + '@path': $.traits.email + then: + '@path': $.traits.email + else: + '@path': $.properties.email + url: + '@if': + exists: + '@path': $.properties.url + then: + '@path': $.properties.url + else: + '@path': $.context.page.url + referrerUrl: + '@if': + exists: + '@path': $.properties.referrer + then: + '@path': $.properties.referrer + else: + '@path': $.context.page.referrer + userAgent: + '@path': $.context.userAgent + timestamp: + '@path': $.timestamp + values: + '@path': $.properties + trigger: type = "screen" + - actionId: i9ZPqNUo8Qejn8ua5rzkHC + name: Submit Page Event + fields: + userID: + '@path': $.userId + anonymousID: + '@path': $.anonymousId + url: + '@if': + exists: + '@path': $.properties.url + then: + '@path': $.properties.url + else: + '@path': $.context.page.url + referrerUrl: + '@if': + exists: + '@path': $.properties.referrer + then: + '@path': $.properties.referrer + else: + '@path': $.context.page.referrer + userAgent: + '@path': $.context.userAgent + timestamp: + '@path': $.timestamp + trigger: type = "page" + - actionId: njFVJdPY788RCrzBySAwpc + name: Submit Identify Event + fields: + kind: Identify + data: + '@path': $.traits.email + userID: + '@path': $.userId + anonymousID: + '@path': $.anonymousId + email: + '@if': + exists: + '@path': $.traits.email + then: + '@path': $.traits.email + else: + '@path': $.properties.email + url: + '@if': + exists: + '@path': $.properties.url + then: + '@path': $.properties.url + else: + '@path': $.context.page.url + referrerUrl: + '@if': + exists: + '@path': $.properties.referrer + then: + '@path': $.properties.referrer + else: + '@path': $.context.page.referrer + userAgent: + '@path': $.context.userAgent + timestamp: + '@path': $.timestamp + values: + '@path': $.traits + trigger: type = "identify" + - actionId: tvwDX96FJ1HhbffEAQ6WL6 + name: Submit Track Event + fields: + kind: Track + data: + '@path': $.event + userID: + '@path': $.userId + anonymousID: + '@path': $.anonymousId + email: + '@if': + exists: + '@path': $.traits.email + then: + '@path': $.traits.email + else: + '@path': $.properties.email + url: + '@if': + exists: + '@path': $.properties.url + then: + '@path': $.properties.url + else: + '@path': $.context.page.url + referrerUrl: + '@if': + exists: + '@path': $.properties.referrer + then: + '@path': $.properties.referrer + else: + '@path': $.context.page.referrer + userAgent: + '@path': $.context.userAgent + timestamp: + '@path': $.timestamp + values: + '@path': $.properties + trigger: type = "track" - id: 54c02a5adb31d978f14a7f6f display_name: SatisMeter name: SatisMeter diff --git a/src/_data/catalog/destinations_private.yml b/src/_data/catalog/destinations_private.yml index 5551a8646f..88b1339fb6 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 2023-08-03 +# destination data last updated 2023-08-08 items: - id: 54521fd725e721e32a72eec6 display_name: Intercom @@ -838,889 +838,6 @@ items: dynamic: false allowNull: false presets: [] - - id: 63d17a1e6ab3e62212278cd0 - display_name: Saleswings (Actions) - name: Saleswings (Actions) - slug: actions-saleswings - previous_names: - - Saleswings (Actions) - url: connections/destinations/catalog/actions-saleswings - website: >- - https://www.saleswingsapp.com/lead-scoring-segment-com/?utm_campaign=segmentcatalogue&utm_medium=partnerlisting&utm_source=segment - status: PRIVATE_BETA - logo: - url: https://cdn.filepicker.io/api/file/Gs7h3XjXTAW94s1zQbNJ - mark: - url: https://cdn.filepicker.io/api/file/GLANkekxQomkf8a2Kiib - methods: - track: true - identify: true - group: true - alias: true - screen: false - page: true - platforms: - browser: true - mobile: false - server: true - warehouse: false - components: [] - browserUnbundlingSupported: false - browserUnbundlingPublic: false - replay: false - settings: - - name: apiKey - type: password - defaultValue: '' - description: Segment.io API key for your SalesWings project. - required: true - label: API Key - - name: environment - type: select - defaultValue: helium - description: SalesWings environment this destination is connected with. - required: true - label: Environment - actions: - - id: i9ZPqNUo8Qejn8ua5rzkHC - name: Submit Page Event - slug: submitPageEvent - description: >- - Send your Segment Page events to SalesWings to use them for tagging, - scoring and prioritising your leads. - platform: CLOUD - hidden: false - defaultTrigger: type = "page" - fields: - - id: 5USLkCtUepA2rhZ7hUuGoB - sortOrder: 0 - fieldKey: userID - label: Segment User ID - type: STRING - description: Permanent identifier of a Segment user the event is attributed to. - placeholder: '' - defaultValue: - '@path': $.userId - required: false - multiple: false - choices: null - dynamic: true - allowNull: false - - id: t92MgyxithBRrxYQ2K8EPH - sortOrder: 1 - fieldKey: anonymousID - label: Segment Anonymous User ID - type: STRING - description: >- - A pseudo-unique substitute for a Segment user ID the event is - attributed to. - placeholder: '' - defaultValue: - '@path': $.anonymousId - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: e2rhKRmemib96U5KAKKjpp - sortOrder: 2 - fieldKey: url - label: URL - type: STRING - description: URL associated with the event. - placeholder: '' - defaultValue: - '@if': - exists: - '@path': $.properties.url - then: - '@path': $.properties.url - else: - '@path': $.context.page.url - required: true - multiple: false - choices: null - dynamic: false - allowNull: false - - id: o6rNyhjp3S9Nqv8kVgtExS - sortOrder: 3 - fieldKey: referrerUrl - label: Referrer URL - type: STRING - description: Referrer URL associated with the event. - placeholder: '' - defaultValue: - '@if': - exists: - '@path': $.properties.referrer - then: - '@path': $.properties.referrer - else: - '@path': $.context.page.referrer - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: hxJvthQJxaL77doLoBh5Nx - sortOrder: 4 - fieldKey: userAgent - label: User Agent - type: STRING - description: User Agent associated with the event. - placeholder: '' - defaultValue: - '@path': $.context.userAgent - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: f6auZyDrWu1rJ1R2d1UxKP - sortOrder: 5 - fieldKey: timestamp - label: Event Timestamp - type: DATETIME - description: When the event was sent. - placeholder: '' - defaultValue: - '@path': $.timestamp - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: kuQ5YKP4rtTwKYCywTi2tp - sortOrder: 6 - fieldKey: enable_batching - label: Enable Batching? - type: BOOLEAN - description: When enabled, Segment will send events in batches. - defaultValue: false - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: jomy8pCbr3SMkdYiYKsBks - name: Submit Screen Event - slug: submitScreenEvent - description: >- - Send your Segment Screen events to SalesWings to use them for tagging, - scoring and prioritising your leads. - platform: CLOUD - hidden: false - defaultTrigger: type = "screen" - fields: - - id: u5woa7cvVHpZvKLMML12EL - sortOrder: 0 - fieldKey: kind - label: Custom Event Kind - type: STRING - description: >- - Type of the SalesWings custom event (a custom event is visualized - in SalesWings cockpit and SalesForce Lead Intent View as "[[Kind]] - Data"). - placeholder: '' - defaultValue: Screen - required: true - multiple: false - choices: null - dynamic: false - allowNull: false - - id: sxrvSTgZm6wtDGQY6xFRGM - sortOrder: 1 - fieldKey: data - label: Custom Event Data - type: STRING - description: >- - String description of the SalesWings custom event payload (a - custom event is visualized in SalesWings cockpit and SalesForce - Lead Intent View as "[[Kind]] Data"). - placeholder: '' - defaultValue: - '@path': $.name - required: true - multiple: false - choices: null - dynamic: false - allowNull: false - - id: wseo7DZ8aF91QBzGjB6rMK - sortOrder: 2 - fieldKey: userID - label: Segment User ID - type: STRING - description: Permanent identifier of a Segment user the event is attributed to. - placeholder: '' - defaultValue: - '@path': $.userId - required: false - multiple: false - choices: null - dynamic: true - allowNull: false - - id: i2sDzTdJ9p4SkLyhq1Nejo - sortOrder: 3 - fieldKey: anonymousID - label: Segment Anonymous User ID - type: STRING - description: >- - A pseudo-unique substitute for a Segment user ID the event is - attributed to. - placeholder: '' - defaultValue: - '@path': $.anonymousId - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: 5mUs1qEmbVdUsUjBv27jGv - sortOrder: 4 - fieldKey: email - label: Email - type: STRING - description: Identified email of the Segment User. - 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: qGHRaUZoF9QBchsBmmSDXK - sortOrder: 5 - fieldKey: url - label: URL - type: STRING - description: URL associated with the event. - placeholder: '' - defaultValue: - '@if': - exists: - '@path': $.properties.url - then: - '@path': $.properties.url - else: - '@path': $.context.page.url - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: vjGr59HsSSKvTuZFb9Sfei - sortOrder: 6 - fieldKey: referrerUrl - label: Referrer URL - type: STRING - description: Referrer URL associated with the event. - placeholder: '' - defaultValue: - '@if': - exists: - '@path': $.properties.referrer - then: - '@path': $.properties.referrer - else: - '@path': $.context.page.referrer - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: hrkbT41z5hgGVCri1oBVok - sortOrder: 7 - fieldKey: userAgent - label: User Agent - type: STRING - description: User Agent associated with the event. - placeholder: '' - defaultValue: - '@path': $.context.userAgent - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: m6whz594VTztEhRPQfV7aY - sortOrder: 8 - fieldKey: timestamp - label: Event Timestamp - type: DATETIME - description: When the event was sent. - placeholder: '' - defaultValue: - '@path': $.timestamp - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: kwFkYQGTAz73fv285ENQ59 - sortOrder: 9 - fieldKey: values - label: Custom Attribute Values - type: OBJECT - description: >- - Custom attribute values associated with the SalesWings custom - event. - placeholder: '' - defaultValue: - '@path': $.properties - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: qAodssfKeEjDKhdNGkR972 - sortOrder: 10 - fieldKey: enable_batching - label: Enable Batching? - type: BOOLEAN - description: When enabled, Segment will send events in batches. - defaultValue: false - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: njFVJdPY788RCrzBySAwpc - name: Submit Identify Event - slug: submitIdentifyEvent - description: >- - Send your Segment Identify events to SalesWings to use them for - tagging, scoring and prioritising your leads. - platform: CLOUD - hidden: false - defaultTrigger: type = "identify" - fields: - - id: tTrqMjUXAhKRgpawFSngev - sortOrder: 0 - fieldKey: kind - label: Custom Event Kind - type: STRING - description: >- - Type of the SalesWings custom event (a custom event is visualized - in SalesWings cockpit and SalesForce Lead Intent View as "[[Kind]] - Data"). - placeholder: '' - defaultValue: Identify - required: true - multiple: false - choices: null - dynamic: false - allowNull: false - - id: cMszkms3khUjihH3L8fG38 - sortOrder: 1 - fieldKey: data - label: Custom Event Data - type: STRING - description: >- - String description of the SalesWings custom event payload (a - custom event is visualized in SalesWings cockpit and SalesForce - Lead Intent View as "[[Kind]] Data"). - placeholder: '' - defaultValue: - '@path': $.traits.email - required: true - multiple: false - choices: null - dynamic: false - allowNull: false - - id: aaLduptsr3SCc3d7WPvjqZ - sortOrder: 2 - fieldKey: userID - label: Segment User ID - type: STRING - description: Permanent identifier of a Segment user the event is attributed to. - placeholder: '' - defaultValue: - '@path': $.userId - required: false - multiple: false - choices: null - dynamic: true - allowNull: false - - id: mzbFdTBgYkViRAh2oYpNmE - sortOrder: 3 - fieldKey: anonymousID - label: Segment Anonymous User ID - type: STRING - description: >- - A pseudo-unique substitute for a Segment user ID the event is - attributed to. - placeholder: '' - defaultValue: - '@path': $.anonymousId - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: iAifMkh4W6JVqRUJoiNbjq - sortOrder: 4 - fieldKey: email - label: Email - type: STRING - description: Identified email of the Segment User. - placeholder: '' - defaultValue: - '@if': - exists: - '@path': $.traits.email - then: - '@path': $.traits.email - else: - '@path': $.properties.email - required: true - multiple: false - choices: null - dynamic: false - allowNull: false - - id: 7y4TgkCWGjt6CB2nNySSZS - sortOrder: 5 - fieldKey: url - label: URL - type: STRING - description: URL associated with the event. - placeholder: '' - defaultValue: - '@if': - exists: - '@path': $.properties.url - then: - '@path': $.properties.url - else: - '@path': $.context.page.url - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: 6S2hb8s1S5MzLneB2NNppX - sortOrder: 6 - fieldKey: referrerUrl - label: Referrer URL - type: STRING - description: Referrer URL associated with the event. - placeholder: '' - defaultValue: - '@if': - exists: - '@path': $.properties.referrer - then: - '@path': $.properties.referrer - else: - '@path': $.context.page.referrer - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: iASqXrf9YaiCnfmmogjtzr - sortOrder: 7 - fieldKey: userAgent - label: User Agent - type: STRING - description: User Agent associated with the event. - placeholder: '' - defaultValue: - '@path': $.context.userAgent - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: gP6npbA7BHCrmHYx12fy3N - sortOrder: 8 - fieldKey: timestamp - label: Event Timestamp - type: DATETIME - description: When the event was sent. - placeholder: '' - defaultValue: - '@path': $.timestamp - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: cW5se7hugtwnXZn2yfv9xq - sortOrder: 9 - fieldKey: values - label: Custom Attribute Values - type: OBJECT - description: >- - Custom attribute values associated with the SalesWings custom - event. - placeholder: '' - defaultValue: - '@path': $.traits - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: aQRJAhhMd9sWpMcJkv7HLf - sortOrder: 10 - fieldKey: enable_batching - label: Enable Batching? - type: BOOLEAN - description: When enabled, Segment will send events in batches. - defaultValue: false - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: tvwDX96FJ1HhbffEAQ6WL6 - name: Submit Track Event - slug: submitTrackEvent - description: >- - Send your Segment Track events to SalesWings to use them for tagging, - scoring and prioritising your leads. - platform: CLOUD - hidden: false - defaultTrigger: type = "track" - fields: - - id: 76ahGUcmJ2AWfSdHT9Bnq6 - sortOrder: 0 - fieldKey: kind - label: Custom Event Kind - type: STRING - description: >- - Type of the SalesWings custom event (a custom event is visualized - in SalesWings cockpit and SalesForce Lead Intent View as "[[Kind]] - Data"). - placeholder: '' - defaultValue: Track - required: true - multiple: false - choices: null - dynamic: false - allowNull: false - - id: 44kprWDdsvooBedfwPSx2b - sortOrder: 1 - fieldKey: data - label: Custom Event Data - type: STRING - description: >- - String description of the SalesWings custom event payload (a - custom event is visualized in SalesWings cockpit and SalesForce - Lead Intent View as "[[Kind]] Data"). - placeholder: '' - defaultValue: - '@path': $.event - required: true - multiple: false - choices: null - dynamic: false - allowNull: false - - id: vkFdrLZJ7iKFbTbyhAkQdj - sortOrder: 2 - fieldKey: userID - label: Segment User ID - type: STRING - description: Permanent identifier of a Segment user the event is attributed to. - placeholder: '' - defaultValue: - '@path': $.userId - required: false - multiple: false - choices: null - dynamic: true - allowNull: false - - id: aj4oSZMdUFdqZaPAh5xvmA - sortOrder: 3 - fieldKey: anonymousID - label: Segment Anonymous User ID - type: STRING - description: >- - A pseudo-unique substitute for a Segment user ID the event is - attributed to. - placeholder: '' - defaultValue: - '@path': $.anonymousId - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: bq8nMgDpjLBCr7sJY1zYtu - sortOrder: 4 - fieldKey: email - label: Email - type: STRING - description: Identified email of the Segment User. - 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: 574LABKpU116JQi64QQNL1 - sortOrder: 5 - fieldKey: url - label: URL - type: STRING - description: URL associated with the event. - placeholder: '' - defaultValue: - '@if': - exists: - '@path': $.properties.url - then: - '@path': $.properties.url - else: - '@path': $.context.page.url - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: tvc8d789qLNJJ4JQZZyv79 - sortOrder: 6 - fieldKey: referrerUrl - label: Referrer URL - type: STRING - description: Referrer URL associated with the event. - placeholder: '' - defaultValue: - '@if': - exists: - '@path': $.properties.referrer - then: - '@path': $.properties.referrer - else: - '@path': $.context.page.referrer - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: tYXFuGeL1xFKwAWAz1yzKb - sortOrder: 7 - fieldKey: userAgent - label: User Agent - type: STRING - description: User Agent associated with the event. - placeholder: '' - defaultValue: - '@path': $.context.userAgent - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: 2svzmpzsND9eP2kJGWPFc9 - sortOrder: 8 - fieldKey: timestamp - label: Event Timestamp - type: DATETIME - description: When the event was sent. - placeholder: '' - defaultValue: - '@path': $.timestamp - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: cYSX75LoGemoYoTXoQaKta - sortOrder: 9 - fieldKey: values - label: Custom Attribute Values - type: OBJECT - description: >- - Custom attribute values associated with the SalesWings custom - event. - placeholder: '' - defaultValue: - '@path': $.properties - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: t3dN4bmBCgYvXHHbTigNQT - sortOrder: 10 - fieldKey: enable_batching - label: Enable Batching? - type: BOOLEAN - description: When enabled, Segment will send events in batches. - defaultValue: false - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - presets: - - actionId: jomy8pCbr3SMkdYiYKsBks - name: Submit Screen Event - fields: - kind: Screen - data: - '@path': $.name - userID: - '@path': $.userId - anonymousID: - '@path': $.anonymousId - email: - '@if': - exists: - '@path': $.traits.email - then: - '@path': $.traits.email - else: - '@path': $.properties.email - url: - '@if': - exists: - '@path': $.properties.url - then: - '@path': $.properties.url - else: - '@path': $.context.page.url - referrerUrl: - '@if': - exists: - '@path': $.properties.referrer - then: - '@path': $.properties.referrer - else: - '@path': $.context.page.referrer - userAgent: - '@path': $.context.userAgent - timestamp: - '@path': $.timestamp - values: - '@path': $.properties - trigger: type = "screen" - - actionId: i9ZPqNUo8Qejn8ua5rzkHC - name: Submit Page Event - fields: - userID: - '@path': $.userId - anonymousID: - '@path': $.anonymousId - url: - '@if': - exists: - '@path': $.properties.url - then: - '@path': $.properties.url - else: - '@path': $.context.page.url - referrerUrl: - '@if': - exists: - '@path': $.properties.referrer - then: - '@path': $.properties.referrer - else: - '@path': $.context.page.referrer - userAgent: - '@path': $.context.userAgent - timestamp: - '@path': $.timestamp - trigger: type = "page" - - actionId: njFVJdPY788RCrzBySAwpc - name: Submit Identify Event - fields: - kind: Identify - data: - '@path': $.traits.email - userID: - '@path': $.userId - anonymousID: - '@path': $.anonymousId - email: - '@if': - exists: - '@path': $.traits.email - then: - '@path': $.traits.email - else: - '@path': $.properties.email - url: - '@if': - exists: - '@path': $.properties.url - then: - '@path': $.properties.url - else: - '@path': $.context.page.url - referrerUrl: - '@if': - exists: - '@path': $.properties.referrer - then: - '@path': $.properties.referrer - else: - '@path': $.context.page.referrer - userAgent: - '@path': $.context.userAgent - timestamp: - '@path': $.timestamp - values: - '@path': $.traits - trigger: type = "identify" - - actionId: tvwDX96FJ1HhbffEAQ6WL6 - name: Submit Track Event - fields: - kind: Track - data: - '@path': $.event - userID: - '@path': $.userId - anonymousID: - '@path': $.anonymousId - email: - '@if': - exists: - '@path': $.traits.email - then: - '@path': $.traits.email - else: - '@path': $.properties.email - url: - '@if': - exists: - '@path': $.properties.url - then: - '@path': $.properties.url - else: - '@path': $.context.page.url - referrerUrl: - '@if': - exists: - '@path': $.properties.referrer - then: - '@path': $.properties.referrer - else: - '@path': $.context.page.referrer - userAgent: - '@path': $.context.userAgent - timestamp: - '@path': $.timestamp - values: - '@path': $.properties - trigger: type = "track" - id: 643fdf094cfdbcf1bcccbc42 display_name: Usermaven (Actions) name: Usermaven (Actions) diff --git a/src/_data/catalog/regional-supported.yml b/src/_data/catalog/regional-supported.yml index cdc3cdec99..a57fd80886 100644 --- a/src/_data/catalog/regional-supported.yml +++ b/src/_data/catalog/regional-supported.yml @@ -138,6 +138,15 @@ sources: - us endpoints: - us + - id: 2QEQGbmIJv + display_name: b2_testsource + hidden: false + slug: b2_testsource + url: connections/sources/catalog/cloud-apps/b2_testsource + regions: + - us + endpoints: + - us - id: ErcsNGMEwt display_name: Beamer hidden: false @@ -597,6 +606,17 @@ sources: endpoints: - us - eu + - id: VfR29KdimB + display_name: jAvascript + hidden: false + slug: javascript + url: connections/sources/catalog/cloud-apps/javascript + regions: + - us + - eu + endpoints: + - us + - eu - id: IqDTy1TpoU display_name: Javascript hidden: false @@ -608,6 +628,17 @@ sources: endpoints: - us - eu + - id: zZjAgSjgHi + display_name: jAvascript + hidden: false + slug: javascript + url: connections/sources/catalog/cloud-apps/javascript + regions: + - us + - eu + endpoints: + - us + - eu - id: V2kq0X7vYy display_name: Jebbit hidden: false @@ -1037,7 +1068,7 @@ sources: - us - id: d81EwdLbU4 display_name: Rehook - hidden: true + hidden: false slug: rehook url: connections/sources/catalog/cloud-apps/rehook regions: @@ -1171,6 +1202,15 @@ sources: - us endpoints: - us + - id: 5sm7ImJ0LJ + display_name: sourceTest + hidden: false + slug: sourcetest + url: connections/sources/catalog/cloud-apps/sourcetest + regions: + - us + endpoints: + - us - id: 4a8HuWDG3Y display_name: SRC hidden: true @@ -1400,6 +1440,15 @@ sources: - us endpoints: - us + - id: cCCwrwHZoD + display_name: Unlocking Attribution + hidden: false + slug: unlocking-attribution + url: connections/sources/catalog/cloud-apps/unlocking-attribution + regions: + - us + endpoints: + - us - id: FOkpxVzfJJ display_name: Vero hidden: false diff --git a/src/_data/catalog/source_categories.yml b/src/_data/catalog/source_categories.yml index 4a2af06e19..d676067df0 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 2023-08-03 +# source categories last updated 2023-08-08 items: - display_name: A/B Testing slug: a-b-testing @@ -7,6 +7,8 @@ items: slug: advertising - display_name: Analytics slug: analytics + - display_name: Attribution + slug: attribution - display_name: CRM slug: crm - display_name: Custom diff --git a/src/_data/catalog/sources.yml b/src/_data/catalog/sources.yml index 1c453409a1..10f6499484 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 2023-08-03 +# sources last updated 2023-08-08 items: - id: 8HWbgPTt3k display_name: .NET @@ -257,6 +257,21 @@ items: url: https://cdn.filepicker.io/api/file/XPJlunLQQmWPphponSEP categories: - Email Marketing + - id: 2QEQGbmIJv + display_name: b2_testsource + isCloudEventSource: true + slug: b2_testsource + url: connections/sources/catalog/cloud-apps/b2_testsource + hidden: false + regions: + - us + endpoints: + - us + source_type: cloud-app + description: '' + logo: + url: '' + categories: [] - id: ErcsNGMEwt display_name: Beamer isCloudEventSource: true @@ -1140,6 +1155,23 @@ items: url: https://cdn.filepicker.io/api/file/b5MOShMSL6Qks2ypoVuy categories: - Server + - id: VfR29KdimB + display_name: jAvascript + isCloudEventSource: true + slug: javascript + url: connections/sources/catalog/cloud-apps/javascript + hidden: false + regions: + - us + - eu + endpoints: + - us + - eu + source_type: cloud-app + description: '' + logo: + url: '' + categories: [] - id: IqDTy1TpoU display_name: Javascript isCloudEventSource: false @@ -1162,6 +1194,23 @@ items: url: https://cdn.filepicker.io/api/file/aRgo4XJQZausZxD4gZQq categories: - Website + - id: zZjAgSjgHi + display_name: jAvascript + isCloudEventSource: true + slug: javascript + url: connections/sources/catalog/cloud-apps/javascript + hidden: false + regions: + - us + - eu + endpoints: + - us + - eu + source_type: cloud-app + description: '' + logo: + url: '' + categories: [] - id: V2kq0X7vYy display_name: Jebbit isCloudEventSource: true @@ -1932,7 +1981,7 @@ items: isCloudEventSource: true slug: rehook url: connections/sources/catalog/cloud-apps/rehook - hidden: true + hidden: false regions: - us endpoints: @@ -2127,6 +2176,21 @@ items: url: https://cdn.filepicker.io/api/file/JrQWOYvMRRCVvSHp4HL0 categories: - Warehouse + - id: 5sm7ImJ0LJ + display_name: sourceTest + isCloudEventSource: true + slug: sourcetest + url: connections/sources/catalog/cloud-apps/sourcetest + hidden: false + regions: + - us + endpoints: + - us + source_type: cloud-app + description: '' + logo: + url: '' + categories: [] - id: 4a8HuWDG3Y display_name: SRC isCloudEventSource: true @@ -2256,6 +2320,27 @@ items: url: https://cdn.filepicker.io/api/file/TrFnszJ7Rj6LNZTt4kP5 categories: - Mobile + - id: cCCwrwHZoD + display_name: Unlocking Attribution + isCloudEventSource: true + slug: unlocking-attribution + url: connections/sources/catalog/cloud-apps/unlocking-attribution + hidden: false + regions: + - us + endpoints: + - us + source_type: cloud-app + description: >- + Unlocking Attribution takes all your usage data stored within Segment, + joins it to your paid media spend data (such as Google and Meta) and + determines which of your inbound channels are most effectively driving + your business. + logo: + url: https://cdn.filepicker.io/api/file/qkACXlPTS6i7AdJ98Yy3 + categories: + - Attribution + - Analytics - id: FOkpxVzfJJ display_name: Vero isCloudEventSource: true diff --git a/src/_data/products.yml b/src/_data/products.yml index cb5b66bca2..4a9e8cfe02 100644 --- a/src/_data/products.yml +++ b/src/_data/products.yml @@ -92,6 +92,7 @@ items: add-on: false - product_display_name: Audit Trail slug: audit-trail + plan-note: "Audit Trail is available as an add-on for customers with the Business plan." plans: free: false team: false @@ -154,3 +155,4 @@ items: team: true business: true add-on: false + diff --git a/src/connections/destinations/actions.md b/src/connections/destinations/actions.md index 2d1bcd5666..9858d38cce 100644 --- a/src/connections/destinations/actions.md +++ b/src/connections/destinations/actions.md @@ -1,9 +1,8 @@ --- title: Destination Actions +plan: dest-actions --- -{% include content/plan-grid.md name="dest-actions" %} - The Destination Actions framework improves on classic destinations by enabling you to see and control how Segment sends the event data it receives from your sources, to actions-based destinations. Each Action in a destination lists the event data it requires, and the event data that is optional. You can also choose which event types, event names, or event property values trigger an Action. These Triggers and mappings make it possible to send different versions of the Action, depending on the context from which it is triggered. diff --git a/src/connections/destinations/catalog/actions-fullstory-cloud/index.md b/src/connections/destinations/catalog/actions-fullstory-cloud/index.md index abf4731767..6d1f1f1400 100644 --- a/src/connections/destinations/catalog/actions-fullstory-cloud/index.md +++ b/src/connections/destinations/catalog/actions-fullstory-cloud/index.md @@ -21,8 +21,10 @@ FullStory’s cloud mode destination requires that you also use FullStory’s ta The FullStory cloud mode destination sends information about your users and related events to FullStory. It uses [FullStory’s REST APIs](https://developer.fullstory.com){:target="_blank"}. -- **Identify User:** Converts Segment [Identify](/docs/connections/spec/identify/) calls to [FullStory Set User Properties API calls](https://developer.fullstory.com/set-user-properties){:target="_blank"}. Use this to set custom attributes which can be used to search and segment within FullStory. +- **Identify User**: Converts Segment [Identify](/docs/connections/spec/identify/) calls to [FullStory Set User Properties API calls](https://developer.fullstory.com/set-user-properties){:target="_blank"}. Use this to set custom attributes which can be used to search and segment within FullStory. - **Track Custom Event**: Converts Segment [Track](/docs/connections/spec/track/) calls to [FullStory custom event API calls](https://developer.fullstory.com/server-events){:target="_blank"}. Use this to capture more context about your user’s experience on your site or to capture user’s actions in other applications to build a more complete understanding of your user’s overall experience. +- **Identify User V2**: Converts Segment [Identify](/docs/connections/spec/identify/) calls to [FullStory Create User API calls](https://developer.fullstory.com/server/v2/users/create-user/){:target="_blank"}. Use this to upsert a user and their attributes which can be used to search and segment within FullStory. +- **Track Custom Event V2**: Converts Segment [Track](/docs/connections/spec/track/) calls to [FullStory Create Event API calls](https://developer.fullstory.com/server/v2/events/create-events/){:target="_blank"}. Use this to capture more context about your user’s experience on your site or to capture user’s actions in other applications to build a more complete understanding of your user’s overall experience. ### Benefits of FullStory Cloud Mode (Actions) @@ -48,8 +50,15 @@ The FullStory cloud mode destination sends information about your users and rela ### Why am I getting a ‘404 Not Found’ error? -The user for which the API request is being made can not be found in the identified set of users within your FullStory organization. If you expect that user to already exist, you can search for that User ID in FullStory to confirm. Also, double check that you are using an API key from the same organization. +If you are using the original 'Identify User' and 'Track Event' actions and encounter a "404 Not Found" error, the user for which the API request is being made can not be found in the identified set of users within your FullStory organization. If you expect that user to already exist, you can search for that User ID in FullStory to confirm. Also, double check that you are using an API key from the same organization. Data sent server-side for users must match an already existing userId that was sent from a client-side connection. +The new 'Identify User V2' and 'Track Event V2' actions will automatically create users when a user matching the +provided UID is not found. + +### Why can't I propagate GDPR deletions? + +GDPR deletions require an `Admin` or `API` key to propagate. You may also contact FullStory directly for deletions. + {% include components/actions-fields.html %} diff --git a/src/connections/destinations/catalog/actions-hubspot-cloud/index.md b/src/connections/destinations/catalog/actions-hubspot-cloud/index.md index ceceb9f941..c5bf75cfdd 100644 --- a/src/connections/destinations/catalog/actions-hubspot-cloud/index.md +++ b/src/connections/destinations/catalog/actions-hubspot-cloud/index.md @@ -12,7 +12,7 @@ versions: {% include content/plan-grid.md name="actions" %} -HubSpot is an all-in-one marketing tool that helps attract new leads and converts them into paying customers, with features like landing page creation and email automation. +HubSpot is an all-in-one marketing tool that helps attract new leads and converts them into paying customers, with features like landing page creation and email automation. When you use the HubSpot Cloud Mode (Actions) destination, Segment sends your data to [HubSpot's REST API](https://developers.hubspot.com/docs/api/overview){:target="_blank"}. @@ -34,6 +34,11 @@ HubSpot Cloud Mode (Actions) provides the following benefits over the classic Hu ## Getting started +> info "" +> Before you begin, you need to generate a Private App in HubSpot. To generate a Private App from the HubSpot dashboard, navigate to **Integrations > Private Apps**. +> +> Segment requires the following scopes: `business-intelligence`, `crm.objects.contacts.read`, `crm.objects.contacts.write`, `crm.schemas.contacts.read`, `crm.objects.companies.read`, `crm.objects.companies.write`, and `crm.schemas.companies.read`. For more information, see HubSpot's [Private Apps](https://developers.hubspot.com/docs/api/private-apps){:target="_blank"} article. + 1. From the Segment web app, navigate to **Connections > Catalog**. 2. Search for **HubSpot Cloud Mode (Actions)** in the Destinations Catalog, and select the destination. 3. Click **Configure HubSpot Cloud Mode (Actions)**. @@ -58,7 +63,7 @@ Search Fields to associate | This finds a unique record of custom object based ObjectType to associate | To associate the newly created and updated custom object record with another object type, select the object type you want it to be associated with. Association Label | Select an association label between both the object types. From the HubSpot Dashboard, you can create associations between any type of object. To create an association label:
1. Log in to the [HubSpot Dashboard](https://app.hubspot.com/){:target="_blank"}.
2. Go to **Data Management > Objects > Custom Objects**.
3. Go to the **Associations** tab and click **Create association label**. -## FAQ & Troubleshooting +## FAQ and troubleshooting ### How do I send other standard objects to HubSpot? Segment provides prebuilt mappings for contacts and companies. If there are other standard objects you would like to create records in, please use the **Create Custom Object Record** action. For example, to create a deal in HubSpot, add a mapping for Create Custom Object Record, set up your Event Trigger criteria, and input a literal string of "deals" as the Object Type. You can use the Properties object to add fields that are in the [deals object](https://developers.hubspot.com/docs/api/crm/deals){:target="_blank"}, such as `dealname` and `dealstage`. The same can be done with other object types (for example, tickets, quotes, etc). Ending fields that are to go to HubSpot outside of the properties object isn't supported. This includes sending [associations](https://developers.hubspot.com/docs/api/crm/associations){:target="_blank"}. Please note, Segment only supports creating new records in these cases; updates to existing records are only supported for contacts and companies. diff --git a/src/connections/destinations/catalog/braze-cloud-mode-actions/index.md b/src/connections/destinations/catalog/braze-cloud-mode-actions/index.md index 8d3758cc6a..e3bf0c7e5d 100644 --- a/src/connections/destinations/catalog/braze-cloud-mode-actions/index.md +++ b/src/connections/destinations/catalog/braze-cloud-mode-actions/index.md @@ -44,3 +44,8 @@ Braze Cloud Mode (Actions) provides the following benefit over Braze Classic: Keep the following in mind if you plan to move to Braze (Actions) from the classic Braze destination. {% include components/actions-map-table.html name="braze-cloud" %} + +## Troubleshooting + +### Missing required fields +Braze requires one of either `external_id`, `user_alias`, or `braze_id` to be present in all events sent. If events are failing to send, please check your event mappings to make sure these fields are resolving to valid values. diff --git a/src/connections/destinations/catalog/impact-partnership-cloud/index.md b/src/connections/destinations/catalog/impact-partnership-cloud/index.md index 3296645fcd..afad89e518 100644 --- a/src/connections/destinations/catalog/impact-partnership-cloud/index.md +++ b/src/connections/destinations/catalog/impact-partnership-cloud/index.md @@ -5,7 +5,7 @@ id: 5ed96e0b97e7ba0c0346cc04 --- [Impact Partnership Cloud](https://impact.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) lets you expand your program and scale every type of partnership by managing the partnership lifecycle - from discovery, contracting and payments through tracking and optimization. -This destination is maintained by Impact. For any issues with the destination, contact the [Impact Partnership Cloud team](https://impact.com/contact/) or check out [Impact Partnership Cloud's documentation](https://app.impact.com/secure/agency/support/customer-support-portal-flow.ihtml?execution=e3s1). +This destination is maintained by Impact. For any issues with the destination, contact the [Impact Partnership Cloud team](https://impact.com/contact/){:target="_blank”} or check out [Impact Partnership Cloud's documentation](https://integrations.impact.com/impact-brand/docs/integrate-with-segment){:target="_blank”}. ## Getting Started diff --git a/src/connections/functions/insert-functions.md b/src/connections/functions/insert-functions.md index 3f6bc3da42..388cb913a1 100644 --- a/src/connections/functions/insert-functions.md +++ b/src/connections/functions/insert-functions.md @@ -199,6 +199,9 @@ You can manually test your code from the functions editor: - Error messages display errors surfaced from your function. - Logs display any messages to console.log() from the function. +- > info "" +> The Event Tester won't make use of an Insert Function, show how an Insert Function impacts your data, or send data downstream through the Insert Function pipeline. + ## Save and deploy the destination insert function Once you finish building your insert function, click **Next: Configure & Create** to name it, then click **Create Function** to save it. diff --git a/src/connections/sources/catalog/cloud-apps/facebook-ads/index.md b/src/connections/sources/catalog/cloud-apps/facebook-ads/index.md index 2ec9c13e4c..c442d55971 100644 --- a/src/connections/sources/catalog/cloud-apps/facebook-ads/index.md +++ b/src/connections/sources/catalog/cloud-apps/facebook-ads/index.md @@ -57,7 +57,7 @@ Collections are the groupings of resources we pull from your source. In your war ## Collection Properties -Below are tables outlining the properties included in the collections listed above. +The following tables outline the properties included in collections. ### Ad Accounts @@ -123,20 +123,33 @@ Below are tables outlining the properties included in the collections listed abo | clicks | The number of clicks on your ads. | | date_start | The start date for your data. | | date_stop | The end date for your data. | -| ~~deeplink_clicks~~ | *Deprecated by Facebook.* Aliased to `click_to_app_deeplink`. | -| ~~website_clicks~~ | *Deprecated by Facebook.* Aliased to `click_to_website` | | frequency | The average number of times each person saw your ad. | | impressions | The number of times your ads were on screen. | | inline_post_engagements | The total number of actions that people take involving your ads. | -| ~~social_clicks~~ | *Deprecated by Facebook.* The number of clicks (all) when your ad was displayed with social information. | -| ~~social_impressions~~ | *Deprecated by Facebook.* The number of times your ads were viewed when displayed with social information. | | social_spend | The total amount you've spent so far for your ads showed with social information. | | spend | The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. | | unique_clicks | The number of people who performed a click (all). This metric is estimated. | | unique_impressions | Deprecated in favor of `reach` . You can continue to query `unique_impressions` for this metric, but zero-values will now be `null`. | -| ~~unique_social_clicks~~ | *Deprecated by Facebook.* The number of people who performed a click (all) on your ad when it was displayed with social information. | | reach | The number of people who saw your ads at least once. Reach is different from impressions, which may include multiple views of your ads by the same people. | -| ~~call_to_action_clicks~~ | *Deprecated by Facebook.* The number of times people clicked the call-to-action button on your ad. | + +#### Insights Breakdowns + +Segment also supports Breakdowns for Insights. Breakdowns are not enabled by default; [reach out to Segment support](https://segment.com/help/contact/){:target="_blank"} to enable them. Segment supports the following properties: + +| Property Name | Description | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | +| `actions` | The total number of actions people took that are attributed to your ads. | +| `actions_values` | The total value of all conversions attributed to your ads. | +| `unique_actions` | The total number of unique actions attributed to your ads. | +| `video_p25_watched_actions` | The number of times your video played at 25% of its length, including plays that skipped to this point. | +| `video_p50_watched_actions` | The number of times your video played at 50% of its length, including plays that skipped to this point. | +| `video_p75_watched_actions` | The number of times your video played at 75% of its length, including plays that skipped to this point. | +| `video_p95_watched_actions` | The number of times your video played at 95% of its length, including plays that skipped to this point. | +| `video_p100_watched_actions` | The number of times your video played at 100% of its length, including plays that skipped to this point. | +| `video_30_sec_watched_actions` | The number of times your video played for at least 30 seconds, or for nearly its total length if it's shorter than 30 seconds. | +| `video_avg_time_watched_actions` | The average time a video played, including any time spent replaying the video for a single impression. | + +For more information, view [Meta's Insights documentation](https://developers.facebook.com/docs/marketing-api/reference/ads-insights/){:target="_blank"}. ## Adding Destinations diff --git a/src/connections/sources/catalog/cloud-apps/listrak/index.md b/src/connections/sources/catalog/cloud-apps/listrak/index.md index 1fe55e14f3..b4f254fdf7 100644 --- a/src/connections/sources/catalog/cloud-apps/listrak/index.md +++ b/src/connections/sources/catalog/cloud-apps/listrak/index.md @@ -50,10 +50,13 @@ The table below lists events that Listrak sends to Segment. These events appear Event Name | Description ------------ | ------------- -Email Opened | The recipient opened the email. -Email Link Clicked | The recipient clicked on a link in the email's body. Email Bounced | The email servers rejected the email. Email Converted | The recipient placed an order after clicking on the email. +Email Link Clicked | The recipient clicked on a link in the email's body. +Email Marked As Spam | The recipient marked an email as spam. +Email Opened | The recipient opened the email. +Email Sent | An email was sent to the recipient. +Unsubscribed | The recipient unsubscribed from the email list. ## Event Properties @@ -70,6 +73,7 @@ Property Name | Description `list_id` | An ID used to identify a list. `list_name` | A name used to identify a list. `order_total` | The order total associated with the conversion. +`unsubscribe_type` | The method by which the contact was removed from the list. See the [Unsubscribed Contacts Report Help Article](https://help.listrak.com/en/articles/1550570-unsubscribed-contacts-report#unsubscribe-method-definitions). `context.ip` | The opening computer’s public IP address. `context.traits.email` | The intended recipient’s email address. `context.user_agent` | The opening browser’s user agent. diff --git a/src/connections/sources/catalog/cloud-apps/marketo/index.md b/src/connections/sources/catalog/cloud-apps/marketo/index.md index 96abf99840..a3d63bbc65 100644 --- a/src/connections/sources/catalog/cloud-apps/marketo/index.md +++ b/src/connections/sources/catalog/cloud-apps/marketo/index.md @@ -278,36 +278,32 @@ Currently, Warehouses are the only supported destination for object-cloud source ## FAQs -### How many API calls will the Segment source use? +### How many API calls will the Segment source use to sync all my data? -The Marketo API has different limits for the number of objects returned by different endpoints, but usually 100-300 objects per call. +Segment doesn't provide statistics for these consumed API calls, since Segment systems only log the number of objects pulled from Marketo as throughput. -At set up time, you have the option to specify a cap to the API calls that a source can consume. If no cap is specified, Segment consumes as many API calls that are available to sync the entire source. +### Can I limit API usage on the source? -Segment uses the Lead Activities bulk API to reduce the number of requests needed to sync the data; this however, also has a limit of 500MB worth of files downloaded per day. +Yes. You can specific a daily limit to the API calls the source will consume. If you don't set a limit, Segment will, by default, consume as many API calls as are available in the limit you agreed to with Marketo to sync the entire source. -If your source requires more than 10k calls or over 500MB from the bulk API to sync, Segment continues the sync the following day when a new batch of API calls are available. +Segment also uses the `Lead` and `Activity` [Bulk Extract APIs](https://developers.marketo.com/rest-api/bulk-extract/){:target="_blank"} to reduce the number of requests needed to sync the data. For these syncs, Segment has a limit of 500 MB worth of files downloaded per day. -If you have other applications that use the Marketo API, this can interfere with their ability to make requests. +### What if my daily Marketo API quota isn't enough? -### What Marketo API are you using? +If your source needs more than 10,000 REST API calls or more than 500 MB of data to sync, Segment will continue the sync when a new batch of API calls is available. -Segment uses the REST API in most situations, but also uses the Lead Activity Bulk API to reduce the number of requests needed to sync. +Marketo's API quota applies across your subscription. If other applications share the quota, it could interfere with Segment's ability to sync the source. -### Can I get other collections not default synced by the source? +### Why can't I find the `lead_activities` table in my data warehouse? does Segment not ingest it? -[Contact Support](https://segment.com/help/contact/) to request additional collections. +You first need to enable the **Activity Type IDs (optional)** setting in the Marketo source, which must be enabled for Segment to pull the `lead_activities` collection source. Once Segment pulls the data, it will be available in your data warehouses. -### Can I get other columns not default synced by the source? -For leads and activities, Segment added a custom fields setting where you can enter comma-separated custom fields to sync by their REST API name. +### Can I get other collections synced by the source? -By default, Segment syncs the following fields on the leads collection: +[Contact Support](https://segment.com/help/contact/){:target="_blank"} to get additional collections added to your source. -- `id` -- `email` -- `firstName` -- `lastName` -- `createdAt` -- `updatedAt` +### Can I get other columns synced by the source? -You can find a full list of standard fields and their REST API names [here](http://developers.marketo.com/rest-api/lead-database/fields/list-of-standard-fields/). If there are other fields you're interested in, [contact support](https://segment.com/help/contact/) for assistance. +Yes. For `leads` and `activities`, choose **Custom Lead Fields (optional)**, which lets you enter comma-separated custom files that will be synced by Marketo's REST API name. + +View [Marketo's List of Standard Fields documentation](http://developers.marketo.com/rest-api/lead-database/fields/list-of-standard-fields/){:target="_blank"} for a complete list of standard fields and Marketo's REST API names. [Reach out to Segment support](https://segment.com/help/contact/){:target="_blank"} if you're interested in other fields. \ No newline at end of file diff --git a/src/connections/sources/catalog/cloud-apps/stripe/index.md b/src/connections/sources/catalog/cloud-apps/stripe/index.md index d58c47c234..dc3f9bfd9a 100644 --- a/src/connections/sources/catalog/cloud-apps/stripe/index.md +++ b/src/connections/sources/catalog/cloud-apps/stripe/index.md @@ -226,17 +226,18 @@ Below are tables outlining the properties included in the collections listed abo ### coupons -| Property Name | Description | -| -------------------- | ------------------------------------------------------------------------------------------------------------ | -| `amount_off` | Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer | -| `currency` | The three-letter ISO code for the currency of the amount to take off | -| `duration_in_months` | If duration is repeating, the number of months the coupon applies | -| `duration` | Describes how long a customer who applies this coupon will get the discount | -| `max_redemptions` | Maximum number of times this coupon can be redeemed, in total, before it is no longer valid | -| `metadata` | A set of key-value pairs that describe additional information about the object | -| `percent_off` | Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon | -| `times_redeemed` | Number of times this coupon has been applied to a customer | -| `valid` | Taking account of the above properties, whether this coupon can still be applied to a customer | +| Property Name | Description | +| --------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| `amount_off` | Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer | +| `currency` | The three-letter ISO code for the currency of the amount to take off | +| `duration_in_months` | If duration is repeating, the number of months the coupon applies | +| `duration` | Describes how long a customer who applies this coupon will get the discount | +| `max_redemptions` | Maximum number of times this coupon can be redeemed, in total, before it is no longer valid | +| `metadata` | A set of key-value pairs that describe additional information about the object | +| `percent_off` | Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon | +| `percent_off_precise` | Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon, in decimal form | +| `times_redeemed` | Number of times this coupon has been applied to a customer | +| `valid` | Taking account of the above properties, whether this coupon can still be applied to a customer | ### customers diff --git a/src/connections/sources/catalog/libraries/mobile/apple/destination-plugins/index.md b/src/connections/sources/catalog/libraries/mobile/apple/destination-plugins/index.md index 589b8857ee..ce0819ddac 100644 --- a/src/connections/sources/catalog/libraries/mobile/apple/destination-plugins/index.md +++ b/src/connections/sources/catalog/libraries/mobile/apple/destination-plugins/index.md @@ -26,6 +26,12 @@ plugins: url: https://cdn.filepicker.io/api/file/9kBQvmLRR22d365ZqKRK mark: url: https://cdn.filepicker.io/api/file/HrjOOkkLR8WrUc1gEeeG + - name: Bugsnag + url: connections/sources/catalog/libraries/mobile/apple/destination-plugins/bugsnag-swift + logo: + url: https://cdn.filepicker.io/api/file/GoTtwMELTeWGtu44SBUh + mark: + url: https://cdn.filepicker.io/api/file/1ttsQcwwRDGHBG3XjVFT - name: Facebook App Events url: connections/sources/catalog/libraries/mobile/apple/destination-plugins/facebook-app-events-swift/ logo: @@ -44,12 +50,6 @@ plugins: url: https://cdn.filepicker.io/api/file/pUF0kwpTTu0Z5POuzZXV mark: url: https://cdn.filepicker.io/api/file/0mdiroESxtRQBoR8ieBg - - name: Bugsnag - url: connections/sources/catalog/libraries/mobile/apple/destination-plugins/bugsnag-swift - logo: - url: https://cdn.filepicker.io/api/file/GoTtwMELTeWGtu44SBUh - mark: - url: https://cdn.filepicker.io/api/file/1ttsQcwwRDGHBG3XjVFT - name: Optimizely Full Stack url: connections/sources/catalog/libraries/mobile/apple/destination-plugins/optimizely-full-stack-swift logo: diff --git a/src/connections/sources/catalog/libraries/server/node/index.md b/src/connections/sources/catalog/libraries/server/node/index.md index 20b77e8b4a..647ba0aef7 100644 --- a/src/connections/sources/catalog/libraries/server/node/index.md +++ b/src/connections/sources/catalog/libraries/server/node/index.md @@ -282,9 +282,11 @@ Setting | Details `maxRetries` _number_ | The number of times to retry flushing a batch. The default is: `3` `maxEventsInBatch` _number_ | The number of messages to enqueue before flushing. The default is: `15` `flushInterval` _number_ | The number of milliseconds to wait before flushing the queue automatically. The default is: `10000` -`httpRequestTimeout` | The maximum number of milliseconds to wait for an http request. The default is: `10000` -`disable` | Disable the analytics library for testing. The default is: `false` -`httpClient` *Optional* | A custom AnalyticsHTTPClient implementation to support alternate libraries or proxies. Defaults to global fetch or node-fetch for older versions of node. +`httpRequestTimeout` _number_ | The maximum number of milliseconds to wait for an http request. The default is: `10000` +`disable` _boolean_ | Disable the analytics library for testing. The default is: `false` +`httpClient` _HTTPClient or HTTPClientFn_ | A custom HTTP Client implementation to support alternate libraries or proxies. Defaults to global fetch or node-fetch for older versions of node. See the [Overriding the default HTTP Client](#override-the-default-http-client) section for more details. + +See the complete `AnalyticsSettings` interface [here](https://github.com/segmentio/analytics-next/blob/master/packages/node/src/app/settings.ts){:target="_blank"}. ## Graceful shutdown Avoid losing events after shutting down your console. Call `.closeAndFlush()` to stop collecting new events and flush all existing events. If a callback on an event call is included, this also waits for all callbacks to be called, and any of their subsequent promises to be resolved. @@ -554,7 +556,7 @@ Different parts of your application may require different types of batching, or const marketingAnalytics = new Analytics({ writeKey: 'MARKETING_WRITE_KEY' }); const appAnalytics = new Analytics({ writeKey: 'APP_WRITE_KEY' }); ``` -## AnalyticsHTTPClient +## Override the default HTTP Client Segment attempts to use the global `fetch` implementation if available in order to support several diverse environments. Some special cases (for example, http proxy) may require a different implementation for http communication. You can provide a customized wrapper in the Analytics configuration to support this. Here are a few approaches: @@ -563,21 +565,21 @@ Use a custom fetch-like implementation with proxy (simple, recommended) import { HTTPFetchFn } from '../lib/http-client' import axios from 'axios' -const httpClient: HTTPFetchFn = async (url, options) => { - return axios({ +const httpClient: HTTPFetchFn = async (url, { body, ...options }) => + axios({ url, + data: body, proxy: { - protocol: 'http', - host: 'proxy.example.com', - port: 8886, - auth: { - username: 'user', - password: 'pass', - }, + protocol: 'http', + host: 'proxy.example.com', + port: 8886, + auth: { + username: 'user', + password: 'pass', }, + }, ...options, }) -} const analytics = new Analytics({ writeKey: '', @@ -591,8 +593,8 @@ import { FetchHTTPClient, HTTPClientRequest } from '@segment/analytics-node' class MyClient extends FetchHTTPClient { async makeRequest(options: HTTPClientRequest) { return super.makeRequest({ - ...options, - headers: { ...options.headers, foo: 'bar' } + ...options, + headers: { ...options.headers, foo: 'bar' } }}) } } diff --git a/src/connections/storage/data-lakes/comparison.md b/src/connections/storage/data-lakes/comparison.md index 7c4010e791..84662923e9 100644 --- a/src/connections/storage/data-lakes/comparison.md +++ b/src/connections/storage/data-lakes/comparison.md @@ -1,8 +1,7 @@ --- title: Comparing Data Lakes and Warehouses +plan: data-lakes --- -{% include content/plan-grid.md name="data-lakes" %} - As Segment builds new data storage products, each product evolves from prior products to best support the needs of customers. Segment Data Lakes is an evolution of the Warehouses product that meets the changing needs of customers. diff --git a/src/connections/storage/data-lakes/data-lakes-manual-setup.md b/src/connections/storage/data-lakes/data-lakes-manual-setup.md index 96f529b03f..ada35186a8 100644 --- a/src/connections/storage/data-lakes/data-lakes-manual-setup.md +++ b/src/connections/storage/data-lakes/data-lakes-manual-setup.md @@ -1,9 +1,8 @@ --- hidden: true title: Configure the Data Lakes AWS Environment +plan: data-lakes --- -{% include content/plan-grid.md name="data-lakes" %} - The instructions below will guide you through the process required to configure the environment required to begin loading data into your Segment Data Lake. For a more automated process, see [Set Up Segment Data Lakes](/docs/connections/storage/catalog/data-lakes). diff --git a/src/connections/storage/data-lakes/index.md b/src/connections/storage/data-lakes/index.md index 64d10f7d26..2d453951c3 100644 --- a/src/connections/storage/data-lakes/index.md +++ b/src/connections/storage/data-lakes/index.md @@ -1,10 +1,9 @@ --- title: Segment Data Lakes Overview redirect_from: '/connections/destinations/catalog/data-lakes/' +plan: data-lakes --- -{% include content/plan-grid.md name="data-lakes" %} - > warning "Segment Data Lakes (Azure) deletion policies" > Data deletion is not supported by Segment Data Lakes (Azure), as customers retain data in systems that they manage. diff --git a/src/connections/storage/data-lakes/lake-formation.md b/src/connections/storage/data-lakes/lake-formation.md index daee8e7855..7c5d4b12fc 100644 --- a/src/connections/storage/data-lakes/lake-formation.md +++ b/src/connections/storage/data-lakes/lake-formation.md @@ -1,9 +1,8 @@ --- title: Lake Formation +plan: data-lakes --- -{% include content/plan-grid.md name="data-lakes" %} - Lake Formation is a fully managed service built on top of the AWS Glue Data Catalog that provides one central set of tools to build and manage a Data Lake. These tools help import, catalog, transform, and deduplicate data, as well as provide strategies to optimize data storage and security. To learn more about Lake Formation features, see [Amazon Web Services documentation](https://aws.amazon.com/lake-formation/features/){:target="_blank"}. The security policies in Lake Formation use two layers of permissions: each resource is protected by Lake Formation permissions (which control access to Data Catalog resources and S3 locations) and IAM permissions (which control access to Lake Formation and AWS Glue API resources). When any user or role reads or writes to a resource, that action must pass a both a Lake Formation and an IAM resource check: for example, a user trying to create a new table in the Data Catalog may have Lake Formation access to the Data Catalog, but if they don't have the correct Glue API permissions, they will be unable to create the table. diff --git a/src/connections/storage/data-lakes/sync-history.md b/src/connections/storage/data-lakes/sync-history.md index 594f0b589d..63d5a2e5f6 100644 --- a/src/connections/storage/data-lakes/sync-history.md +++ b/src/connections/storage/data-lakes/sync-history.md @@ -1,7 +1,7 @@ --- title: Data Lakes Sync History and Health +plan: data-lakes --- -{% include content/plan-grid.md name="data-lakes" %} The Segment Data Lakes sync history and health tabs generate real-time information about data syncs so you can monitor the health and performance of your data lakes. These tools provide monitoring and debugging capabilities within the Data Lakes UI, so you can identify and proactively address data sync or data pipeline failures. diff --git a/src/connections/storage/data-lakes/sync-reports.md b/src/connections/storage/data-lakes/sync-reports.md index aa506dd87d..0649a3a6b6 100644 --- a/src/connections/storage/data-lakes/sync-reports.md +++ b/src/connections/storage/data-lakes/sync-reports.md @@ -1,8 +1,7 @@ --- title: Data Lakes Sync Reports and Errors +plan: data-lakes --- -{% include content/plan-grid.md name="data-lakes" %} - Segment Data Lakes generates reports with operational metrics about each sync to your data lake so you can monitor sync performance. These sync reports are stored in your S3 bucket and Glue Data Catalog. This means you have access to the raw data, so you can query it to answer questions and set up alerting and monitoring tools. diff --git a/src/connections/storage/warehouses/index.md b/src/connections/storage/warehouses/index.md index 233f741a3d..59fab788e1 100644 --- a/src/connections/storage/warehouses/index.md +++ b/src/connections/storage/warehouses/index.md @@ -1,10 +1,9 @@ --- title: Data Warehouses redirect_from: '/connections/warehouses/' +plan: warehouses --- -{% include content/plan-grid.md name="warehouses" %} - ## What's a Warehouse? {% include content/whats-a-warehouse.md %} diff --git a/src/guides/what-is-replay.md b/src/guides/what-is-replay.md index b4cdc09779..96c4dba2ef 100644 --- a/src/guides/what-is-replay.md +++ b/src/guides/what-is-replay.md @@ -1,9 +1,8 @@ --- title: Replay +plan: replay --- -{% include content/plan-grid.md name="replay" %} - Replay takes an archived copy of your Segment data, and re-sends it to new or existing tools. On the surface this doesn't sound like much, but this can grant huge benefits to mature data systems: By archiving and replaying data, you can avoid vendor lock-in, and protect your system against data loss. diff --git a/src/privacy/data-controls.md b/src/privacy/data-controls.md index a1feee92b9..ea4746c3a8 100644 --- a/src/privacy/data-controls.md +++ b/src/privacy/data-controls.md @@ -1,8 +1,7 @@ --- title: Privacy Controls & Alerts +plan: privacy --- -{% include content/plan-grid.md name="privacy" %} - The Privacy Portal gives you control over whether specific data is allowed to enter Segment. diff --git a/src/privacy/portal.md b/src/privacy/portal.md index 57b68dbf19..2678eb0e8e 100644 --- a/src/privacy/portal.md +++ b/src/privacy/portal.md @@ -1,7 +1,7 @@ --- title: Privacy Portal +plan: privacy --- -{% include content/plan-grid.md name="privacy" %} When preparing for new privacy regulations (like HIPAA, the GDPR, or the CCPA), the best practice is to create a comprehensive data inventory which includes details diff --git a/src/protocols/apis-and-extensions/anomaly_detection.md b/src/protocols/apis-and-extensions/anomaly_detection.md index 64d715909d..cd18bcaa7a 100644 --- a/src/protocols/apis-and-extensions/anomaly_detection.md +++ b/src/protocols/apis-and-extensions/anomaly_detection.md @@ -1,9 +1,8 @@ --- title: 'Anomaly Detection' +plan: protocols --- -{% include content/plan-grid.md name="protocols" %} - If you're using Protocols, you might want to get notifications when an anomaly in event volumes or [Protocols violation](/docs/protocols/validate/forward-violations/) counts occurs. This document clarifies what we mean by anomaly detection, gives examples of anomalies that might be relevant to your business, and provides some example solutions of how to monitor and alert on anomalies using some standard tools available today. ## What is anomaly detection? diff --git a/src/protocols/apis-and-extensions/index.md b/src/protocols/apis-and-extensions/index.md index d8f955c0cb..4bbfef8b4c 100644 --- a/src/protocols/apis-and-extensions/index.md +++ b/src/protocols/apis-and-extensions/index.md @@ -1,9 +1,8 @@ --- title: 'Protocols: APIs and Extensions' +plan: protocols --- -{% include content/plan-grid.md name="protocols" %} - Built from the ground up, Protocols addresses a wide range of customer needs. With Protocols, you can help engineers reduce tracking errors, create issue notifications, and get the most out of your Tracking Plan. Below, learn about several Protocols resources that can help you address these and other common use cases. diff --git a/src/protocols/enforce/forward-blocked-events.md b/src/protocols/enforce/forward-blocked-events.md index 7ea4892788..c87235999f 100644 --- a/src/protocols/enforce/forward-blocked-events.md +++ b/src/protocols/enforce/forward-blocked-events.md @@ -1,8 +1,7 @@ --- title: Forward blocked events +plan: protocols --- -{% include content/plan-grid.md name="protocols" %} - If you're concerned about permanently discarding blocked events, you can enable blocked event forwarding on a Segment Source. To set up forwarding, navigate to the settings tab of the Source, then Schema Configuration. diff --git a/src/protocols/enforce/schema-configuration.md b/src/protocols/enforce/schema-configuration.md index b23da2106a..5efe054747 100644 --- a/src/protocols/enforce/schema-configuration.md +++ b/src/protocols/enforce/schema-configuration.md @@ -1,10 +1,9 @@ --- title: Customize your schema controls redirect_from: '/protocols/enforce/' +plan: protocols --- -{% include content/plan-grid.md name="protocols" %} - The Schema Configuration settings for each source can be used to selectively block events, or omit properties and traits from `.track()`, `.identify()` and `.group()` calls. Segment can permanently drop events that are not included in your Tracking Plan, depending on the settings you select. Segment can also block events with invalid properties or invalid property values. > warning "Blocked events not forwarded to a Source are discarded" diff --git a/src/protocols/faq.md b/src/protocols/faq.md index f6939bf65e..d00bdd6824 100644 --- a/src/protocols/faq.md +++ b/src/protocols/faq.md @@ -1,10 +1,8 @@ --- title: Protocols Frequently Asked Questions +plan: protocols --- -{% include content/plan-grid.md name="protocols" %} - - ## Protocols Notifications ### How can I subscribe to Protocols notifications? diff --git a/src/protocols/tracking-plan/libraries.md b/src/protocols/tracking-plan/libraries.md index 32bc2279a3..e7f65c34a2 100644 --- a/src/protocols/tracking-plan/libraries.md +++ b/src/protocols/tracking-plan/libraries.md @@ -1,10 +1,8 @@ --- title: Tracking Plan Libraries +plan: protocols --- -{% include content/plan-grid.md name="protocols" %} - - Tracking Plan Libraries make it easy to scale Tracking Plan creation within your workspace. You can create libraries for track events or track event properties. Editing Tracking Plan Libraries is identical to [editing Tracking Plans](/docs/protocols/tracking-plan/create/). > note "" diff --git a/src/protocols/transform/index.md b/src/protocols/transform/index.md index 15aabc1342..5f7d2612cf 100644 --- a/src/protocols/transform/index.md +++ b/src/protocols/transform/index.md @@ -1,10 +1,9 @@ --- title: Use Transformations to fix bad data redirect_from: '/protocols/transformations/' +plan: protocols --- -{% include content/plan-grid.md name="protocols" %} - ## What is a Transformation? With Transformations, you can change data as it flows through Segment to either correct bad data or customize data for a specific destination. Change event and property names to align events with your Tracking Plan, or to conform to a destination-specific requirement. For example, you can create a Transformation to change an event name from `completed_order` to `Order Completed` to conform to [Segment's ecommerce spec](/docs/connections/spec/ecommerce/v2/#order-completed). diff --git a/src/protocols/validate/connect-sources.md b/src/protocols/validate/connect-sources.md index db6b3d956c..7a796449c9 100644 --- a/src/protocols/validate/connect-sources.md +++ b/src/protocols/validate/connect-sources.md @@ -1,11 +1,9 @@ --- title: Connect a Tracking Plan redirect_from: '/protocols/validate/' +plan: protocols --- -{% include content/plan-grid.md name="protocols" %} - - With your Tracking Plan complete, it's time to apply the Tracking Plan to one or more Sources. Select **Connect Source** from the right hand menu for your specific Tracking Plan. ![Screenshot of the Tracking Plans page, with the overflow menu selected.](../images/5763308453_Screen+Shot+2018-08-31+at+5.54.18+PM.png) diff --git a/src/protocols/validate/forward-violations.md b/src/protocols/validate/forward-violations.md index fab19d9cf3..2f1161009d 100644 --- a/src/protocols/validate/forward-violations.md +++ b/src/protocols/validate/forward-violations.md @@ -1,10 +1,8 @@ --- title: Forward Violations +plan: protocols --- -{% include content/plan-grid.md name="protocols" %} - - You can forward Violations (data that does not conform to your Protocols tracking plan) to a Segment Source to enable custom notifications, dashboards and further analysis in any Segment destination that accepts cloud-mode data. To set up forwarding, navigate to the settings tab of the Source, then Schema Configuration. Select the source you'll forward events to from the Forwarding Settings Violations dropdown. Similar to [Blocked Event forwarding](/docs/protocols/enforce/forward-blocked-events/), Segment recommends that you create a new Source for violations. diff --git a/src/protocols/validate/review-violations.md b/src/protocols/validate/review-violations.md index bfa66133a5..ac27dd13a5 100644 --- a/src/protocols/validate/review-violations.md +++ b/src/protocols/validate/review-violations.md @@ -1,10 +1,8 @@ --- title: Review and Resolve Event Violations +plan: protocols --- -{% include content/plan-grid.md name="protocols" %} - - Upon connecting your Tracking Plan to a Source, you will be able to view violations grouped by event. To view violations, click on the Violations button located on the Schema tab in a Source. A filter can be applied to only show events with violations within the past 24 hrs, 7 days and 30 days. diff --git a/src/segment-app/iam/audit-trail.md b/src/segment-app/iam/audit-trail.md index c71b860ea4..c089f07686 100644 --- a/src/segment-app/iam/audit-trail.md +++ b/src/segment-app/iam/audit-trail.md @@ -1,7 +1,7 @@ --- title: Audit Trail +plan: audit-trail --- -{% include content/plan-grid.md name="audit-trail" %} Segment offers an in-app 90 day Audit Trail for Business Tier accounts. If you are a Workspace Owner, you view user and system activity in your workspace settings, in the "Audit Trail" tab under "Admin". diff --git a/src/segment-app/iam/concepts.md b/src/segment-app/iam/concepts.md index 5a41f92f28..f36cda7275 100644 --- a/src/segment-app/iam/concepts.md +++ b/src/segment-app/iam/concepts.md @@ -1,8 +1,7 @@ --- title: Access Management Concepts +plan: iam --- -{% include content/plan-grid.md name="iam" %} - ## Team Members diff --git a/src/segment-app/iam/index.md b/src/segment-app/iam/index.md index 8ea81f8c91..fca396c63c 100644 --- a/src/segment-app/iam/index.md +++ b/src/segment-app/iam/index.md @@ -1,14 +1,11 @@ --- title: Identity & Access Management Overview redirect_from: '/segment-app/iam/add-a-team-member/' +plan: iam --- -{% include content/plan-grid.md name="iam" %} - Segment's access management tools let workspace owners manage which users can access different parts of their Segment workspaces. - - The Access Management page has three tabs: [Users (team members)](/docs/segment-app/iam/concepts/#team-members), [User Groups](/docs/segment-app/iam/concepts/#user-groups), and [Tokens](/docs/segment-app/iam/concepts/#tokens). You can select a user in the table to see their [roles](/docs/segment-app/iam/roles). ## Quick Links diff --git a/src/segment-app/iam/labels.md b/src/segment-app/iam/labels.md index 0b4c18e557..f7d80e6a7a 100644 --- a/src/segment-app/iam/labels.md +++ b/src/segment-app/iam/labels.md @@ -1,8 +1,7 @@ --- title: Using Label-Based Access Control +plan: iam --- -{% include content/plan-grid.md name="iam" %} - Labels allow workspace owners to assign permissions to users to grant them access to groups. Groups represent collections of Sources, or collections of Spaces. diff --git a/src/segment-app/iam/membership.md b/src/segment-app/iam/membership.md index 41292b2ad3..8123cf4cfa 100644 --- a/src/segment-app/iam/membership.md +++ b/src/segment-app/iam/membership.md @@ -1,9 +1,8 @@ --- title: Manage Workspace Access redirect_from: '/segment-app/iam/groups/' +plan: iam --- -{% include content/plan-grid.md name="iam" %} - This page explains how to add [Team Members](/docs/segment-app/iam/concepts/#team-members) and [User Groups](/docs/segment-app/iam/concepts/#user-groups) to your team's workspace, how to assign them [roles](/docs/segment-app/iam/roles), and how to remove them. diff --git a/src/segment-app/iam/mfa.md b/src/segment-app/iam/mfa.md index d461be8df9..27f0f51b74 100644 --- a/src/segment-app/iam/mfa.md +++ b/src/segment-app/iam/mfa.md @@ -1,8 +1,8 @@ --- title: Multi-Factor Authentication (MFA) ---- -{% include content/plan-grid.md name="mfa" %} +plan: mfa +--- Multi-factor Authentication (MFA) provides an additional layer of security when logging into your Segment account. When MFA is enabled, users must enter their username and password, and a one-time use code. Users can either enable MFA for their own account, or workspace owners can require that all users in a workspace use MFA. These security settings are available in the workspace from the "Advanced Settings" section. diff --git a/src/segment-app/iam/scim.md b/src/segment-app/iam/scim.md index 2845466407..9ae8f70fa1 100644 --- a/src/segment-app/iam/scim.md +++ b/src/segment-app/iam/scim.md @@ -1,9 +1,8 @@ --- title: "System for Cross-domain Identity Management (SCIM) Configuration Guide" +plan: sso --- -{% include content/plan-grid.md name="sso" %} - The SCIM specification is designed to make managing user identities in cloud-based applications like Segment easier. SCIM allows your Identity Provider (IdP) to manage users and groups within your Segment workspace. Most IdPs offer SCIM, and it complements SAML. You can think of SAML as a way for your employees to authenticate and SCIM as a way to make sure they have the appropriate permissions. diff --git a/src/segment-app/iam/sso.md b/src/segment-app/iam/sso.md index f993f1aaf6..a227cb73a7 100644 --- a/src/segment-app/iam/sso.md +++ b/src/segment-app/iam/sso.md @@ -1,8 +1,7 @@ --- title: "Single Sign On team management" +plan: sso --- -{% include content/plan-grid.md name="sso" %} - Segment supports Single Sign On for Business Tier accounts. You can use any SAML-based Identity Provider (IdP), for example Okta, Bitium, OneLogin, or Centrify, or use GSuite to serve as your identity provider, delegating access to the application based on rules you create in your central identity management solution.