Skip to content

Update information about the Airship destination and source #2025

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
merged 6 commits into from
Oct 19, 2021

Conversation

borys-belinsky
Copy link

Proposed changes

Update information about the Airship destination and source based on Airship documentation

Merge timing

  • ASAP once approved

@borys-belinsky borys-belinsky requested a review from a team as a code owner October 15, 2021 12:00
@borys-belinsky borys-belinsky requested review from stayseesong and removed request for a team October 15, 2021 12:00
@markzegarelli markzegarelli requested review from markzegarelli and removed request for stayseesong October 15, 2021 15:40
@markzegarelli markzegarelli added content When the bug is about content that needs to get fixed enhancement labels Oct 15, 2021

Custom Events and Tags sent from Segment are automatically populated within Airship Performance Analytics reporting dashboards.
When you call `group`, Segment sends a custom attribute to Airship with the name `airship_segment_group_<groupId>`, where `<groupId>` is the group's ID passed as one of its parameters. For example, if the group's ID is `1234` then the custom attribute name is `airship_segment_group_1234`. The value of the custom attribute is `true`.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Airship attribute key uses the Segment attribute ids not the group id. From the example group call an attribute would be airship_segment_group_industry with the value Technology. See this example for more information.

To use the Segment Destination integration, you must implement Named Users in Airship. The Segment UserID must match the Named User ID in Airship.

If your `named_user_id` and `UserID` do not match, Airship will not be able to associate Identify or Track events to the proper user in Airship. This would prevent you from effectively issuing automated messages or attaching user attributes from Segment within Airship
To use the Segment Destination integration, you must implement `Named Users` in Airship. The Segment UserID must match the Named User ID in Airship. If your `named_user_id` and `UserID` do not match, Airship will not be able to associate `identify` or `track` events to the proper user in Airship. You will not be able to issue automated messages or to attach user attributes from Segment within Airship.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add group call type: Airship will not be able to associate identify, track, or group events to the proper user in Airship.


There is a maximum limit of 20 properties for track events. A custom event will not be created for a `track` event whose properties count exceeds the limit.
Note that a custom event will not be created for a `track` event which has more than 20 properties.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is no longer a limitation and can be removed.

Airship gives brands the data, channels, orchestration and services they need to deliver push notifications, emails, SMS, in-app messages, and more to the right person in the right moment — building trust, boosting engagement, driving action and growing value.
Airship gives brands the data, channels, orchestration and services they need to deliver push notifications, emails, SMS, in-app messages, and more to the right person at the right moment — building trust, boosting engagement, driving action, and growing value.

[Airship Cloud-mode Destination integration](https://docs.airship.com/partners/segment/#destination) enables users to set Airship Tags and Custom Events through Segment's `identify`, `track`, and `group` API calls.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add Attributes: enables users to set Airship Tags, Attributes, and Custom Events through Segment's identify, track, and group API calls.

"segment-integration-group": ["hiring"]
},
"remove": {
"segment_integration-group": ["has-remote-employees"]

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo in group name, should be segment-integration-group

@netlify
Copy link

netlify bot commented Oct 18, 2021

✔️ Deploy Preview for segment-docs ready!

🔨 Explore the source changes: b31852b

🔍 Inspect the deploy log: https://app.netlify.com/sites/segment-docs/deploys/616dd67d8525c700077b75ed

😎 Browse the preview: https://deploy-preview-2025--segment-docs.netlify.app

@markzegarelli
Copy link
Contributor

Thanks for the PR @borys-belinsky and for the review @annarbecker!

I've removed the Page call from the quick info box on the destination, and will deploy these changes today.

@markzegarelli markzegarelli merged commit 66d6519 into segmentio:develop Oct 19, 2021
@github-actions
Copy link
Contributor

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
Labels
content When the bug is about content that needs to get fixed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants