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

Deploy pt 3 - July 8, 2024 #7640

Merged
merged 41 commits into from
Jul 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
1263e36
BD-3200 LINE channel beta
rachel-feinberg Jun 26, 2024
53419d1
Add Subscription groups and reporting articles
rachel-feinberg Jun 27, 2024
3490139
Add troubleshooting docs for Swift SDK IAM networking
jerielng Jun 28, 2024
b79153d
Add Objective-C samples
jerielng Jun 28, 2024
8cdbefb
Fixing the JSON.
ian-absher Jul 2, 2024
8492f21
BD-3228 Delegating your custom domain
rachel-feinberg Jul 2, 2024
5a9a6f2
File platform_overview.md committed.
Translationmanagement Jul 3, 2024
faeb66b
Merge pull request #7629 from braze-inc/i18n_phrase-ja
josh-mccrowell-braze Jul 3, 2024
d42d823
Merge pull request #7625 from braze-inc/DI-6442-fixing-json
josh-mccrowell-braze Jul 3, 2024
2b976e5
BD-3231 Multi-page IAMs GA
rachel-feinberg Jul 3, 2024
d5e01a8
Update universal_links.md
gsinghAppboy Jul 3, 2024
5207954
Merge pull request #7631 from braze-inc/docs_update_deeplinks
bre-fitzgerald Jul 3, 2024
612c160
Fix bullets
rachel-feinberg Jul 3, 2024
35b8e01
Apply suggestions from code review
josh-mccrowell-braze Jul 3, 2024
035800f
Merge pull request #7609 from braze-inc/swift-networking
josh-mccrowell-braze Jul 3, 2024
34d4a16
Merge pull request #7630 from braze-inc/bd-3231
bre-fitzgerald Jul 3, 2024
61cf2d0
Update _docs/_hidden/private_betas/link_shortening.md
rachel-feinberg Jul 3, 2024
192230a
Merge pull request #7628 from braze-inc/bd-3228
rachel-feinberg Jul 3, 2024
7246278
Add final articles
rachel-feinberg Jul 3, 2024
df28e7a
Make hidden
rachel-feinberg Jul 3, 2024
6b07960
Remove references to the catalog-in-process-error
Vector919 Jul 8, 2024
a4ba012
Merge pull request #7633 from braze-inc/CO-2618-remove-catalog-in-pro…
lydia-xie Jul 8, 2024
1a1c685
BD-3233: Clarify email_encrypted detail
lydia-xie Jul 8, 2024
0f29e0e
Add details
rachel-feinberg Jul 8, 2024
afb4f98
Merge pull request #7634 from braze-inc/BD-3233
internetisaiah Jul 8, 2024
3dea18f
BD-3223
lydia-xie Jul 8, 2024
8c0f74d
fix link
lydia-xie Jul 8, 2024
3e406b9
Final edits
rachel-feinberg Jul 8, 2024
bf4d17c
Add Launch Content Block permission
lydia-xie Jul 8, 2024
9188c06
Update _docs/_user_guide/data_and_analytics/report_metrics.md
rachel-feinberg Jul 8, 2024
90200d2
Merge pull request #7636 from braze-inc/BD-3226
rachel-feinberg Jul 8, 2024
ddd7c03
Update _docs/_user_guide/data_and_analytics/custom_data/custom_attrib…
lydia-xie Jul 8, 2024
f48914f
Merge pull request #7635 from braze-inc/BD-3223
lydia-xie Jul 8, 2024
6e328be
Add article and nav title to feedback
zzhaobraze Jul 8, 2024
7f05046
Edits
rachel-feinberg Jul 8, 2024
46c491f
Apply suggestions from code review pt 1
rachel-feinberg Jul 8, 2024
c1abe34
Merge pull request #7637 from braze-inc/update_feedback_with_titles
josh-mccrowell-braze Jul 8, 2024
f0e7b29
Final touches
rachel-feinberg Jul 8, 2024
ba6d129
Link
rachel-feinberg Jul 8, 2024
d35e7fd
Merge pull request #7638 from braze-inc/bd-3236
lydia-xie Jul 8, 2024
35d9ccc
Merge pull request #7589 from braze-inc/bd-3200-2
rachel-feinberg Jul 8, 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
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,6 @@ The following table lists possible returned errors and their associated troubles
| Error | Troubleshooting |
| -------------------- | -------------------------------------------------------- |
| `catalog-not-found` | Check that the catalog name is valid. |
| `catalog-in-process` | Catalog is currently processing. Please try again later. |
| `invalid-selection` | Check that the selection name is valid. |
{: .reset-td-br-1 .reset-td-br-2}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,6 @@ The following table lists possible returned errors and their associated troubles
| `catalog-not-found` | Check that the catalog name is valid. |
| `company-size-limit-already-reached` | The catalog storage size limit is reached. |
| `selection-limit-reached` | The catalog selections limit is reached. |
| `catalog-in-process` | Catalog is currently processing. Please try again later. |
| `invalid-selection` | Check that the selection is valid. |
| `too-many-filters` | Check if the selection has too many filters. |
| `selection-name-already-exists` | Check if the selection name already exists in the catalog. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,72 @@ If your app is successfully requesting and receiving in-app messages but they ar
- Failed image downloads will prevent in-app messages with images from displaying. Check your device logs to ensure that image downloads are not failing.
- If the device orientation did not match the orientation specified by the in-app message, the in-app message will not display. Make sure that your device is in the correct orientation.

