Add Xtremepush (Actions) Destination docs. #6528
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
forstisabella
requested changes
May 10, 2024
Comment on lines
1
to
3
| --- | ||
| title: Xtremepush (Actions) Destination | ||
| --- |
There was a problem hiding this comment.
Hi @vii07 - the beta/hidden attributes denote that this integration is in private beta, the ID autogenerates some of the actions content when this integration enters public beta, and the versions note links directly to the classic Xtremepush destination (an example of this is the docs for the Slack (Actions) destination, and the blue note at the top of that page).
Suggested change
| --- | |
| title: Xtremepush (Actions) Destination | |
| --- | |
| --- | |
| title: Xtremepush (Actions) Destination | |
| beta: true | |
| hidden: true | |
| id: 661e9787658d112ba31b59a7 | |
| versions: | |
| - name: Xtremepush Destination | |
| link: /docs/connections/destinations/catalog/xtremepush/ | |
| --- |
There was a problem hiding this comment.
@forstisabella Thanks for your suggestions and I'll apply all of them soon. But a note for this one is that we want to make our new Xtremepush (Actions) Destination public beta after merging this doc, so I will pass hidden: false instead.
| --- | ||
| {% 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. |
There was a problem hiding this comment.
Suggested change
| [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. |
Comment on lines
10
to
11
| > 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. |
There was a problem hiding this comment.
Suggested change
| > 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. |
Comment on lines
17
to
19
| - **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. |
There was a problem hiding this comment.
Suggested change
| - **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. |
Comment on lines
23
to
26
| 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"}. |
There was a problem hiding this comment.
Suggested change
| 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**. | |
| 4. 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"}. |
|
|
||
| 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: |
There was a problem hiding this comment.
Suggested change
| Some special traits will also be used as additional user identifiers: | |
| Some user traits are also passed as additional user identifiers: |
| | 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. |
There was a problem hiding this comment.
Suggested change
| 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. |
|
|
||
| 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. |
There was a problem hiding this comment.
Suggested change
| 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 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. |
There was a problem hiding this comment.
Suggested change
| 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. |
There was a problem hiding this comment.
Suggested change
| 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. |
forstisabella
approved these changes
May 13, 2024
| --- | ||
| title: Xtremepush (Actions) Destination | ||
| beta: true | ||
| hidden: false |
There was a problem hiding this comment.
Suggested change
| hidden: false |
There was a problem hiding this comment.
we can remove this attribute if hidden is not set to true, as it's not hidden by default!
|
Thank you for your contribution! Your pull request is merged, but may take a day or two to appear on the site. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
Add the new docs page for Xtremepush (Actions) Destination.
Merge timing
ASAP once approved.