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

Leftover deploy - September 5, 2024 #8030

Merged
merged 47 commits into from
Sep 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
a41c988
BD-3397 Update Short and Long Codes
rachel-feinberg Aug 23, 2024
418f2a7
Update short codes cons
rachel-feinberg Aug 26, 2024
8ba6ec5
Add missing notes
rachel-feinberg Aug 26, 2024
aeaf0d7
[BD-2879] update ios uninstall tracking docs
internetisaiah Aug 29, 2024
284c4ed
Update _docs/_developer_guide/platform_integration_guides/swift/analy…
internetisaiah Aug 30, 2024
8a54dd4
Update contentsquare.md
alex-braze Aug 30, 2024
2abffcb
BD-3419 Add Connected sources screenshot
rachel-feinberg Aug 30, 2024
c5799ec
Apply suggestions from code review
rachel-feinberg Sep 3, 2024
b1a0035
Update Vanity short codes
rachel-feinberg Sep 3, 2024
d4ea9e2
BD-3414: Updates for API Keys and Identifiers
lydia-xie Sep 3, 2024
c61aaac
Add screenshots
rachel-feinberg Sep 3, 2024
4633862
Update lexer.md
alex-braze Sep 3, 2024
449a977
API overview
lydia-xie Sep 3, 2024
a9884d8
BD-3423 Add Trending model to AI item recommendations
rachel-feinberg Sep 3, 2024
982b169
Update airbyte.md
alex-braze Sep 3, 2024
2990272
Merge pull request #8013 from braze-inc/alex-braze-patch-3
bre-fitzgerald Sep 3, 2024
1ddda37
Add ko setting
zzhaobraze Sep 4, 2024
025df38
allow utf8 chars in tabids
zzhaobraze Sep 4, 2024
e111c09
Apply suggestions from code review
rachel-feinberg Sep 4, 2024
310ef42
Merge pull request #8015 from braze-inc/bd-3423-2
rachel-feinberg Sep 4, 2024
2e41534
Julian edits
rachel-feinberg Sep 4, 2024
705b58f
Update logging_analytics.md
josh-mccrowell-braze Sep 4, 2024
99279ea
Merge pull request #8019 from braze-inc/multi_lang_tab_fix
josh-mccrowell-braze Sep 4, 2024
39781e8
Putting in fixes for broken links from the translation process
josh-mccrowell-braze Sep 4, 2024
2184029
Update amplitude_audiences.md
josh-mccrowell-braze Sep 4, 2024
b226e7b
Merge pull request #8020 from braze-inc/JJM-translation-patches
bre-fitzgerald Sep 4, 2024
1e04a87
Merge pull request #8018 from braze-inc/ko-prep
josh-mccrowell-braze Sep 4, 2024
336eba9
imgs
lydia-xie Sep 4, 2024
092176a
remove accidental img
lydia-xie Sep 4, 2024
cad2fec
Merge pull request #8009 from braze-inc/lx-BD-3414
rachel-feinberg Sep 4, 2024
6eecd83
Apply suggestions from code review
rachel-feinberg Sep 4, 2024
907c588
Merge pull request #7950 from braze-inc/bd-3397
rachel-feinberg Sep 4, 2024
b201730
BD-3425 Roles GA
rachel-feinberg Sep 4, 2024
10cfa72
Merge pull request #8024 from braze-inc/bd-3425
lydia-xie Sep 4, 2024
eb5575e
Update step 3
rachel-feinberg Sep 5, 2024
982e55a
Update _docs/_developer_guide/platform_integration_guides/swift/analy…
internetisaiah Sep 5, 2024
57e2166
Merge branch 'develop' into BD-2879
internetisaiah Sep 5, 2024
bc0bfa4
replacing reference link
internetisaiah Sep 5, 2024
b26d21d
Merge pull request #7986 from braze-inc/BD-2879
internetisaiah Sep 5, 2024
5500bac
Final edits
rachel-feinberg Sep 5, 2024
ea4fd60
Final edit
rachel-feinberg Sep 5, 2024
1d08868
Merge pull request #8004 from braze-inc/bd-3419
rachel-feinberg Sep 5, 2024
9d25ca9
Copying commits from PR #8006 (Phrase)
internetisaiah Sep 5, 2024
a8ce284
Merge pull request #8028 from braze-inc/i18n_phrase-ja-isaiah-1318
lydia-xie Sep 5, 2024
3b834b2
Merge pull request #8016 from braze-inc/alex-braze-patch-4
internetisaiah Sep 5, 2024
133ffc8
Update contentsquare.md
internetisaiah Sep 5, 2024
7eebd80
Merge pull request #8001 from braze-inc/alex-braze-patch-2
internetisaiah Sep 5, 2024
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
4 changes: 2 additions & 2 deletions .vercel/build.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ if ((vercel_env == 'preview') && (branch_commit != 'develop')) {
// For preview, if language is english project, then don't build if it's an language branch
// if language is not english, then check if it's a language branch
if (vercel_lang == 'en') {
if (branch_check.includes('i18n_') || branch_commit.includes('i18n_')) {
if (branch_check.startsWith('i18n_') || branch_commit.startsWith('i18n_')) {
build_app = 0;
}
}
else{
build_app = 0;
if (branch_check.includes('i18n_') && branch_commit.includes('i18n_')) {
if (branch_check.startsWith('i18n_') && branch_commit.startsWith('i18n_') && branch_commit.includes(vercel_lang)) {
if (branch_check && (vercel_env == 'preview')) {
build_app = 1;
}
Expand Down
10 changes: 9 additions & 1 deletion Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -104,10 +104,18 @@ task :ja do
Rake::Task["lang"].invoke('ja')
end

task :ko do
Rake::Task["lang"].invoke('ko')
end

task :fr_build do
Rake::Task["lang:build"].invoke('fr')
end

task :ja_build do
Rake::Task["lang:build"].invoke('ja')
end
end

task :ko_build do
Rake::Task["lang:build"].invoke('ko')
end
11 changes: 10 additions & 1 deletion _data/i18n.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,13 @@ ja:
edit_github: GitHub でこのページを編集
page_nav_title: このページについて
helpful: 「このページはどの程度役に立ちましたか?」

ko:
next: 다음
previous: 이전
popular_topic: 인기 주제
help_resources: 유용한 리소스
braze_status: 브레이즈 시스템 상태
braze_status_check: 브레이즈 상태 확인
edit_github: GitHub 에서 이 페이지를 편집합니다.
page_nav_title: 이 페이지에
helpful: "이 페이지가 얼마나 도움이 되었나요?"
24 changes: 11 additions & 13 deletions _docs/_api/basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,19 +71,19 @@ For more information, refer to the following articles based on your platform: [i

A REST Application Programming Interface key (REST API key) is a unique code that is passed into an API to authenticate the API call and identify the calling application or user. API access is done using HTTPS web requests to your company's REST API endpoint. We use REST API keys at Braze in tandem with our App Identifier keys to track, access, send, export, and analyze data to help make sure everything is running smoothly on both your and our end.

Workspaces and API Keys go hand in hand at Braze. Workspaces are designed to house versions of the same application across multiple platforms. Many customers also use workspaces to contain free and premium versions of their applications on the same platform. As you may notice, these workspaces are also making use of the REST API and have their own REST API keys. These keys can be individually scoped to include access to specific endpoints on the API. Each call to the API must include a key with access to the endpoint hit.
Workspaces and API keys go hand in hand at Braze. Workspaces are designed to house versions of the same application across multiple platforms. Many customers also use workspaces to contain free and premium versions of their applications on the same platform. As you may notice, these workspaces are also making use of the REST API and have their own REST API keys. These keys can be individually scoped to include access to specific endpoints on the API. Each call to the API must include a key with access to the endpoint hit.

We refer to both the REST API key and workspace API key as the `api_key`. The `api_key` is included in each request as a request header and acts as an authentication key that allows you to use our REST APIs. These REST APIs are used to track users, send messages, export user data, and more. When you create a new REST API key, you will need to give it access to specific endpoints. By assigning specific permissions to an API key, you can limit exactly which calls an API key can authenticate.

![REST API keys panel on the API Keys page.][27]
![REST API keys panel on the API Keys tab.][27]

{% alert tip %}
In addition to REST API keys, there also exists a type of key called Identifier keys that can be used to reference specific things like apps, templates, Canvases, campaigns, Content Cards, and segments from the API. For more information, refer to [API Identifier types]({{site.baseurl}}/api/identifier_types/).
In addition to REST API keys, there also exists a type of key called Identifier keys that can be used to reference specific things like apps, templates, Canvases, campaigns, Content Cards, and segments from the API. For more information, refer to [API identifier types]({{site.baseurl}}/api/identifier_types/).
{% endalert %}

### REST API key permissions

API key permissions are permissions you can assign a user or group to limit their access to certain API calls. To view your list of API key permissions, go to **Settings** > **API Keys**, and select your API key.
API key permissions are permissions you can assign a user or group to limit their access to certain API calls. To view your list of API key permissions, go to **Settings** > **APIs and Identifiers**, and select your API key.

{% tabs %}
{% tab User Data %}
Expand Down Expand Up @@ -325,12 +325,12 @@ If you are using the [older navigation]({{site.baseurl}}/navigation), you can cr
5. Select which [permissions](#rest-api-key-permissions) you want to be associated with your new key.

{% alert important %}
Keep in mind that after you create a new API key, you cannot edit the scope of permissions or the allowlisted IPs. This limitation is in place for security reasons. If you need to change the scope of a key, create a new key with the updated permissions and implement that key in place of the old one. After you've completed your implementation, go ahead and delete the old key.
Keep in mind that after you create a new API key, you cannot edit the scope of permissions or the allowlisted IPs. This limitation is in place for security reasons. If you need to change the scope of a key, create a new key with the updated permissions and implement that key in place of the old one. After you've completed your implementation, you can delete the old key.
{% endalert %}

## Managing REST API keys

REST API keys cannot be edited after they are created. However, you can view details for or delete existing REST API keys from the **API Keys** page. The **Rest API Keys** list shows the following information at a glance for each key:
REST API keys cannot be edited after they're created, but you can view details for or delete existing REST API keys from the **API Keys** tab. This tab has the following information for each key:

| Field | Description |
| ------------ | :------------------------------------------------------------------------------------------------------------------ |
Expand All @@ -341,13 +341,13 @@ REST API keys cannot be edited after they are created. However, you can view det
| Last Seen | The date this key was last used. This field will show as "N/A" for keys that have never been used. |
{: .reset-td-br-1 .reset-td-br-2}

To view the details for a specific key, select a key from the list. You can then see all the permissions this key has, whitelisted IPs (if any), and if this key is opted into Braze IP whitelisting.
To view the details of an API key, hover over the key and select <i class="fa-solid fa-eye" alt="View"></i> **View**. This includes all the permissions this key has, whitelisted IPs (if any), and if this key is opted into Braze IP whitelisting.

![][30]

Note when [deleting a user]({{site.baseurl}}/user_guide/administrative/app_settings/manage_your_braze_users/adding_users_to_your_dashboard/), the associated API keys a user created will not be deleted. To delete a key, click <i class="fas fa-gear" alt="Settings"></i> and select the corresponding option.
Note when [deleting a user]({{site.baseurl}}/user_guide/administrative/app_settings/manage_your_braze_users/adding_users_to_your_dashboard/), the associated API keys a user created won't be deleted. To delete a key, hover over the key and select <i class="fa-solid fa-trash-can" alt="Delete"></i> **Delete**.

![][29]
![][29]{: style="max-width:30%;"}

## REST API key security

Expand All @@ -357,8 +357,6 @@ Given that REST API keys allow access to potentially sensitive REST API endpoint

A good security practice is to assign a user only as much access as is necessary to complete their job: this principle can also be applied to API keys by assigning permissions to each key. These permissions give you better security and control over the different areas of your account.

![API key permissions available when creating an API key.][25]

{% alert warning %}
Given that REST API keys allow access to potentially sensitive REST API endpoints, make sure they are stored and used securely. For example, do not use this key to make AJAX calls from your website or expose it in any other public manner.
{% endalert %}
Expand All @@ -369,7 +367,7 @@ If accidental exposure of a key occurs, it can be deleted from the Developer Con

For additional security, you can specify a list of IP addresses and subnets which are allowed to make REST API requests for a given REST API key. This is referred to as allowlisting, or whitelisting. To allow specific IP addresses or subnets, add them to the **Whitelist IPs** section when creating a new REST API key:

![Option to whitelist IPs when creating an API key][26]
![Option to allowlist IPs when creating an API key.][26]

If you don't specify any, requests can be sent from any IP address.

Expand All @@ -383,7 +381,7 @@ Making a Braze-to-Braze webhook and using allowlisting? Check out our list of [I

If you're implementing Braze using Ruby, you can use our [Ruby client library](https://github.com/braze-inc/braze-api-client-ruby) to reduce your data import time. A client library is a collection of code specific to one programming language—in this case, Ruby—that makes it easier to use an API.

The Ruby client library supports the [User Endpoints]({{site.baseurl}}/api/endpoints/user_data).
The Ruby client library supports the [User endpoints]({{site.baseurl}}/api/endpoints/user_data).

{% alert note %}
This client library is currently in beta. Want to help us make this library better? Send us feedback at [smb-product@braze.com](mailto:smb-product@braze.com).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ When implementing your custom Content Cards, you can parse the Content Card obje
To obtain the Content Card data models, subscribe to Content Card updates. There are two properties to pay particular attention to:

* **`id`**: Represents the Content Card ID string. This is the unique identifier used to log analytics from custom Content Cards.
* **`extras`**: Encompasses all the key-value pairs from the Braze dashboard.
* **`extras`**: Encompasses all the key-value pairs from the Braze dashboard.

All properties outside of `id` and `extras` are optional to parse for custom Content Cards. For more information on the data model, see each platform's integration article: [Android]({{site.baseurl}}/developer_guide/platform_integration_guides/android/content_cards/integration/), [iOS]({{site.baseurl}}/developer_guide/platform_integration_guides/swift/content_cards/integration/), [Web]({{site.baseurl}}/developer_guide/platform_integration_guides/web/content_cards/integration/).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,27 @@ description: "This article covers how to configure uninstall tracking for the Sw

# Uninstall tracking

> This article covers how to configure uninstall tracking for your iOS application, and how to test to ensure that your app does not take any unwanted automatic actions upon receiving a Braze uninstall tracking push.
> Learn how to set up uninstall tracking for your iOS application, so you can ensure your app doesn't take any unwanted automatic actions upon receiving a Braze uninstall tracking push. Uninstall tracking utilizes background push notifications with a Braze flag in the payload. For general information, see [uninstall tracking][6].

Uninstall tracking utilizes background push notifications with a Braze flag in the payload. For general information, see [uninstall tracking]({{site.baseurl}}/user_guide/data_and_analytics/tracking/uninstall_tracking/#uninstall-tracking) in our user guide.
{% alert important %}
Keep in mind, uninstall tracking can be imprecise. The metrics you see on Braze may be delayed or inaccurate.
{% endalert %}

## Step 1: Enabling background push
## Step 1: Enable background push

Make sure that you have enabled the **Remote notifications** option from the **Background Modes** section of your Xcode project's **Capabilities** tab. Refer to our [silent push notification]({{site.baseurl}}/developer_guide/platform_integration_guides/swift/push_notifications/silent_push_notifications/) documentation for additional details.
In your Xcode project, go to **Capabilities** and ensure you have **Background Modes** enabled. For more information, see [silent push notification]({{site.baseurl}}/developer_guide/platform_integration_guides/swift/push_notifications/silent_push_notifications/).

## Step 2: Checking for Braze background push
## Step 2: Check for Braze background push

Braze uses background push notifications to collect uninstall tracking analytics. Ensure that your application [does not take any unwanted actions]({{site.baseurl}}/developer_guide/platform_integration_guides/swift/push_notifications/customization/ignoring_internal_push/) upon receiving our uninstall tracking notifications.

## Step 3: Test from the dashboard
## Step 3: Test from the Braze dashboard

Next, send yourself a test push from the dashboard. This test push will not update your user profile.
Next, send yourself a test push from the Braze dashboard. Keep in mind, this test push will not update your user profile.

1. On the **Campaigns** page, create a push notification campaign and select **iOS push** as your platform.<br><br>
2. On the **Settings** page, add the key `appboy_uninstall_tracking` with corresponding value `true` and check **Add Content-Available Flag**.<br><br>
3. Use the **Preview** page to send yourself a test uninstall tracking push.<br><br>
1. On the **Campaigns** page, create a push notification campaign and select **iOS push** as your platform.
2. On the **Settings** page, add the key `appboy_uninstall_tracking` with corresponding value `true` and check **Add Content-Available Flag**.
3. Use the **Preview** page to send yourself a test uninstall tracking push.
4. Check that your app does not take any unwanted automatic actions upon receiving the push.

{% alert important %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ The Braze and Contentsquare integration allows you to send Live Signals (fraud,
| Requirement | Description |
| ----------- | ----------- |
| Contentsquare account | A Contentsquare account is required to take advantage of this partnership. |
| Braze REST API key | A Braze REST API key with `users.track` permissions. To create a new key in the Braze dashboard, go to **Settings** > **API Keys**. |
| Braze REST endpoint | [Your REST endpoint URL][1]. Your endpoint will depend on the Braze URL for your instance. |
{: .reset-td-br-1 .reset-td-br-2}

## Use cases
Expand Down Expand Up @@ -50,4 +52,4 @@ If you are using the [older navigation]({{site.baseurl}}/navigation), you can fi

![Contentsquare Live Signals data in Braze Custom Events tab][1]

[1]: {% image_buster /assets/img/contentsquare_custom_events.png %}
[1]: {% image_buster /assets/img/contentsquare_custom_events.png %}
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The Braze and Lexer integration allows you to sync data across the two platforms
| Requirement | Description |
| ----------- | ----------- |
| Partner account | A Lexer account is required to take advantage of this partnership. |
| Braze REST API key | A Braze REST API key with `users.track` permissions (excluding `user.delete`) and `segment.list` permissions. The permission set may change as Lexer adds support for more Braze objects, so you may either want to grant more permissions now or plan to update these permissions in the future.<br><br> This can be created in the Braze dashboard from **Settings** > **API Keys**. |
| Braze REST API key | A Braze REST API key with all `user` permissions (excluding `user.delete`) and `segment.list` permissions. The permission set may change as Lexer adds support for more Braze objects, so you may either want to grant more permissions now or plan to update these permissions in the future.<br><br> This can be created in the Braze dashboard from **Settings** > **API Keys**. |
| Braze REST endpoint | Your [REST endpoint URL]({{site.baseurl}}/api/basics/#endpoints). Your endpoint will depend on the Braze URL for your instance. |
| Amazon AWS S3 bucket and credentials | Before beginning the integration, you must have access credentials for an AWS S3 bucket connected to your Lexer hub (this may be a bucket you create or one that Lexer creates and manages for you). Visit [Lexer](https://learn.lexer.io/docs/amazon-s3) for guidance on this requirement. |
{: .reset-td-br-1 .reset-td-br-2}
Expand Down Expand Up @@ -78,4 +78,4 @@ You can now add this newly created segment to future Braze campaigns and Canvase
[4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingBucket.html
[5]: {{site.baseurl}}/partners/data_and_infrastructure_agility/cloud_storage/amazon_s3/
[6]: https://lexer.io/
[7]: {% image_buster /assets/img/lexer/lexer.png %}
[7]: {% image_buster /assets/img/lexer/lexer.png %}
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The Braze and Airbyte integration allows users to create a data pipeline to coll
| ----------- | ----------- |
| Airbyte Cloud account | An [Airbyte Cloud](https://cloud.airbyte.io/workspaces) account is required to take advantage of this integration. |
| Braze REST API key | A Braze REST API key with all permissions. <br><br> This can be created in the Braze dashboard from **Settings** > **API Keys**. |
| Braze REST endpoint | [Your REST endpoint URL][1]. Your endpoint will depend on the Braze URL for your instance. |
| Braze REST endpoint | Your endpoint will depend on the Braze URL for your instance. |
{: .reset-td-br-1 .reset-td-br-2}

## Integration
Expand Down Expand Up @@ -53,4 +53,4 @@ Airbyte's Braze source connector supports the following [sync modes](https://doc

{% alert note %}
Rate limits differ depending on the stream. Visit the [rate limits table](https://www.braze.com/docs/api/api_limits/#rate-limits-by-request-type) for more information.
{% endalert %}
{% endalert %}
Loading