### Troubleshooting asset loading (`NSURLError` code `-1008`)

When integrating Braze alongside third-party network logging libraries, developers can commonly run into an `NSURLError` with the domain code `-1008`. This error indicates that assets like images and fonts could not be retrieved or failed to cache. To work around such cases, you will need to register Braze's CDN URLs to the list of domains that should be ignored by these libraries.

#### Domains

The full list of CDN domains is as listed below:

* `"appboy-images.com"`
* `"braze-images.com"`
* `"cdn.braze.eu"`
* `"cdn.braze.com"`

#### Examples

Below are libraries that are known to conflict with Braze's asset caching, along with example code to work around the issue. If your project uses a library that causes an unavailable resource error and is not listed below, consult the documentation of that library for similar usage APIs.

##### Netfox

{% tabs %}
{% tab Swift %}
```swift
NFX.sharedInstance().ignoreURLs(["https://cdn.braze.com"])
```
{% endtab %}
{% tab Objective-C %}
```objc
[NFX.sharedInstance ignoreURLs:@[@"https://cdn.braze.com"]];
```
{% endtab %}
{% endtabs %}

##### NetGuard

{% tabs %}
{% tab Swift %}
```swift
NetGuard.blackListHosts.append(contentsOf: ["cdn.braze.com"])
```
{% endtab %}
{% tab Objective-C %}
```objc
NSMutableArray<NSString *> *blackListHosts = [NetGuard.blackListHosts mutableCopy];
[blackListHosts addObject:@"cdn.braze.com"];
NetGuard.blackListHosts = blackListHosts;
```
{% endtab %}
{% endtabs %}

##### XNLogger

{% tabs %}
{% tab Swift %}
```swift
let brazeAssetsHostFilter = XNHostFilter(host: "https://cdn.braze.com")
XNLogger.shared.addFilters([brazeAssetsHostFilter])
```
{% endtab %}
{% tab Objective-C %}
```objc
XNHostFilter *brazeAssetsHostFilter = [[XNHostFilter alloc] initWithHost: @"https://cdn.braze.com"];
[XNLogger.shared addFilters:@[brazeAssetsHostFilter]];
```
{% endtab %}
{% endtabs %}

[iam_1]: {{ site.baseurl }}/user_guide/administrative/app_settings/developer_console/internal_groups_tab/#adding-test-users
[iam_2]: {{ site.baseurl }}/user_guide/administrative/app_settings/developer_console/event_user_log_tab/#event-user-log-tab
[iam_3]: {{ site.baseurl }}/user_guide/administrative/app_settings/developer_console/event_user_log_tab/#event-user-log-tab
Expand Down
2 changes: 1 addition & 1 deletion _docs/_help/help_articles/email/universal_links.md
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ This custom path allows you to selectively treat URLs with that value as a unive
For example:

