Skip to content
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

Web SDK Page Move from BP #33

Merged
merged 1 commit into from
Apr 5, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ While there are no limits to how many characters of text you can include in an i

#### Text

**Message Tyoe** | **Max Message Length**
**Message Type** | **Max Message Length**
--- | ---
(iOS) Lock Screen | 110 Characters
(iOS) Notification Center | 110 Characters
Expand Down
2 changes: 1 addition & 1 deletion _docs/_help/best_practices/spam_regulations.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ There are a number of laws that regulate senders of electronic communications, i

## CAN-SPAM

The CAN-SPAM Act of 2003 regulates email senders in the U.S. sending "any electronic mail message, the primary purpose of which is the commerical advertisment or promotion of a commercial product or service." You can read more details on the [FTC site][5].
The CAN-SPAM Act of 2003 regulates email senders in the U.S. sending "any electronic mail message, the primary purpose of which is the commercial advertisement or promotion of a commercial product or service." You can read more details on the [FTC site][5].

There are 7 key requirements for CAN-SPAM:

Expand Down
57 changes: 3 additions & 54 deletions _docs/_help/best_practices/web_sdk.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,5 @@
---
nav_title: Web SDK
page_order: 6
hidden: true
layout: redirect
redirect_to: /docs/user_guide/onboarding_with_braze/web_sdk
---
# Web SDK

With Braze’s Web SDK, you can collect session data, identify users (with the same set of attributes that we support across our other platforms), and record purchases and custom events via a web/mobile browser. Implementing Braze's Web SDK enables you to create a more complete view of your users across web and mobile channels. You can also use the Web SDK to engage with your users by sending in-app web messages and web push notifications.

## Implementation

For information on integrating the Braze Web SDK, see our [documentation][6]. After implementing the Web SDK, your website will appear as an app in your app group and will be grouped with your mobile apps.

![Web_App_Group][7]

## In-App Web Messaging

You can send web messages to engage with users directly in their web/mobile browser. Web messages are sent as in-app messages, and can also be sent as slideup, modal, or fullscreen types. For more information on composing an in-app message, see our page on [creating an in-App message][8].

## Web Push

Web push is another great way to engage with users of your web application. Customers visiting your website via Chrome, Safari, Firefox, and Opera can opt-in to receive web push from your web application whether or not the web page is loaded. This feature is also supported on Android Chrome and Firefox Mobile on Android allowing for mobile web notifications. Web push works the same way app push notifications operate on your phone. For more information on composing a web push, see our page on [creating a push notification][11]. See below for a sample web push sent by Braze.

![appboy-web-push][12]

Users of your web application need to opt-in to receive web push. See below.

![web-push-optin][13]

For more information on the push protocol standards and browser support, you can review resources from [Apple][3] [Mozilla][1] and [Microsoft][2]

> Private browsing windows do not currently support web push.

## Delivery Rules

By default, a campaign containing an in-app message will send an in-app web message as well as an in-app mobile message. To send an in-app message exclusively to web or mobile, you will need to segment your campaign accordingly.

## Segmenting for Web Users

You can create a segment of your web users by selecting only your website’s app icon in the Apps Used section.

![web-users-segment][10]

This will allow you to target users based on their behavior on the web only. If you wanted to target web users to encourage them to download your mobile app, you’d create this segment as your target audience. If you wanted to send a messaging campaign that included a mobile in-app message but not a web message, you would simply uncheck your website’s icon in your segment.

