Skip to content

Commit 3281849

Browse files
author
markzegarelli
authored
Merge branch 'master' into regalvoice/doc_update_08_2021
2 parents 0417952 + e1e885b commit 3281849

File tree

36 files changed

+1349
-310
lines changed

36 files changed

+1349
-310
lines changed

‎.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,7 @@ yarn-error.log
1414
.vscode/spellright.dict
1515

1616
# Local Netlify folder
17-
.netlify
17+
.netlify
18+
19+
# VS COde stuff
20+
.vscode*

‎.vscode/yml.code-snippets

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
// Place your segment-docs workspace snippets here. Each snippet is defined under a snippet name and has a scope, prefix, body and
3+
// description. Add comma separated ids of the languages where the snippet is applicable in the scope field. If scope
4+
// is left empty or omitted, the snippet gets applied to all languages. The prefix is what is
5+
// used to trigger the snippet and the body will be expanded and inserted. Possible variables are:
6+
// $1, $2 for tab stops, $0 for the final cursor position, and ${1:label}, ${2:another} for placeholders.
7+
// Placeholders with the same ids are connected.
8+
// Example:
9+
// "Print to console": {
10+
// "scope": "javascript,typescript",
11+
// "prefix": "log",
12+
// "body": [
13+
// "console.log('$1');",
14+
// "$2"
15+
// ],
16+
// "description": "Log output to console"
17+
// }
18+
19+
"yml": {
20+
"prefix": ["- name"],
21+
"body":["- name: ${1:name}\r\tdescription: ${2:description}\r\tdefault: ${3}"],
22+
"description": "Yaml settings"
23+
}
24+
}

‎js/algolia/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import insightsClient from 'search-insights';
66

77

88
const appId = 'UINQ2M4D9S';
9-
const apiKey = '636b6d9e2dfb207e89ea7344859848f9';
9+
const apiKey = '3ecd0f228971adf2d5a4217789ae1765';
1010
const searchClient = algoliasearch(appId, apiKey);
1111

1212
//insights

‎js/expando/index.js

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
export default function() {
2+
3+
// map our commands to the classList methods
4+
const triggers = Array.from(document.querySelectorAll('[data-toggle="collapse"]'));
5+
6+
window.addEventListener('click', (ev) => {
7+
const elm = ev.target;
8+
if (triggers.includes(elm)) {
9+
const selector = elm.getAttribute('data-target');
10+
collapse(selector, 'toggle');
11+
}
12+
}, false);
13+
14+
15+
const fnmap = {
16+
'toggle': 'toggle',
17+
'show': 'add',
18+
'hide': 'remove'
19+
};
20+
const collapse = (selector, cmd) => {
21+
const targets = Array.from(document.querySelectorAll(selector));
22+
targets.forEach(target => {
23+
target.classList[fnmap[cmd]]('show');
24+
});
25+
}
26+
27+
28+
}

‎js/index.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ import searchBar from './search-bar'
2121
import glightbox from './glightbox'
2222
import autocomplete from './algolia'
2323
import mapTable from './map-table'
24+
import expando from './expando'
2425
feedback()
2526
accordion()
2627
accordionGroup()
@@ -42,4 +43,5 @@ sideMenu()
4243
tracking()
4344
searchBar()
4445
glightbox()
45-
mapTable()
46+
mapTable()
47+
expando()

‎src/_data/actions/braze-cloud.yml

