You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/_data/actions/braze-cloud.yml
+11-11Lines changed: 11 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -12,22 +12,22 @@ config:
12
12
connection_mode:
13
13
- cloud
14
14
configurable: true
15
-
location:
15
+
location:
16
16
notes: This setting is renamed API Key, and is available during initial configuration, or on the Settings tab after configuration.
17
17
- name: Custom API Endpoint
18
18
connection_mode:
19
19
- device-web
20
20
configurable: false
21
21
location:
22
-
notes: This setting is not needed in Braze Web Mode (Actions).
22
+
notes: This setting is not needed in Braze Web Mode (Actions).
23
23
- name: Appboy Datacenter
24
24
connection_mode:
25
25
- cloud
26
26
configurable: false
27
27
location: ""
28
28
notes: This setting is covered by the REST API Endpoint
29
29
- name: Log Purchase when Revenue is present
30
-
connection_mode:
30
+
connection_mode:
31
31
- device-web
32
32
configurable: true
33
33
location:
@@ -170,7 +170,7 @@ actions:
170
170
description: The object that contains properties pertaining to the event.
171
171
default: properties
172
172
- name: Update Existing Only
173
-
description: Set to true to use the Braze API in "Update Only" mode.
173
+
description: Set to true to use the Braze API in "Update Only" mode.
174
174
default: false
175
175
- action: Track Purchase
176
176
blurb: Track Purchase sends Braze a Track Purchase call when the destination recieves any event that matches the specified name.
@@ -194,7 +194,7 @@ actions:
194
194
description: The object that contains properties pertaining to the event.
195
195
default: properties
196
196
- name: Update Existing Only
197
-
description: Set to true to use the Braze API in "Update Only" mode.
197
+
description: Set to true to use the Braze API in "Update Only" mode.
198
198
default: false
199
199
- action: Update User Profile
200
200
blurb: Update User Profile sends to Braze a request to update an existing user's profile attributes when the destination receives an Identify call.
@@ -228,10 +228,10 @@ actions:
228
228
default: traits.email
229
229
- name: Email Subscribe
230
230
description: "The user's email subscription preference. Must be one of: `opted_in`, `unsubscribed`, or `subscribed`"
231
-
default:
231
+
default:
232
232
- name: Email Open Tracking Disabled
233
233
description: Set to true to disable adding the open tracking pixel to all future emails sent to this user.
234
-
default:
234
+
default:
235
235
- name: Email Click Tracking Disabled
236
236
description: Set to true to disable click tracking for all links within future emails sent to this user.
237
237
default:
@@ -266,7 +266,7 @@ actions:
266
266
description: "The user's push subscription preference: `opted_in` (explicitly registered to receive push messages), `unsubscribed` (explicitly opted out of push messages), and `subscribed` (neither opted in nor out)."
267
267
default:
268
268
- name: Push Tokens
269
-
description: "An array of objects with app_id and token string. You can optionally provide a `device_id` for the device this token is associated with. For example,`{\"app_id\": App Identifier, \"token\": \"abcd\", \"device_id\": \"optional_field_value\"}. If a device_id is not provided, a random value is generated."
269
+
description: "An array of objects with app_id and token string. You can optionally provide a `device_id` for the device this token is associated with. For example,`{\"app_id\": App Identifier, \"token\": \"abcd\", \"device_id\": \"optional_field_value\"}. If a device_id is not provided, a random value is generated."
270
270
default:
271
271
- name: Time Zone
272
272
description: The user's time zone from the IANA Time Zone Database. For example, `America/New_York`.
@@ -278,10 +278,10 @@ actions:
278
278
description: A hash of custom attributes sent to Braze.
279
279
default: traits
280
280
- name: Update Existing Only
281
-
description: Set this flag to true to put the API in "Update Only" mode.
281
+
description: Set this flag to true to put the API in "Update Only" mode.
282
282
default: true
283
283
- action: Identify Debounce
284
284
blurb: >
285
-
When enabled for Javascript sources, this action ensure that only Identify calls where at least one updated trait value are sent to Braze. Events with duplicate traits are not sent.
285
+
When enabled for JavaScript sources, this action ensure that only Identify calls where at least one updated trait value are sent to Braze. Events with duplicate traits are not sent.
286
286
To use Identify Debounce with mobile sources, include Segment's open-source [Middleware tool](https://github.com/segmentio/segment-braze-mobile-middleware){:target="_blank"}.
Copy file name to clipboardExpand all lines: src/_data/actions/braze-web.yml
+23-23Lines changed: 23 additions & 23 deletions
Original file line number
Diff line number
Diff line change
@@ -5,19 +5,19 @@ settings:
5
5
description: Enable to allow Braze to log activity from crawlers.
6
6
default: "off"
7
7
- name: Allow User Supplied Javascript
8
-
description: Enable to indicate that you trust the Braze dashboard users to write non-malicious Javascript click actions, set this property to true.
8
+
description: Enable to indicate that you trust the Braze dashboard users to write non-malicious JavaScript click actions, set this property to true.
9
9
default: "off"
10
10
- name: API Key (required)
11
11
description: Enter the API Key to identify your application to Braze.
12
-
default:
12
+
default:
13
13
- name: App Version
14
14
description: Enter the version of the application to which user events will be associated for the purpose of segmentation.
15
-
default:
15
+
default:
16
16
- name: Content Security Nonce
17
17
description: "Enter a value that Braze will add to any `script` and `style` elements that the SDK creates."
18
-
default:
18
+
default:
19
19
- name: Disable Push Token Maintenance
20
-
description: Enable to allow users who have already granted web push permission will to their push token with the Braze backend automatically on new session to ensure deliverability.
20
+
description: Enable to allow users who have already granted web push permission will to their push token with the Braze backend automatically on new session to ensure deliverability.
21
21
default: "On"
22
22
- name: Do Not Load Font Awesome
23
23
description: Enable to prevent Braze from loading FontAwesome 4.7.0 from the FontAwesome CDN.
@@ -30,17 +30,17 @@ settings:
30
30
default: "off"
31
31
- name: SDK Endpoint (required)
32
32
description: Select the SDK Endpoint for your Braze applicaiton.
33
-
default:
33
+
default:
34
34
- name: In-App Message Z Index
35
35
description: Enter a z-index value for the Braze In-App Message. By default, the Braze SDK will show In-App Messages with a z-index of 1040 for the screen overlay, 1050 for the actual in-app message, and 1060 for the message's close button.
36
-
default:
36
+
default:
37
37
- name: Localization
38
38
description: Enter a ISO 639-1 Language Code to override the user's default browser language.
39
39
default: _specified by the user's browser_
40
40
- name: Manage Service Worker Externally
41
41
description: Enable to prevent Braze from registering and unregistering a service worker of which you control the lifecycle.
42
42
default: "off"
43
-
- name: Minimum Interval Between Trigger Actions in Seconds
43
+
- name: Minimum Interval Between Trigger Actions in Seconds
44
44
description: Enter a value to override the default interval between trigger actions.
45
45
default: 30
46
46
- name: No Cookies
@@ -75,7 +75,7 @@ config:
75
75
location: ""
76
76
notes: This setting is covered by the SDK Endpoint in Braze Web Mode (Actions) Connection Settings.
77
77
- name: Log Purchase when Revenue is present
78
-
connection_mode:
78
+
connection_mode:
79
79
- device-web
80
80
configurable: true
81
81
location:
@@ -90,7 +90,7 @@ config:
90
90
connection_mode:
91
91
- device-web
92
92
configurable: true
93
-
location:
93
+
location:
94
94
notes: This setting is available in the Braze Web Mode (Actions) Connection Settings.
95
95
- name: Braze Web SDK Version
96
96
connection_mode:
@@ -123,7 +123,7 @@ config:
123
123
connection_mode:
124
124
- device-web
125
125
configurable: true
126
-
location:
126
+
location:
127
127
notes: Available in the Braze Web Mode (Actions) Connection Settings.
128
128
- name: Open In-App Messages in New Tab
129
129
connection_mode:
@@ -137,13 +137,13 @@ config:
137
137
connection_mode:
138
138
- device-web
139
139
configurable: true
140
-
location:
140
+
location:
141
141
notes: Create a **Track Event** subscription and update the Event Trigger to specify `Event Type is Page` and `Event Property 'name' exists`. Update the Event Name field for the Track Event action to "Viewed Page {name}". Use the Event Variables selector to select the `name` variable.
142
142
- name: Track Only Named Pages
143
143
connection_mode:
144
144
- device-web
145
145
configurable: true
146
-
location:
146
+
location:
147
147
notes: Create a **Track Event** subscription and update the Event Trigger to specify `Event Type is Page` and. Update the Event Name field for the Track Event action to "Viewed Page {name}". Use the Event Variables selector to select the `name` variable.
148
148
- category: Other Settings
149
149
settings:
@@ -175,7 +175,7 @@ config:
175
175
connection_mode:
176
176
- device-web
177
177
configurable: true
178
-
location:
178
+
location:
179
179
notes: Available in the Braze Web Mode (Actions) Connection Settings.
180
180
- name: Service Worker Location
181
181
connection_mode:
@@ -187,7 +187,7 @@ config:
187
187
connection_mode:
188
188
- device-web
189
189
configurable: true
190
-
location:
190
+
location:
191
191
notes: Available in the Braze Web Mode (Actions) Connection Settings.
192
192
# - name: Update Existing Users Only
193
193
# connection_mode:
@@ -218,7 +218,7 @@ actions:
218
218
description: The object that contains properties pertaining to the event.
219
219
default: properties
220
220
- name: Update Existing Only
221
-
description: Set to true to use the Braze API in "Update Only" mode.
221
+
description: Set to true to use the Braze API in "Update Only" mode.
222
222
default: false
223
223
- action: Track Purchase
224
224
blurb: Track Purchase sends Braze a Track Purchase call when the destination recieves any event named `Order Completed`.
@@ -242,7 +242,7 @@ actions:
242
242
description: The object that contains properties pertaining to the event.
243
243
default: properties
244
244
- name: Update Existing Only
245
-
description: Set to true to use the Braze API in "Update Only" mode.
245
+
description: Set to true to use the Braze API in "Update Only" mode.
246
246
default: false
247
247
- action: Update User Profile
248
248
blurb: Update User Profile sends to Braze a request to update an existing user's profile attributes when the destination receives an Identify call.
@@ -276,10 +276,10 @@ actions:
276
276
default: traits.email
277
277
- name: Email Subscribe
278
278
description: "The user's email subscription preference. Must be one of: `opted_in`, `unsubscribed`, or `subscribed`"
279
-
default:
279
+
default:
280
280
- name: Email Open Tracking Disabled
281
281
description: Set to true to disable adding the open tracking pixel to all future emails sent to this user.
282
-
default:
282
+
default:
283
283
- name: Email Click Tracking Disabled
284
284
description: Set to true to disable click tracking for all links within future emails sent to this user.
285
285
default:
@@ -314,7 +314,7 @@ actions:
314
314
description: "The user's push subscription preference: `opted_in` (explicitly registered to receive push messages), `unsubscribed` (explicitly opted out of push messages), and `subscribed` (neither opted in nor out)."
315
315
default:
316
316
- name: Push Tokens
317
-
description: "An array of objects with app_id and token string. You can optionally provide a `device_id` for the device this token is associated with. For example,`{\"app_id\": App Identifier, \"token\": \"abcd\", \"device_id\": \"optional_field_value\"}. If a device_id is not provided, a random value is generated."
317
+
description: "An array of objects with app_id and token string. You can optionally provide a `device_id` for the device this token is associated with. For example,`{\"app_id\": App Identifier, \"token\": \"abcd\", \"device_id\": \"optional_field_value\"}. If a device_id is not provided, a random value is generated."
318
318
default:
319
319
- name: Time Zone
320
320
description: The user's time zone from the IANA Time Zone Database. For example, `America/New_York`.
@@ -326,10 +326,10 @@ actions:
326
326
description: A hash of custom attributes sent to Braze.
327
327
default: traits
328
328
- name: Update Existing Only
329
-
description: Set this flag to true to put the API in "Update Only" mode.
329
+
description: Set this flag to true to put the API in "Update Only" mode.
330
330
default: true
331
331
- action: Identify Debounce
332
332
blurb: >
333
-
When enabled for Javascript sources, this action ensure that only Identify calls where at least one updated trait value are sent to Braze. Events with duplicate traits are not sent.
333
+
When enabled for JavaScript sources, this action ensure that only Identify calls where at least one updated trait value are sent to Braze. Events with duplicate traits are not sent.
334
334
To use Identify Debounce with mobile sources, include Segment's open-source [Middleware tool](https://github.com/segmentio/segment-braze-mobile-middleware){:target="_blank"}.
0 commit comments