```html
<a href=”https://www.example.com” data-msys-sublink="open_in_app">
<a href=”https://www.example.com” data-msys-sublink="open-in-app">
```

Then, make sure your app is set up to handle the custom path properly. Refer to SparkPost's article on [Using SparkPost click tracking on deep links](https://support.sparkpost.com/docs/tech-resources/deep-links-self-serve#preferred-solution-using-sparkpost-click-tracking-on-deep-links). This article contains example code for [iOS](https://support.sparkpost.com/docs/tech-resources/deep-links-self-serve#ios-swift-forwarding-clicks-to-sparkpost) and [Android](https://support.sparkpost.com/docs/tech-resources/deep-links-self-serve#forwarding-clicks-from-android-to-sparkpost).
Expand Down
1 change: 1 addition & 0 deletions _docs/_hidden/misc_reference/scim_api_appendix.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ A valid team permission object is a JSON object with the following key-value pai
| Import and Update User Data | `import_update_user_data` |
| View Billing Details | `view_billing_details` |
| Access Dev Console | `dev_console` |
| Launch Content Blocks | `launch_content_blocks` |
| Manage External Integrations | `manage_external_integrations` |
| Manage Apps | `manage_apps` |
| Manage Teams | `manage_teams` |
Expand Down
2 changes: 1 addition & 1 deletion _docs/_hidden/private_betas/field_level_encryption.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ When updating email address in Braze, you should use the hashed email value wher
- Adding or updating users via CSV

{% alert note %}
When creating a new user, you must add `email_encrypted` with the user's encrypted email value. Otherwise, the user will not be created.
When creating a new user, you must add `email_encrypted` with the user's encrypted email value. Otherwise, the user will not be created. Similarly, if you're adding an email address to an existing user who doesn't have an email, you must add `email_encrypted`. Otherwise, the user will not be updated.
{% endalert %}

## Considerations
Expand Down
15 changes: 15 additions & 0 deletions _docs/_hidden/private_betas/link_shortening.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,21 @@ Contact your Braze account manager if you're interested in getting started with
- You can also use unique subdomains, such as `sms.braze.com`.
- We recommend choosing a domain with as few characters as possible to minimize the length of your URLs.

#### Delegating your custom domain

When you delegate your domain to Braze, we automatically handle the certificate renewal to prevent a lapse in service.

To delegate your domain to Braze, do the following:

1. Bring a domain that meets the above requirements to your customer success manager. Braze will then check the existing DNS configuration for the domain and confirm that:
- No CAA records exist OR
- CAA records *do* exist but have a record for {% raw %}`<any number> issue "letsencrypt.org"`{% endraw %} or {% raw %}`<anynumber> issuewild "letsencrypt.org"`{% endraw %}
2. Create four new A records, one for each IP, and confirm that they are the only A records that exist for the domain link host:
- 151.101.130.133
- 151.101.194.133
- 151.101.2.133
- 151.101.66.133

### Using custom domains

