Skip to content

Commit 066da19

Browse files
Merge branch 'develop' into catalog-refactor-2
2 parents fb007d0 + 7856b90 commit 066da19

File tree

7 files changed

+85
-27
lines changed

7 files changed

+85
-27
lines changed

src/_data/catalog/slugs.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,4 +188,6 @@ destinations:
188188
- original: "regal-io"
189189
override: "regal"
190190
- original: "rehook"
191-
override: "actions-rehook"
191+
override: "actions-rehook"
192+
- original: "bucket-web-actions"
193+
override: "bucket-web"

src/_data/sidenav/main.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -577,6 +577,8 @@ sections:
577577
title: Audit Trail
578578
- path: /segment-app/iam/sso
579579
title: Single Sign On
580+
- path: /segment-app/iam/scim
581+
title: System for Cross-domain Identity Management (SCIM) Configuration Guide
580582
- path: /segment-app/iam/mfa
581583
title: Multi-Factor Authentication (MFA)
582584
- path: /segment-app/iam/secure-password

src/connections/sources/catalog/cloud-apps/onesignal/index.md

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -47,40 +47,46 @@ OneSignal doesn't send user email address or phone number details to Segment.
4747

4848
The following table lists the events that OneSignal sends to Segment. These events appear as tables in your warehouse and as regular events in other destinations.
4949

50-
| Event Kind | Event Description |
50+
| MessageEvent Kind | Event Description |
5151
| ----------------------------- | ---------------------------------------------------- |
5252
| Push Sent | Push notification successfully sent |
5353
| Push Received | Push notification successfully received |
5454
| Push Clicked | Push notification touched on device |
55-
| In-App Message Displayed | In-App Message successfully displayed on device |
55+
| In-App Message Impression | In-App Message successfully displayed on device |
5656
| In-App Message Clicked | In-App Message clicked on device |
5757
| In-App Message Page Displayed | In-App Message page is displayed |
5858
| Email Sent | Email successfully sent |
59+
| Email Received | Email received by recipient |
5960
| Email Opened | Email opened by recipient |
61+
| Email Link Clicked | Email contained link, link clicked |
6062
| Email Unsubscribed | Email unsubscribed by recipient |
61-
| Email Received | Email received by recipient |
6263
| Email Reported As Spam | Email reported as spam by recipient |
63-
| Email Hardbounced | Email returned to sender due to permanent error |
64-
| Email Failed | Could not deliver the email to the recipient's inbox |
64+
| Email Bounced | Email returned to sender due to permanent error |
65+
| Email Failed | Could not deliver the email to the recipient’s inbox |
66+
| Email Suppressed | Email is suppressed for a subscription |
6567
| SMS Sent | SMS sent to recipient |
66-
| SMS Delivered | SMS successfully delivered |
6768
| SMS Failed | SMS failed to send |
69+
| SMS Delivered | SMS successfully delivered |
70+
| SMS Undelivered | SMS undelivered for a subscription |
6871

6972
## Event properties
7073

7174
The following table lists the properties included in the events from the Events table.
7275

73-
| Property Name | Description |
74-
| ------------------- | -------------------------------------------------- |
75-
| `messageId` | The identifier of the discrete message |
76-
| `campaign_id` | The identifier of the message campaign |
77-
| `message_name` | The message name |
78-
| `message_title` | The message title |
79-
| `message_contents` | The message contents |
80-
| `message_type` | The type of message sent, push, in-app, email, SMS |
81-
| `subscription_type` | The channel the message was sent through |
82-
| `template_id` | The message template used |
83-
| `onesignal_id` | The OneSignal set user identifier |
76+
| Property Name | Description |
77+
| -------------------------- | ------------------------------------------------------------------------------------- |
78+
| `userId` | The `external_id` associated with the message |
79+
| `anonymousId ` | The `subscription_id` associated with the message (only sent if there is no `external_id`) |
80+
| `messageId` | The identifier of the discrete message |
81+
| `campaign_id` | The identifier of the message campaign |
82+
| `message_name` | The message name |
83+
| `message_title` | The message title only for push and email |
84+
| `message_contents` | The message contents only for push and sms |
85+
| `template_id` | The message template used |
86+
| `subscription_id` | The OneSignal set device/email/sms identifier |
87+
| `subscription_device_type` | The device type that received the message |
88+
| `language` | The two character language code of the device |
89+
| `message_type` | The type of message sent (push, in-app, email, or SMS) |
8490

