Skip to content
This repository has been archived by the owner on Sep 22, 2023. It is now read-only.

Commit

Permalink
AMP-84095 add description of Braze User Alias Label (#964)
Browse files Browse the repository at this point in the history
* AMP-84095 add description of Braze User Alias Label

* Update docs/data/destinations/braze.md

Co-authored-by: markzegarelli <[email protected]>

* Update docs/data/destinations/braze.md

Co-authored-by: markzegarelli <[email protected]>

* Disable linting in formatguide

* further cleanup and rerun jobs

* suppress the spelling errors

---------

Co-authored-by: markzegarelli <[email protected]>
  • Loading branch information
sina-jamshidi and markzegarelli authored Sep 7, 2023
1 parent 5374ba3 commit 1c0a8f3
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 5 deletions.
7 changes: 4 additions & 3 deletions docs/data/destinations/braze.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Braze Event Streaming
description: Amplitude CDP's Braze streaming integration enables you to forward your Amplitude events and users straight to Braze with just a few clicks.
---

Amplitude CDP's Braze streaming integration enables you to forward your Amplitude events and users straight to [Braze](https://www.braze.com/) with just a few clicks.
The Amplitude CDP Braze streaming integration enables you to forward your Amplitude events and users straight to [Braze](https://www.braze.com/) with just a few clicks.

!!!note "Other Amplitude CDP + Braze integrations"

Expand Down Expand Up @@ -33,7 +33,8 @@ To configure streaming from Amplitude to Braze, you need the following informati
1. Select your **Braze API Endpoint**.
2. Enter your **Braze API Key**.
3. Enter your **Braze App ID**.
4. Check **Update Users Only** to only update users that exist in Braze, and not create new ones. If you're sending alias-only user profiles, don't check this field. If you check **Update Users Only**, your alias-only user profiles aren't created in Braze. More information available in the [Braze documentation](https://www.braze.com/docs/api/objects_filters/user_attributes_object).
4. If you use the [Braze User Alias](https://www.braze.com/docs/api/objects_filters/user_alias_object) to identify your users on Braze, enter the **Braze User Alias Label** you plan to use. Otherwise, you can ignore this field.
5. Check the **Update Users Only** option to update users that exist in Braze, not create new users. If you send alias-only user profiles, don't check this field. If you check **Update Users Only**, your alias-only user profiles aren't created in Braze. More information available in the [Braze documentation](https://www.braze.com/docs/api/objects_filters/user_attributes_object).

### Configure mappings

Expand Down Expand Up @@ -62,7 +63,7 @@ Under **Send Events**, make sure the toggle is enabled ("Events are sent to Braz
### Configure user forwarding

!!!warning "Temporarily Disabled"
We're actively working on improving the experience of user forwarding to Braze, including addressing concerns around high call volumes which can incur additional costs in Braze. All enabled user forwarding syncs will continue to run. Temporarily, no new user forwarding syncs can be enabled. If an enabled user forwarding sync is disabled, it can not be re-enabled at this time. Event forwarding to Braze is unaffected by this and can still be configured as normal. User forwarding destinations other than Braze are also unaffected and can still be configured as normal.
Amplitude is working to improve the experience of user forwarding to Braze, including addressing concerns around high call volumes which can incur additional costs in Braze. All enabled user forwarding syncs will continue to run. Temporarily, no new user forwarding syncs can be enabled. If an enabled user forwarding sync is disabled, it can not be re-enabled at this time. Event forwarding to Braze is unaffected by this and can still be configured as normal. User forwarding destinations other than Braze are also unaffected and can still be configured as normal.

Under **Send Users**, make sure the toggle is enabled ("Users are sent to Braze") if you want to stream users and their properties to Braze. When enabled, users are automatically created or updated in Braze when an event is sent to Amplitude. [Amplitude Identify API](https://www.docs.developers.amplitude.com/analytics/apis/identify-api/) calls are also forwarded to Braze. Users aren't sent on a schedule or on-demand using this integration.

Expand Down
4 changes: 2 additions & 2 deletions docs/data/sources/tealium.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ In the data layer, you can define the following variable types:
};
</script> 
```
<!-- /* cSpell:enable */ -->
* **Querystring Parameters:** This captures parameters from the URL. For example, if the URL is `http://example.com/path/file.html?sortOrder=price`, the variable name in Tealium is `sortOrder`.
* **First-Party Cookies:** Reference value in a cookie being set on your domain. When creating a cookie variable, you can either specify Tealium cookie, `utag_main`, or standard cookie. You can also add your own custom values to the `utag_main cookie`. The `utag.js` library creates and maintains a single cookie called `utag_main`; within it are several built-in values that keep track of the visitor session.
* `ses_id`: Unique identifier for the session.
Expand All @@ -92,7 +92,7 @@ In the data layer, you can define the following variable types:
* **JavaScript Variables:** Select this to reference a JavaScript variable on the web page other than the `utag_data` object.
* **Meta Data Elements:** Reference content of a meta tag in the page.
* **AudienceStream Attributes:** Attributes such as badges, metrics, and properties that are defined in AudienceStream, which takes data that flows into Tealium's other product (Universal Data Hub) and creates visitor profiles representing the most important attributes of user engagement.

<!-- /* cSpell:enable */ -->
### Load rules

Load rules are conditions that define when and where to load a tag. They consist of logical conditions that must pass before Amplitude loads a tag. For example, you can set it up so that only certain tags load on certain domains. You can use AND/OR logic or time/date-based conditions to load tags.
Expand Down
6 changes: 6 additions & 0 deletions docs/utils/formatguide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
title: Format Guide
description: See how different formatting options render
---
<!-- /* cSpell:disable */ -->
<!-- markdownlint-disable MD037 -->
<!-- markdownlint-disable MD040 -->
<!-- markdownlint-disable MD048 -->
<!-- markdownlint-disable MD012 -->
<!-- markdownlint-disable MD031 -->

This cheatsheet covers the most used formatting features like admonitions and code blocks.

Expand Down

0 comments on commit 1c0a8f3

Please sign in to comment.