Once configured, custom domains can be assigned to one or multiple SMS subscription groups.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ This event occurs when a specific custom event is triggered. Use this to track w
"device_id" : "(optional, string) ID of the device on which the event occurred",
"external_user_id" : "(required, string) External ID of the user",
"timezone" : "(optional, string) Time zone of the user",
"user_id": (required, string) Braze user ID of the user who performed this event"
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
}
```
Expand Down Expand Up @@ -128,7 +128,7 @@ This event occurs when a specific custom event is triggered. Use this to track w
"properties" : "(required, string) Custom properties stored as a JSON encoded string",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id": (required, string) Braze user ID of the user who performed this event"
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
```
{% endtab %}
Expand Down Expand Up @@ -206,7 +206,7 @@ Purchases are special custom events and come with a JSON encoded string of custo
"user" : {
"device_id" : "(optional, string) ID of the device on which the event occurred",
"external_user_id" : "(required, string) External ID of the user",
"user_id": (required, string) Braze user ID of the user who performed this event"
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
}
```
Expand Down Expand Up @@ -261,7 +261,7 @@ Purchases are special custom events and come with a JSON encoded string of custo
"product_id" : "(required, string) ID of the product purchased",
"properties" : "(required, string) Custom properties stored as a JSON encoded string",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id": (required, string) Braze user ID of the user who performed this event"
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
```
{% endtab %}
Expand Down Expand Up @@ -339,7 +339,7 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar
"device_id" : "(optional, string) ID of the device on which the event occurred",
"external_user_id" : "(required, string) External ID of the user",
"timezone" : "(optional, string) Time zone of the user",
"user_id": (required, string) Braze user ID of the user who performed this event"
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
}
```
Expand Down Expand Up @@ -388,7 +388,7 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar
"session_id" : "(required, string) UUID of the session",
"time" : "(required, int) UNIX timestamp at which the event happened",
"timezone" : "(optional, string) Time zone of the user",
"user_id": (required, string) Braze user ID of the user who performed this event"
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
```
{% endtab %}
Expand Down Expand Up @@ -454,7 +454,7 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar
"user" : {
"device_id" : "(optional, string) ID of the device on which the event occurred",
"external_user_id" : "(required, string) External ID of the user",
"user_id": (required, string) Braze user ID of the user who performed this event"
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
}
```
Expand Down Expand Up @@ -498,7 +498,7 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar
"platform" : "(optional, string) Platform of the device",
"session_id" : "(required, string) UUID of the session",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id": (required, string) Braze user ID of the user who performed this event"
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
```
{% endtab %}
Expand Down Expand Up @@ -565,7 +565,7 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar
"user" : {
"device_id" : "(optional, string) ID of the device on which the event occurred",
"external_user_id" : "(required, string) External ID of the user",
"user_id": (required, string) Braze user ID of the user who performed this event"
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
}
```
Expand Down Expand Up @@ -611,7 +611,7 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar
"platform" : "(optional, string) Platform of the device",
"session_id" : "(required, string) UUID of the session",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id": (required, string) Braze user ID of the user who performed this event"
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
```
{% endtab %}
Expand Down Expand Up @@ -681,7 +681,7 @@ This event is triggered when a user visits a specified location. Use this to tra
"user" : {
"device_id" : "(optional, string) ID of the device on which the event occurred",
"external_user_id" : "(required, string) External ID of the user",
"user_id": (required, string) Braze user ID of the user who performed this event"
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
}
```
Expand Down Expand Up @@ -739,7 +739,7 @@ This event is triggered when a user visits a specified location. Use this to tra
"os_version" : "(optional, string) Version of the operating system of the device",
"platform" : "(optional, string) Platform of the device",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id": (required, string) Braze user ID of the user who performed this event"
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
```
{% endtab %}
Expand Down Expand Up @@ -809,7 +809,7 @@ This event occurs when an app installation is attributed to a source. Use this t
"user" : {
"device_id" : "(optional, string) ID of the device on which the event occurred",
"external_user_id" : "(required, string) External ID of the user",
"user_id": (required, string) Braze user ID of the user who performed this event"
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
}
```
Expand Down Expand Up @@ -844,7 +844,7 @@ This event occurs when an app installation is attributed to a source. Use this t
"id" : "(required, string) Globally unique ID for this event",
"source" : "(required, string) The source of the attribution",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id": (required, string) Braze user ID of the user who performed this event"
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
```
{% endtab %}
Expand Down Expand Up @@ -893,7 +893,7 @@ This user event occurs every time a new user is created within their workspace.
"prev_random_bucket_number" : "(optional, int) Previous random bucket number",
"random_bucket_number" : "(required, int) New random bucket number",
"time" : "(required, int) UNIX timestamp at which the event happened",
"user_id": (required, string) Braze user ID of the user who performed this event"
"user_id" : "(required, string) Braze user ID of the user who performed this event"
}
```
{% endtab %}
Expand Down
Loading