Lines changed: 287 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,287 @@
1+
config:
2+
- category: Connection Settings
3+
settings:
4+
- name: App Identifier
5+
connection_mode:
6+
- cloud
7+
- device-web
8+
configurable: false
9+
location:
10+
notes: This setting is not necessary in Braze Web Mode (Actions).
11+
- name: REST API Key
12+
connection_mode:
13+
- cloud
14+
configurable: true
15+
location:
16+
notes: This setting is renamed API Key, and is available during initial configuration, or on the Settings tab after configuration.
17+
- name: Custom API Endpoint
18+
connection_mode:
19+
- device-web
20+
configurable: false
21+
location:
22+
notes: This setting is not needed in Braze Web Mode (Actions).
23+
- name: Appboy Datacenter
24+
connection_mode:
25+
- cloud
26+
configurable: false
27+
location: ""
28+
notes: This setting is covered by the REST API Endpoint
29+
- name: Log Purchase when Revenue is present
30+
connection_mode:
31+
- device-web
32+
configurable: true
33+
location:
34+
notes: Modify the Trigger for the Track Purchase action to recreate this behavior in Braze (Actions). By default, events named "Order Completed" trigger this action, but you can update the Trigger to check for a property named `revenue`. The event must have a `products` array with `product_id` and `price`.
35+
- name: Custom REST API Endpoint
36+
connection_mode:
37+
- cloud
38+
configurable: true
39+
location:
40+
notes: Select from the available REST Endpoints during initial configuration, or on the Destination's Settings tab.
41+
- name: Safari Website Push ID
42+
connection_mode:
43+
- device-web
44+
configurable: false
45+
location: Available as a setting in Braze Web Mode (Actions)
46+
notes:
47+
- name: Braze Web SDK Version
48+
connection_mode:
49+
- device-web
50+
configurable: false
51+
location: ""
52+
notes: Hardcoded to version \#.##
53+
- name: Connection Mode
54+
connection_mode:
55+
- cloud
56+
- device-web
57+
configurable: yes
58+
location: Choose the version of the Braze (Actions) destination that matches your connection mode.
59+
notes: ""
60+
- category: In-App Messaging
61+
settings:
62+
- name: Enable Automatic In-App Message Registration
63+
connection_mode:
64+
- device-web
65+
configurable: false
66+
location: ""
67+
notes: Unsupported, available only on Mobile.
68+
- name: Automatically send In-App Messages
69+
connection_mode:
70+
- device-web
71+
configurable: false
72+
location: Available as a setting in Braze Web Mode (Actions)
73+
notes: ""
74+
- name: Do Not Load Font Awesome
75+
connection_mode:
76+
- device-web
77+
configurable: false
78+
location: Available as a setting in Braze Web Mode (Actions)
79+
notes: ""
80+
- name: Enable HTML In-App Messages
81+
connection_mode:
82+
- device-web
83+
configurable: false
84+
location: Available as a setting in Braze Web Mode (Actions)
85+
notes: ""
86+
- name: Open In-App Messages in New Tab
87+
connection_mode:
88+
- device-web
89+
configurable: false
90+
location: Available as a setting in Braze Web Mode (Actions)
91+
notes: ""
92+
- category: Page
93+
settings:
94+
- name: Track All Pages
95+
connection_mode:
96+
- device-web
97+
configurable: true
98+
location: Track Custom Event action
99+
notes: Trigger the action on Page calls.
100+
- name: Track Only Named Pages
101+
connection_mode:
102+
- device-web
103+
configurable: true
104+
location: Track Custom Event action
105+
notes: Trigger the action on Page calls where the `name` property exists.
106+
- category: Other Settings
107+
settings:
108+
- name: Allow Crawler Activity
109+
connection_mode:
110+
- device-web
111+
configurable: false
112+
location: Available as a setting in Braze Web Mode (Actions)
113+
notes: ""
114+
- name: Enable Logging
115+
connection_mode:
116+
- device-web
117+
configurable: false
118+
location: Available as a setting in Braze Web Mode (Actions)
119+
notes: ""
120+
- name: Minimum Interval Between Trigger Actions in Seconds
121+
connection_mode:
122+
- device-web
123+
configurable: false
124+
location: Available as a setting in Braze Web Mode (Actions)
125+
notes: ""
126+
- name: Only Track Known Users
127+
connection_mode:
128+
- device-web
129+
configurable: false
130+
location: Available as a setting in Braze Web Mode (Actions)
131+
notes: ""
132+
- name: Open News Feed Cards in New Tab
133+
connection_mode:
134+
- device-web
135+
configurable: false
136+
location: Available as a setting in Braze Web Mode (Actions)
137+
notes: ""
138+
- name: Session Timeout in Seconds
139+
connection_mode:
140+
- device-web
141+
configurable: false
142+
location: Available as a setting in Braze Web Mode (Actions)
143+
notes: ""
144+
# - name: Update Existing Users Only
145+
# connection_mode:
146+
# - cloud
147+
# configurable: true
148+
# location: ""
149+
# notes: ""
150+
actions:
151+
- action: Track Event
152+
blurb: Track Event sends Braze a Track Event call when the destination receives a Track event that **is not** named `Order Completed`.
153+
fields:
154+
- name: Event Name
155+
description: The name of the event that Braze receives.
156+
default: event
157+
- name: Time
158+
description: The timestamp of when the event occured.
159+
default: receivedAt
160+
- name: External User ID
161+
description: The unique identifier of the user who performed the event.
162+
default: userId
163+
- name: User Alias Object
164+
description: The user alias object. For more information, see the <a href="https://www.braze.com/docs/api/objects_filters/user_alias_object/" target="_blank">Braze documentation</a>.
165+
default:
166+
- name: Braze User Identifier
167+
description: The unique identifier of the user that is passed to Braze.
168+
default: properties.braze_id
169+
- name: Event Properties
170+
description: The object that contains properties pertaining to the event.
171+
default: properties
172+
- name: Update Existing Only
173+
description: Set to true to use the Braze API in "Update Only" mode.
174+
default: false
175+
- action: Track Purchase
176+
blurb: Track Purchase sends Braze a Track Purchase call when the destination recieves any event that matches the specified name.
177+
fields:
178+
- name: Time
179+
description: The timestamp of when the event occured.
180+
default: receivedAt
181+
- name: Products
182+
description: A list of the products included in the order.
183+
default: properties.products
184+
- name: External User ID
185+
description: The unique identifier of the user who performed the event.
186+
default: userId
187+
- name: User Alias Object
188+
description: The user alias object. For more information, see the <a href="https://www.braze.com/docs/api/objects_filters/user_alias_object/" target="_blank">Braze documentation</a>.
189+
default:
190+
- name: Braze User Identifier
191+
description: The unique identifier of the user that is passed to Braze.
192+
default: properties.braze_id
193+
- name: Event Properties
194+
description: The object that contains properties pertaining to the event.
195+
default: properties
196+
- name: Update Existing Only
197+
description: Set to true to use the Braze API in "Update Only" mode.
198+
default: false
199+
- action: Update User Profile
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.
201+
fields:
202+
- name: External User ID
203+
description: The unique identifier of the user who performed the event.
204+
default: userId
205+
- name: User Alias Object
206+
description: The user alias object. For more information, see the <a href="https://www.braze.com/docs/api/objects_filters/user_alias_object/" target="_blank">Braze documentation</a>.
207+
default:
208+
- name: Braze User Identifier
209+
description: The unique identifier of the user that is passed to Braze.
210+
default: properties.braze_id
211+
- name: Country
212+
description: The user's country code.
213+
default: context.location.country
214+
- name: Current Location
215+
description: The user's lattitude and longitude when they complete the event.
216+
default: \{"latitude":{"@path":"$.context.location.latitude"},"longitude":{"@path":"$.context.location.longitude"}}
217+
- name: Date of First Session
218+
description: The date on which the user first used the application.
219+
default:
220+
- name: Date of Last Session
221+
description: The date on which the user most recently used the application.
222+
default:
223+
- name: Date of Birth
224+
description: The user's date of birth.
225+
default:
226+
- name: Email
227+
description: The user's email address.
228+
default: traits.email
229+
- name: Email Subscribe
230+
description: "The user's email subscription preference. Must be one of: `opted_in`, `unsubscribed`, or `subscribed`"
231+
default:
232+
- name: Email Open Tracking Disabled
233+
description: Set to true to disable adding the open tracking pixel to all future emails sent to this user.
234+
default:
235+
- name: Email Click Tracking Disabled
236+
description: Set to true to disable click tracking for all links within future emails sent to this user.
237+
default:
238+
- name: Facebook Attribution Data
239+
description: "A hash of Facebook attribution data that contains any of `id`, `likes`, or `num_friends`"
240+
default:
241+
- name: First Name
242+
description: The user's first name
243+
default: traits.firstName
244+
- name: Gender
245+
description: "The user's gender: `M`, `F`, `O` (other), `N` (not applicable), `P` (prefer not to say), or nil (unknown)."
246+
default: traits.gender
247+
- name: Home City
248+
description: The user's home city.
249+
default: traits.address.city
250+
- name: Image URL
251+
description: The URL of the image associated with this user profile.
252+
default: traits.avatar
253+
- name: Language
254+
description: The user's preferred language.
255+
default:
256+
- name: Last Name
257+
description: The user's last name.
258+
default: traits.lastName
259+
- name: Marked Email as Spam At
260+
description: The date on which the user marked their email as spam.
261+
default:
262+
- name: Phone Number
263+
description: The user's phone number.
264+
default: traits.phone
265+
- name: Push Subscribe
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+
default:
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."
270+
default:
271+
- name: Time Zone
272+
description: The user's time zone from the IANA Time Zone Database. For example, `America/New_York`.
273+
default:
274+
- name: Twitter Attribution Data
275+
description: A Hash that contains any of id, screen_name, followers_count, friends_count, and statuses_count.
276+
default:
277+
- name: Custom Attributes
278+
description: A hash of custom attributes sent to Braze.
279+
default: traits
280+
- name: Update Existing Only
281+
description: Set this flag to true to put the API in "Update Only" mode.
282+
default: true
283+
- action: Identify Debounce
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.
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"}.
287+
fields:

0 commit comments

Comments
 (0)