-
Notifications
You must be signed in to change notification settings - Fork 382
Add Xtremepush (Actions) Destination docs. #6528
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
forstisabella
merged 2 commits into
segmentio:develop
from
xtremepush:actions-xtremepush/destination
May 14, 2024
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
78 changes: 78 additions & 0 deletions
78
src/connections/destinations/catalog/actions-xtremepush/index.md
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
--- | ||
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 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:[email protected]). | ||
|
||
## 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 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)**, 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 %} | ||
|
||
## 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: '[email protected]', | ||
phone: '1234567890', | ||
firstName: 'John' | ||
}); | ||
``` | ||
|
||
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 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, 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, Xtremepush ignores the trait. | ||
|
||
## 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 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 must also 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"} |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we can remove this attribute if hidden is not set to true, as it's not hidden by default!