8591

8692

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: White Label Loyalty Source
3+
id: xeZMgSrtAQ
4+
beta: true
5+
---
6+
7+
[White Label Loyalty](https://whitelabel-loyalty.com/){:target="_blank”} is an event-powered loyalty solution to drive customer retention.
8+
9+
This is an [Event Cloud Source](/docs/sources/#event-cloud-sources) that can not only export data into your Segment warehouse but also federate the exported data into your other Segment-enabled destinations.
10+
11+
White Label Loyalty maintains this source. For any issues with the source, [contact their support team](mailto:[email protected]).
12+
13+
## Getting started
14+
15+
1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog){:target="_blank”}, click **Add Source**.
16+
2. Search for "White Label Loyalty" in the Sources Catalog, select White Label Loyalty, and click **Add Source**.
17+
3. On the next screen, give the source a name and configure any other settings.
18+
19+
- The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name can be anything, but Segment recommend using something that reflects the source itself and distinguishes amongst your environments (for example, `WhiteLabel_Prod`, `WhiteLabel_Staging`, `WhiteLabel_Dev`).
20+
21+
4. Click **Add Source** to save your settings.
22+
5. Copy the write key from the Segment UI.
23+
6. In the White Label Loyalty Console, navigate to **Settings > Integrations > Extensions** and click **Create**. Alternatively, you can edit an existing Segment integration.
24+
7. Paste the write key in when prompted.
25+
8. (Optional:) Specify a JSON path to use for the users ID (defaults to `authIdentifier`).
26+
9. Click **Save**.
27+
28+
## Stream
29+
30+
White Label Loyalty uses Segment's stream source component to send Segment event data. The source uses server-side Track and Identify methods to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL.
31+
32+
By default, White Label Loyalty passes the `authIdentifier` associated with the user as the `userId`. You can specify a custom JSONPath in the White Label Loyalty Console to change the source of the `userId`.
33+
34+
## Events
35+
36+
White Label Loyalty will send all custom and intrinsic event types created in the White Label Loyalty Console, as per the schema provided when you set it up. White Label Loyalty will send all events reported against a user and include the `userId`.
37+
38+
## Adding destinations
39+
40+
Now that your source is set up, you can connect it with Destinations.
41+
42+
Log in to your downstream tools and verify that your events appear as expected, and that they contain all of the properties you expect. If your events and properties don’t appear, check the [Event Delivery](/docs/connections/event-delivery/) tool, and refer to the destination docs for each tool for troubleshooting.
43+
44+
If you experience any issues with how events are arriving to Segment, [contact the White Label Loyalty support team](mailto:[email protected]).

src/engage/campaigns/mobile-push/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -354,6 +354,9 @@ Follow these steps to set up mobile push in Twilio Engage.
354354
12. Click **Verify**, then select the messaging services you want to use in your space.
355355
13. Click **Save Twilio Account.**
356356

357+
> info "Removing messaging services"
358+
> To remove a messaging service, navigate to Engage > Engage settings > Channels and click the pencil icon under **Twilio messaging service**. Enter the account credentials by either using the API key secret or creating a new API key. Once you've selected the desired services, they will override the existing ones, effectively removing the ones you no longer need.
359+
357360
### 5b. Create a new push service
358361

359362
Complete mobile push onboarding by creating a new push service:

src/segment-app/iam/scim.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Most IdPs offer SCIM, and it complements SAML. You can think of SAML as a way fo
1111

1212
Before you start, remember that SSO is only available to Business Tier customers, and that only workspace owners may configure SSO connections.
1313

14-
To set up SCIM, you must first create an SSO connection. Once you [create your SSO connection](https://segment.com/docs/segment-app/iam/sso/), log back in to Segment using SSO.
14+
To set up SCIM, you must first create an SSO connection. Once you [create your SSO connection](/docs/segment-app/iam/sso/), log back in to Segment using SSO.
1515

1616
## Configuration Instructions
1717

@@ -27,15 +27,15 @@ Your IdP needs to know where to send SCIM requests. The Segment base URL is: htt
2727

2828
The other value you need is an API key (sometimes referred to as an Authorization Header). To generate one, go to **Settings > Advanced Settings** in the Segment app, and find the **SSO Sync** section. Click **Generate SSO Token** and copy the generated token. Use this token for the API key or Authorization Header in your IdP.
2929

30-
This page is located as part of the settings sidebar: https://app.segment.com/CUSTOMER_WORKSPACE_SLUG/settings/advanced
30+
You can find this page in the [settings sidebar of your Segment app](https://app.segment.com/goto-my-workspace/settings/advanced){:target="_blank”}.
3131

3232
![Screenshot of the Segment settings sidebar, with Advanced Settings selected.](images/asset_generate_scim_token.png)
3333

3434
## Features
3535

3636
It's important to remember that Segment has a multi-tenant user/workspace relationship, meaning that users can be part of more than one workspaces. In most cases these workspaces are all related to a single customer (for example, a single company might have individual workspaces for different brands or subsidiaries). However, some users can be members of workspaces for different Segment customers, such as with contractors or consultants.
3737

38-
Because of this, Segment must balance the autonomy of our users with the desired level of control of a workspace owner.
38+
Because of this, Segment must balance the autonomy of users with the desired level of control of a Workspace Owner.
3939

4040
## Creating Users
4141

@@ -69,7 +69,7 @@ Your IdP can create new groups in Segment using SCIM. All groups created using S
6969

7070
## Updating Groups
7171

72-
Your IdP can add or remove workspace members from existing groups via SCIM. Your IdP can also update Segment group names.
72+
Your IdP can add or remove workspace members from existing groups using SCIM. Your IdP can also update Segment group names.
7373

7474
## Deleting Groups
7575

@@ -87,7 +87,7 @@ For example, you might map `{firstName} {lastName}` from your IdP to `displayNam
8787

8888
## Okta Set up Guide
8989

90-
1. [Complete the Okta Set up Guide for SSO](https://saml-doc.okta.com/SAML_Docs/How-to-Configure-SAML-2.0-for-Segment.html?baseAdminUrl=https://segment-admin.oktapreview.com&app=segment&instanceId=0oata15py1n3kQUo50h7)
90+
1. [Complete the Okta Set up Guide for SSO](https://saml-doc.okta.com/SAML_Docs/How-to-Configure-SAML-2.0-for-Segment.html?baseAdminUrl=https://segment-admin.oktapreview.com&app=segment&instanceId=0oata15py1n3kQUo50h7){:target="_blank”}
9191
2. Click **Provisioning**, then click **Configure API Integration** and select **Enable API Integration**.
9292
3. [Generate an API key](#api-key), then copy and paste this value into the **API Token** field in Okta, and click **Save**.
9393

@@ -113,14 +113,14 @@ For example, you might map `{firstName} {lastName}` from your IdP to `displayNam
113113

114114
Instructions for configuring Azure AD can be found on the Microsoft Docs website.
115115

116-
1. [Complete the Azure AD Set up Guide for SSO](https://docs.microsoft.com/en-us/azure/active-directory/saas-apps/segment-tutorial)
116+
1. [Complete the Azure AD Set up Guide for SSO](https://docs.microsoft.com/en-us/azure/active-directory/saas-apps/segment-tutorial){:target="_blank”}.
117117

118-
2. [Complete the Azure AD Set up Guide for SCIM](https://docs.microsoft.com/en-us/azure/active-directory/saas-apps/segment-provisioning-tutorial)
118+
2. [Complete the Azure AD Set up Guide for SCIM](https://docs.microsoft.com/en-us/azure/active-directory/saas-apps/segment-provisioning-tutorial){:target="_blank”}.
119119

120120
## OneLogin Set up Guide
121121

122122
Instructions for configuring OneLogin can be found on the OneLogin Docs website.
123123

124-
1. Add and configure the Segment SSO integration from within the OneLogin application
124+
1. Add and configure the Segment SSO integration from within the OneLogin application.
125125

126-
2. [Complete the OneLogin Set up Guide for SCIM](https://onelogin.service-now.com/support?id=kb_article&sys_id=a7833cd7db3a30501c167e77f4961923)
126+
2. [Complete the OneLogin Set up Guide for SCIM](https://onelogin.service-now.com/support?id=kb_article&sys_id=a7833cd7db3a30501c167e77f4961923){:target="_blank”}.

vale-styles/Vocab/Docs/accept.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,3 +97,4 @@ waitlist
9797
WebKit
9898
Wootric
9999
Zendesk
100+
Okta

0 commit comments

Comments
 (0)