A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
1 | Data Planning | |||||||||||||||||||||||||
2 | ||||||||||||||||||||||||||
3 | Custom Attribute: | These are facts about your users that can be used to segment on and personalise your messages. E.g. "account_username", "account_creation_date", "purchased_merchant_categories". | ||||||||||||||||||||||||
4 | Custom Event: | These are actions that your users are taking. We count how many times a user has done that action, and timestamp the actions. These can be used to segment users, trigger campaigns and track conversions. E.g. "product_added", "subscription_started". | ||||||||||||||||||||||||
5 | Custom Event Property: | These are meta data on Custom Events and can be used to qualify a trigger, or personalise a message. *Note: Because they are not stored in Braze, they can only be used at the point of action. E.g. When someone "product_added" you could say 'only send this campaign if the "product_category is equal to men's clothing". To store these properties long term, track them as an Array Custom Attribute. E.g. "purchased_merchant_categories". | ||||||||||||||||||||||||
6 | Purchase: | A purchase is similar to a custom event. This is a purchase that your user is making. We count how many times a user has done that purchase, and timestamp the purchase. These can be used to segment users, trigger campaigns and track conversions. E.g. For eCommerce, Retail and QSR: Product Category ["coffee","food"] For FinTech: Merchant Vertical ["electronics","health"] For Food Delivery App: Meal Category ["breakfast","lunch","dinner"] For SaaS: Plan Name ["monthly_subscription","annual_subscription"] | ||||||||||||||||||||||||
7 | Purchase Property: | These are meta data on Purchases and can be used to qualify a trigger, or personalise a message. *Note: Because they are not stored in Braze, they can only be used at the point of action. E.g. When someone "Makes Purchase" you could say "Thanks for ordering a {{event_properties.${product_name}}}". | ||||||||||||||||||||||||
8 | ||||||||||||||||||||||||||
9 | ||||||||||||||||||||||||||
10 | Automatically Collected Data | |||||||||||||||||||||||||
11 | ||||||||||||||||||||||||||
12 | The following events and attributes are captured and updated automatically by the Braze SDK. | |||||||||||||||||||||||||
13 | You do not need to record them separately as Custom Events or Custom Attributes. | |||||||||||||||||||||||||
14 | ||||||||||||||||||||||||||
15 | Automatically Collected Data | Available for Initial Import? | Historical Import Required | Import Source (SDK/API) | Additional Info | |||||||||||||||||||||
16 | Session Count | NO | N/A | |||||||||||||||||||||||
17 | date_of_first_session | YES | ||||||||||||||||||||||||
18 | date_of_last_session | YES | ||||||||||||||||||||||||
19 | country | YES | ||||||||||||||||||||||||
20 | language | YES | ||||||||||||||||||||||||
21 | time_zone | YES | ||||||||||||||||||||||||
22 | Device Information | NO | N/A | |||||||||||||||||||||||
23 | Device Locale | NO | N/A | |||||||||||||||||||||||
24 | Campaign Data | NO | N/A | |||||||||||||||||||||||
25 | push_tokens | YES | Migrating Push Tokens | |||||||||||||||||||||||
26 | ||||||||||||||||||||||||||
27 | ||||||||||||||||||||||||||
28 | Standard User Attributes + Reserved Keys | |||||||||||||||||||||||||
29 | ||||||||||||||||||||||||||
30 | This is data which Braze has standard naming convensions for, and which therefore does not need to be passed as a Custom Attribute. | |||||||||||||||||||||||||
31 | *Only send this data the first time you set the attribute value & when the value changes (i.e. the “deltas”). Braze will re-write every attribute that is sent and will not check whether the value already exists. | |||||||||||||||||||||||||
32 | ||||||||||||||||||||||||||
33 | Standard User Attributes | Description | Required? | Historical Import Required | Import Source (SDK/API/CSV) | |||||||||||||||||||||
34 | external_id | A unique and secure User IDs set for each of your Identified User Profile | Mandatory | |||||||||||||||||||||||
35 | first_name | First Name | ||||||||||||||||||||||||
36 | last_name | Last Name | ||||||||||||||||||||||||
37 | Email address, necessary to target them via email. | |||||||||||||||||||||||||
38 | dob | Date of Birth | ||||||||||||||||||||||||
39 | home_city | City | ||||||||||||||||||||||||
40 | gender | Gender (female, male, other, unknown, not applicable, prefer not to say) | ||||||||||||||||||||||||
41 | email_subscribe | Email Subscription Status (Subscribed, Opted In, Unsubscribed) | ||||||||||||||||||||||||
42 | push_subscribe | Push Subscription Status (Subscribed, Opted In, Unsubscribed) | ||||||||||||||||||||||||
43 | country | Automatically Collected by default (see above), however can be overriden | ||||||||||||||||||||||||
44 | phone | Phone Number. Format requires a + and a country code, e.g. +61456333444. | ||||||||||||||||||||||||
45 | ||||||||||||||||||||||||||
46 | ||||||||||||||||||||||||||
47 | Subscription Groups | |||||||||||||||||||||||||
48 | Subscription Group Name | Description | Required? | Historical Import Required | Import Source (SDK/API/CSV) | |||||||||||||||||||||
49 | Email marketing | subscription id= | API | |||||||||||||||||||||||
50 | SMS marketing | subscription id= | API | |||||||||||||||||||||||
51 | ||||||||||||||||||||||||||
52 | ||||||||||||||||||||||||||
53 | Custom Attributes | |||||||||||||||||||||||||
54 | ||||||||||||||||||||||||||
55 | These are facts about your users that can be used to segment on and personalise your messages. There are five different data types available: String, Boolean, Array, Integer and Date. | |||||||||||||||||||||||||
56 | *Only send this data the first time you set the attribute value & when the value changes (i.e. the “deltas”). Braze will re-write every attribute that is sent and will not check whether the value already exists. | |||||||||||||||||||||||||
57 | ||||||||||||||||||||||||||
58 | Custom Attributes | Description | Data Type | Historical Import Required Arrays are not supported in CSV User Import | Import Source (SDK/API/CSV) | Examples | ||||||||||||||||||||
59 | account_tier | A user's account tier within the app, Premium or Free | String | API | Premium, Free | |||||||||||||||||||||
60 | ||||||||||||||||||||||||||
61 | ||||||||||||||||||||||||||
62 | ||||||||||||||||||||||||||
63 | ||||||||||||||||||||||||||
64 | ||||||||||||||||||||||||||
65 | ||||||||||||||||||||||||||
66 | ||||||||||||||||||||||||||
67 | ||||||||||||||||||||||||||
68 | ||||||||||||||||||||||||||
69 | ||||||||||||||||||||||||||
70 | ||||||||||||||||||||||||||
71 | ||||||||||||||||||||||||||
72 | Custom Events | |||||||||||||||||||||||||
73 | ||||||||||||||||||||||||||
74 | These are actions that your users are taking. We count how many times a user has done that action, and timestamp the actions. These can be used to segment users, trigger campaigns and track conversions. E.g. "account_created", "order_completed". | |||||||||||||||||||||||||
75 | You can also specify event properties, these are meta data on Custom Events and can be used to qualify a trigger, or personalise a message. Note that because they are not stored in Braze, they can only be used at the point of action. E.g. When someone "product_added" you could say 'only send this campaign if the "product_category is equal to men's clothing". | |||||||||||||||||||||||||
76 | *Note: Each Custom Event can have up to 256 distinct Custom Event Properties. If a Custom Event is logged more than 256 properties, only the first 256 be available for use (e.g. for personalization) | |||||||||||||||||||||||||
77 | ||||||||||||||||||||||||||
78 | Custom Events The most common naming structure is group_noun_action (past tense). Events should all be lower case to avoid casing instrumentation errors and identifying properties. | Description | Historical Import Required (API Only) Custom event data types are not supported in CSV User Import. | Import Source (SDK/API) | Event Property 1 | Event Property 2 | Event Property 3 | Event Property 4 | Event Property 5 | |||||||||||||||||
79 | payment_sent | Records when a user sends a payment | SDK | transaction_type | payment_amount | recipient | ||||||||||||||||||||
80 | payment_received | Records when a user receives a payment | SDK | transaction_type | payment_amount | sender | ||||||||||||||||||||
81 | completed_account_registration | Triggers when a user completes the account registration form | API (form is 3rd party) | |||||||||||||||||||||||
82 | added_funds | Records whenever a user adds funds in the app | SDK | |||||||||||||||||||||||
83 | registered_for_premium | Records when a user's payment for premium tier has been processed | API (triggers from payment backend) | |||||||||||||||||||||||
84 | sent_referal_link | Records when a user enters a referral email address into form in the app | SDK | |||||||||||||||||||||||
85 | linked_bank | Records when a user links their bank for deposits into CashBlastr. | SDK | bank_name | ||||||||||||||||||||||
86 | direct_deposit_setup | Records when a user links their bank for transfer of data from CashBlastr to their bank | SDK | bank_name | ||||||||||||||||||||||
87 | ||||||||||||||||||||||||||
88 | ||||||||||||||||||||||||||
89 | ||||||||||||||||||||||||||
90 | ||||||||||||||||||||||||||
91 | ||||||||||||||||||||||||||
92 | ||||||||||||||||||||||||||
93 | ||||||||||||||||||||||||||
94 | Purchase Events | |||||||||||||||||||||||||
95 | ||||||||||||||||||||||||||
96 | A purchase is similar to a custom event. This is a purchase that your user is making. We count how many times a user has done that purchase, and timestamp the purchase. These can be used to segment users, trigger campaigns and track conversions. E.g. "food", "coffee". | |||||||||||||||||||||||||
97 | These are meta data on Purchases and can be used to qualify a trigger, or personalise a message. Note that because they are not stored in Braze, they can only be used at the point of action. E.g. When someone "Makes Purchase" you could say "Thanks for ordering a {{event_properties.${product_name}}}". | |||||||||||||||||||||||||
98 | *Note: Each Purchase Event can have up to 256 distinct Event Properties. If a Purchase is logged more than 256 properties, only the first 256 be available for use (e.g. for personalization) | |||||||||||||||||||||||||
99 | ||||||||||||||||||||||||||
100 | product_id product_id can be used for segmentation, triggering and conversion tracking. Braze notes the number of times a user has bought a specific product_id as well as the first and last time they were purchased. | Description | Historical Import Required (API Only) Purchase data types are not supported in CSV User Import. | Import Source (SDK/API) | Purchase Property 1 | Purchase Property 2 | Purchase Property 3 | Purchase Property 4 | Purchase Property 5 | Description |