From 779f31f26f5169147299509da4d4616b2843b240 Mon Sep 17 00:00:00 2001 From: Ivan Vovchak Date: Fri, 10 May 2024 15:43:33 +0300 Subject: [PATCH 1/2] Add Xtremepush (Actions) Destination docs. --- .../catalog/actions-xtremepush/index.md | 74 +++++++++++++++++++ 1 file changed, 74 insertions(+) create mode 100644 src/connections/destinations/catalog/actions-xtremepush/index.md diff --git a/src/connections/destinations/catalog/actions-xtremepush/index.md b/src/connections/destinations/catalog/actions-xtremepush/index.md new file mode 100644 index 0000000000..e0b4384d1d --- /dev/null +++ b/src/connections/destinations/catalog/actions-xtremepush/index.md @@ -0,0 +1,74 @@ +--- +title: Xtremepush (Actions) Destination +--- +{% include content/plan-grid.md name="actions" %} + +[Xtremepush](https://xtremepush.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is a complete digital engagement platform. Empowering global brands to create personalised, real-time experiences for their customers across mobile, web, email, SMS and social. Xtremepush's clients are increasing revenue through data-driven, contextually-relevant interactions. The software is flexible, reliable and quick to deploy, backed up by a team of expert strategists and technical support. + +This destination is maintained by Xtremepush. For any issues with the destination, [contact the Xtremepush Support team](mailto:support@xtremepush.com). + +> success "" +> **Good to know**: This page is about the [Actions-framework](/docs/connections/destinations/actions/) Xtremepush (Actions) Segment destination. There's also a page about the [classic Xtremepush destination](/docs/connections/destinations/catalog/xtremepush/). Both of these destinations receive data from Segment. + +## Benefits of Xtremepush (Actions) vs Xtremepush Classic + +Xtremepush (Actions) provides the following benefits over the classic Xtremepush destination: + +- **Easier setup**. Users see fewer initial settings which can decrease the time spent configuring the destination. +- **Increased transparency**. Users can see the exact data that is sent to the destination, and when Segment sends it. +- **Improved customization**. Users can determine how the events their sources trigger and map to actions supported by the destination. + +## Getting started + +1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for "Xtremepush" +2. Select **Xtremepush (Actions)** and click **Add Destination** +3. Select an existing Source to connect to **Xtremepush (Actions)**. +4. Enter the "API Key" and "API Endpoint" into your Segment Settings UI which you can find from your Xtremepush Project under *Settings > Integrations* as described in the [user guide](https://docs.xtremepush.com/docs/segment){:target="_blank"}. + +{% include components/actions-fields.html %} + +## Identify + +If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](/docs/connections/spec/identify/) does. An example call would look like: + +``` +analytics.identify('userId123', { + email: 'john.doe@example.com', + phone: '1234567890', + firstName: 'John' +}); +``` + +When you identify a user, we'll pass that user's information to Xtremepush and will try to update or create a new user based on whether a Profile exists with that `user_id`. + +Some special traits will also be used as additional user identifiers: + +| Segment Trait | Xtremepush User Identifier | +| ------------- | -------------------------- | +| email | email | +| phone | mobile_number | + +For any additional traits you want to save you should create [User Profile Attributes](https://docs.xtremepush.com/docs/attributes-tags){:target="_blank"} in your Xtremepush Project. + +If a trait does not match a custom Xtremepush User Profile Attribute and is not recognized as a User Identifier it will be ignored. + +## Track + +If you're not familiar with the Segment Specs, take a look to understand what the [Track method](/docs/connections/spec/track/) does. An example call would look like: + +``` +analytics.track('Product Purchased', { + productName: 'Some Product' +}) +``` + +Track calls will be sent to Xtremepush as a `event hits`, so you can use it to [trigger a campaign](https://docs.xtremepush.com/docs/campaign-events){:target="_blank"} for a user. + +Event properties can be used as merge tags in the message content. You can also define additional rules on where to trigger the campaign based on event properties value. + +## Enabling Push and In-App Notifications +To enable Xtremepush push and in-app notifications you will also need to to install the relevant Xtremepush SDKs. + +[Xtremepush iOS SDK Docs](https://docs.xtremepush.com/docs/ios-integration){:target="_blank"} + +[Xtremepush Android SDK Docs](https://docs.xtremepush.com/docs/android-integration){:target="_blank"} From 75bef8dcb3faddc66f683433f204b7f0fe410cc4 Mon Sep 17 00:00:00 2001 From: Ivan Vovchak Date: Mon, 13 May 2024 11:27:34 +0300 Subject: [PATCH 2/2] Changed Xtremepush (Actions) Destination docs according to the PR comments. --- .../catalog/actions-xtremepush/index.md | 38 ++++++++++--------- 1 file changed, 21 insertions(+), 17 deletions(-) diff --git a/src/connections/destinations/catalog/actions-xtremepush/index.md b/src/connections/destinations/catalog/actions-xtremepush/index.md index e0b4384d1d..b9a326ce65 100644 --- a/src/connections/destinations/catalog/actions-xtremepush/index.md +++ b/src/connections/destinations/catalog/actions-xtremepush/index.md @@ -1,29 +1,33 @@ --- title: Xtremepush (Actions) Destination +beta: true +hidden: false +id: 661e9787658d112ba31b59a7 +versions: + - name: Xtremepush Destination + link: /docs/connections/destinations/catalog/xtremepush/ --- {% include content/plan-grid.md name="actions" %} -[Xtremepush](https://xtremepush.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is a complete digital engagement platform. Empowering global brands to create personalised, real-time experiences for their customers across mobile, web, email, SMS and social. Xtremepush's clients are increasing revenue through data-driven, contextually-relevant interactions. The software is flexible, reliable and quick to deploy, backed up by a team of expert strategists and technical support. +[Xtremepush](https://xtremepush.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is a complete digital engagement platform that empowers global brands to create personalized, real-time experiences for their customers across mobile, web, email, SMS and social. Xtremepush's clients are increasing revenue through data-driven, contextually-relevant interactions. The software is flexible, reliable and quick to deploy, backed up by a team of expert strategists and technical support. This destination is maintained by Xtremepush. For any issues with the destination, [contact the Xtremepush Support team](mailto:support@xtremepush.com). -> success "" -> **Good to know**: This page is about the [Actions-framework](/docs/connections/destinations/actions/) Xtremepush (Actions) Segment destination. There's also a page about the [classic Xtremepush destination](/docs/connections/destinations/catalog/xtremepush/). Both of these destinations receive data from Segment. - ## Benefits of Xtremepush (Actions) vs Xtremepush Classic Xtremepush (Actions) provides the following benefits over the classic Xtremepush destination: -- **Easier setup**. Users see fewer initial settings which can decrease the time spent configuring the destination. -- **Increased transparency**. Users can see the exact data that is sent to the destination, and when Segment sends it. -- **Improved customization**. Users can determine how the events their sources trigger and map to actions supported by the destination. +- **Easier setup**: Users see fewer initial settings which can decrease the time spent configuring the destination. +- **Increased transparency**: Users can see both the exact data that is sent to the destination and the time that Segment sent it. +- **Improved customization**: Users can determine how the events their sources trigger map to actions supported by the Xtremepush (Actions) destination. ## Getting started -1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for "Xtremepush" -2. Select **Xtremepush (Actions)** and click **Add Destination** -3. Select an existing Source to connect to **Xtremepush (Actions)**. -4. Enter the "API Key" and "API Endpoint" into your Segment Settings UI which you can find from your Xtremepush Project under *Settings > Integrations* as described in the [user guide](https://docs.xtremepush.com/docs/segment){:target="_blank"}. +1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for "Xtremepush". +2. Select **Xtremepush (Actions)** and click **Add destination**. +3. Select an existing Source to connect to **Xtremepush (Actions)**, and click **Next**. +4. Enter a name for your Xtremepush (Actions) destination and click **Create destination**. +5. From the Segment destinations settings page, enter the "API Key" and "API Endpoint". You can find these values in your Xtremepush Project under *Settings > Integrations* as described in the [Xtremepush Segment integration user guide](https://docs.xtremepush.com/docs/segment){:target="_blank"}. {% include components/actions-fields.html %} @@ -39,18 +43,18 @@ analytics.identify('userId123', { }); ``` -When you identify a user, we'll pass that user's information to Xtremepush and will try to update or create a new user based on whether a Profile exists with that `user_id`. +When you identify a user, Segment passes that user's information to Xtremepush and creates a new user, if no profile exists with that `user_id`, or updates an existing profile if the `user_id` already exists. -Some special traits will also be used as additional user identifiers: +Some user traits are also passed as additional user identifiers: | Segment Trait | Xtremepush User Identifier | | ------------- | -------------------------- | | email | email | | phone | mobile_number | -For any additional traits you want to save you should create [User Profile Attributes](https://docs.xtremepush.com/docs/attributes-tags){:target="_blank"} in your Xtremepush Project. +For any additional traits you want to save, create [User Profile Attributes](https://docs.xtremepush.com/docs/attributes-tags){:target="_blank"} in your Xtremepush Project. -If a trait does not match a custom Xtremepush User Profile Attribute and is not recognized as a User Identifier it will be ignored. +If a trait does not match a custom Xtremepush User Profile Attribute and is not recognized as a User Identifier, Xtremepush ignores the trait. ## Track @@ -62,12 +66,12 @@ analytics.track('Product Purchased', { }) ``` -Track calls will be sent to Xtremepush as a `event hits`, so you can use it to [trigger a campaign](https://docs.xtremepush.com/docs/campaign-events){:target="_blank"} for a user. +Track calls are sent to Xtremepush as a `event hits` and you can use them to [trigger a campaign](https://docs.xtremepush.com/docs/campaign-events){:target="_blank"} for a user. Event properties can be used as merge tags in the message content. You can also define additional rules on where to trigger the campaign based on event properties value. ## Enabling Push and In-App Notifications -To enable Xtremepush push and in-app notifications you will also need to to install the relevant Xtremepush SDKs. +To enable Xtremepush push and in-app notifications you must also install the relevant Xtremepush SDKs. [Xtremepush iOS SDK Docs](https://docs.xtremepush.com/docs/ios-integration){:target="_blank"}