[1]: https://developer.mozilla.org/en-us/docs/web/api/push_api#browser_compatibility
[2]: https://developer.microsoft.com/en-us/microsoft-edge/platform/status/pushapi/
[3]: https://developer.apple.com/notifications/safari-push-notifications/
[6]: {{ site.baseurl }}/developer_guide/platform_integration_guides/web/initial_sdk_setup/
[7]: {% image_buster /assets/img_archive/web-app-group.png %}
[8]: {{ site.baseurl }}/user_guide/message_building_by_channel/in-app_messages/creating_an_in-app_message/#creating-an-in-app-message
[9]: {% image_buster /assets/img_archive/appboy-web-inapp-message.png %}
[10]: {% image_buster /assets/img_archive/web-users-segment.png %}
[11]: {{ site.baseurl }}/user_guide/message_building_by_channel/push/creating_a_push_message/#creating-a-push-message
[12]: {% image_buster /assets/img_archive/Macbook_Push.png %}
[13]: {% image_buster /assets/img_archive/WebPush_Prompt.png %}
[14]: {% image_buster /assets/img_archive/Appboy_Web_Push_Gif.gif %}
58 changes: 58 additions & 0 deletions _docs/_user_guide/onboarding_with_braze/web_sdk.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
nav_title: Web SDK
page_order: 3.6
---
# Web SDK

With Braze’s Web SDK, you can collect session data, identify users (with the same set of attributes that we support across our other platforms), and record purchases and custom events via a web/mobile browser. Implementing Braze's Web SDK enables you to create a more complete view of your users across web and mobile channels. You can also use the Web SDK to engage with your users by sending in-app web messages and web push notifications.

## Implementation

For information on integrating the Braze Web SDK, see our [documentation][6]. After implementing the Web SDK, your website will appear as an app in your app group and will be grouped with your mobile apps.

![Web_App_Group][7]

## In-App Web Messaging

You can send web messages to engage with users directly in their web/mobile browser. Web messages are sent as in-app messages, and can also be sent as slideup, modal, or fullscreen types. For more information on composing an in-app message, see our page on [creating an in-app message][8].

## Web Push

Web push is another great way to engage with users of your web application. Customers visiting your website via Chrome, Safari, Firefox, and Opera can opt-in to receive web push from your web application whether or not the web page is loaded. This feature is also supported on Android Chrome and Firefox Mobile on Android allowing for mobile web notifications. Web push works the same way app push notifications operate on your phone. For more information on composing a web push, see our page on [creating a push notification][11]. See below for a sample web push sent by Braze.

![appboy-web-push][12]

Users of your web application need to opt-in to receive web push. See below.

![web-push-optin][13]

For more information on the push protocol standards and browser support, you can review resources from [Apple][3] [Mozilla][1] and [Microsoft][2]

{% alert important %}
Private browsing windows do not currently support web push.
{% endalert %}

## Delivery Rules

By default, a campaign containing an in-app message will send an in-app web message as well as an in-app mobile message. To send an in-app message exclusively to web or mobile, you will need to segment your campaign accordingly.

## Segmenting for Web Users

You can create a segment of your web users by selecting only your website’s app icon in the Apps Used section.

![web-users-segment][10]

This will allow you to target users based on their behavior on the web only. If you wanted to target web users to encourage them to download your mobile app, you’d create this segment as your target audience. If you wanted to send a messaging campaign that included a mobile in-app message but not a web message, you would simply uncheck your website’s icon in your segment.

[1]: https://developer.mozilla.org/en-us/docs/web/api/push_api#browser_compatibility
[2]: https://developer.microsoft.com/en-us/microsoft-edge/platform/status/pushapi/
[3]: https://developer.apple.com/notifications/safari-push-notifications/
[6]: {{ site.baseurl }}/developer_guide/platform_integration_guides/web/initial_sdk_setup/
[7]: {% image_buster /assets/img_archive/web-app-group.png %}
[8]: {{ site.baseurl }}/user_guide/message_building_by_channel/in-app_messages/create/
[9]: {% image_buster /assets/img_archive/appboy-web-inapp-message.png %}
[10]: {% image_buster /assets/img_archive/web-users-segment.png %}
[11]: {{ site.baseurl }}/user_guide/message_building_by_channel/push/creating_a_push_message/#creating-a-push-message
[12]: {% image_buster /assets/img_archive/Macbook_Push.png %}
[13]: {% image_buster /assets/img_archive/WebPush_Prompt.png %}
[14]: {% image_buster /assets/img_archive/Appboy_Web_Push_Gif.gif %}