Skip to content

Commit 30e58f6

Browse files
brandongregoryscottbrandongregoryscott
committed
Update descriptions for context.groupId field, fix formatting in some JSON examples
1 parent 0eb261a commit 30e58f6

File tree

1 file changed

+72
-69
lines changed

1 file changed

+72
-69
lines changed

‎src/connections/spec/b2b-saas.md

Lines changed: 72 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,8 @@ This event supports the following semantic properties:
6363
"account_name": "Initech"
6464
},
6565
"context": {
66-
"groupId": "acct_123"
67-
}
66+
"groupId": "acct_123"
67+
}
6868
}
6969
```
7070

@@ -91,8 +91,8 @@ This event supports the following semantic properties:
9191
"account_name": "Initech"
9292
},
9393
"context": {
94-
"groupId": "acct_123"
95-
}
94+
"groupId": "acct_123"
95+
}
9696
}'}}} {% endcomment %}
9797

9898
```js
@@ -104,8 +104,8 @@ This event supports the following semantic properties:
104104
"account_name": "Initech"
105105
},
106106
"context": {
107-
"groupId": "acct_123"
108-
}
107+
"groupId": "acct_123"
108+
}
109109
}
110110
```
111111

@@ -147,8 +147,8 @@ This event supports the following semantic properties:
147147
"title": "Mr"
148148
},
149149
"context": {
150-
"groupId": "acct_123"
151-
}
150+
"groupId": "acct_123"
151+
}
152152
}'}}} {% endcomment %}
153153

154154
```json
@@ -166,8 +166,8 @@ This event supports the following semantic properties:
166166
"title": "Mr"
167167
},
168168
"context": {
169-
"groupId": "acct_123"
170-
}
169+
"groupId": "acct_123"
170+
}
171171
}
172172
```
173173

@@ -182,10 +182,11 @@ This event should be sent when a user signs in to your service.
182182

183183
This event supports the following semantic properties:
184184

185-
| Property | Type | Description |
186-
| -------- | ---- | -----------
187-
| `username` | String | The username of the user logging in. |
188-
| `context.groupId` | String | The id of the account being created. |
185+
| Property | Type | Description |
186+
| ----------------- | ------ | ---------------------------------------------------------- |
187+
| `username` | String | The username of the user signing in. |
188+
| `context.groupId` | String | The id of the account associated with the user signing in. |
189+
189190

190191
#### Example
191192

@@ -197,8 +198,8 @@ This event supports the following semantic properties:
197198
"username": "pgibbons"
198199
},
199200
"context": {
200-
"groupId": "acct_123"
201-
}
201+
"groupId": "acct_123"
202+
}
202203
}'}}} {% endcomment %}
203204

204205
```json
@@ -210,8 +211,8 @@ This event supports the following semantic properties:
210211
"username": "pgibbons"
211212
},
212213
"context": {
213-
"groupId": "acct_123"
214-
}
214+
"groupId": "acct_123"
215+
}
215216
}
216217
```
217218

@@ -226,10 +227,10 @@ This event should be sent when a user signs out for your service. You should als
226227

227228
This event supports the following semantic properties:
228229

229-
| Property | Type | Description |
230-
| ----------------- | ------ | ------------------------------------ |
231-
| `username` | String | The username of the user logging in. |
232-
| `context.groupId` | String | The id of the account being created. |
230+
| Property | Type | Description |
231+
| ----------------- | ------ | ----------------------------------------------------------- |
232+
| `username` | String | The username of the user signing out. |
233+
| `context.groupId` | String | The id of the account associated with the user signing out. |
233234

234235
#### Example
235236

@@ -241,8 +242,8 @@ This event supports the following semantic properties:
241242
"username": "pgibbons"
242243
},
243244
"context": {
244-
"groupId": "acct_123"
245-
}
245+
"groupId": "acct_123"
246+
}
246247
}'}}} {% endcomment %}
247248

248249
```js
@@ -254,8 +255,8 @@ This event supports the following semantic properties:
254255
"username": "pgibbons"
255256
},
256257
"context": {
257-
"groupId": "acct_123"
258-
}
258+
"groupId": "acct_123"
259+
}
259260
}
260261
```
261262

@@ -273,6 +274,7 @@ This event supports the following semantic properties:
273274
| `invitee_first_name` | String | The first name of the person receiving the invite. |
274275
| `invitee_last_name` | String | The last name of the person receiving the invite. |
275276
| `invitee_role` | String | The permission group for the person receiving the invite. |
277+
| `context.groupId` | String | The id of the account the person is being invited to. |
276278

277279
#### Example
278280

@@ -287,8 +289,8 @@ This event supports the following semantic properties:
287289
"invitee_role": "Owner"
288290
},
289291
"context": {
290-
"groupId": "acct_123"
291-
}
292+
"groupId": "acct_123"
293+
}
292294
}'}}} {% endcomment %}
293295

294296
```js
@@ -303,8 +305,8 @@ This event supports the following semantic properties:
303305
"invitee_role": "Owner"
304306
},
305307
"context": {
306-
"groupId": "acct_123"
307-
}
308+
"groupId": "acct_123"
309+
}
308310
}
309311
```
310312

@@ -319,7 +321,7 @@ This event supports the following semantic properties:
319321
| Property | Type | Description |
320322
| ----------------- | ------ | --------------------------------------------------- |
321323
| `role` | String | The permission group for this user in this account. |
322-
| `context.groupId` | String | The id of the account being created. |
324+
| `context.groupId` | String | The id of the account the user is being added to. |
323325

324326
#### Example
325327

@@ -331,8 +333,8 @@ This event supports the following semantic properties:
331333
"role": "Owner"
332334
},
333335
"context": {
334-
"groupId": "acct_123"
335-
}
336+
"groupId": "acct_123"
337+
}
336338
}'}}} {% endcomment %}
337339

338340
```js
@@ -344,8 +346,8 @@ This event supports the following semantic properties:
344346
"role": "Owner"
345347
},
346348
"context": {
347-
"groupId": "acct_123"
348-
}
349+
"groupId": "acct_123"
350+
}
349351
}
350352
```
351353

@@ -357,9 +359,9 @@ This event should be sent when a user is removed from a group or account.
357359

358360
This event supports the following semantic properties:
359361

360-
| Property | Type | Description |
361-
| -------- | ---- | ----------- |
362-
| `context.groupId` | String | The id of the account being created. |
362+
| Property | Type | Description |
363+
| ----------------- | ------ | ----------------------------------------------------- |
364+
| `context.groupId` | String | The id of the account the user is being removed from. |
363365

364366
#### Example
365367

@@ -369,8 +371,8 @@ This event supports the following semantic properties:
369371
"event": "Account Removed User",
370372
"properties": {},
371373
"context": {
372-
"groupId": "acct_123"
373-
}
374+
"groupId": "acct_123"
375+
}
374376
}'}}} {% endcomment %}
375377

376378
```js
@@ -380,8 +382,8 @@ This event supports the following semantic properties:
380382
"event": "Account Removed User",
381383
"properties": {},
382384
"context": {
383-
"groupId": "acct_123"
384-
}
385+
"groupId": "acct_123"
386+
}
385387
}
386388
```
387389

@@ -398,7 +400,7 @@ This event supports the following semantic properties:
398400
| `trial_start_date` | Date | The date when the trial starts. It is an ISO-8601 date string. |
399401
| `trial_end_date` | Date | The date when the trial ends. It is an ISO-8601 date string. |
400402
| `trial_plan_name` | String | The name of the plan being trialed. |
401-
| `context.groupId` | String | The id of the account being created. |
403+
| `context.groupId` | String | The id of the account the trial is associated with. |
402404

403405
#### Example
404406

@@ -407,13 +409,13 @@ This event supports the following semantic properties:
407409
"type": "track",
408410
"event": "Trial Started",
409411
"properties": {
410-
"trial_start_date": "2018-08-28T04:09:47Z",
411-
"trial_end_date": "2018-09-20T04:09:47Z",
412-
"trial_plan_name": "Business"
412+
"trial_start_date": "2018-08-28T04:09:47Z",
413+
"trial_end_date": "2018-09-20T04:09:47Z",
414+
"trial_plan_name": "Business"
413415
},
414416
"context": {
415-
"groupId": "acct_123"
416-
}
417+
"groupId": "acct_123"
418+
}
417419
}'}}} {% endcomment %}
418420

419421
```js
@@ -422,13 +424,13 @@ This event supports the following semantic properties:
422424
"type": "track",
423425
"event": "Trial Started",
424426
"properties": {
425-
"trial_start_date": "2018-08-28T04:09:47Z",
426-
"trial_end_date": "2018-09-20T04:09:47Z",
427-
"trial_plan_name": "Business"
427+
"trial_start_date": "2018-08-28T04:09:47Z",
428+
"trial_end_date": "2018-09-20T04:09:47Z",
429+
"trial_plan_name": "Business"
428430
},
429431
"context": {
430-
"groupId": "acct_123"
431-
}
432+
"groupId": "acct_123"
433+
}
432434
}
433435
```
434436

@@ -440,12 +442,13 @@ This event should be sent when a trial ends.
440442

441443
This event supports the following semantic properties:
442444

443-
| Property | Type | Description |
444-
| -------- | ---- | ----------- |
445-
| `trial_start_date` | Date | The date when the trial starts. It is an ISO-8601 date string. |
446-
| `trial_end_date` | Date | The date when the trial ends. It is an ISO-8601 date string. |
447-
| `trial_plan_name` | String | The name of the plan being trialed. |
448-
| `context.groupId` | String | The id of the account being created. |
445+
| Property | Type | Description |
446+
| ------------------ | ------ | -------------------------------------------------------------- |
447+
| `trial_start_date` | Date | The date when the trial starts. It is an ISO-8601 date string. |
448+
| `trial_end_date` | Date | The date when the trial ends. It is an ISO-8601 date string. |
449+
| `trial_plan_name` | String | The name of the plan being trialed. |
450+
| `context.groupId` | String | The id of the account the trial is associated with. |
451+
449452

450453
#### Example
451454

@@ -454,13 +457,13 @@ This event supports the following semantic properties:
454457
"type": "track",
455458
"event": "Trial Ended",
456459
"properties": {
457-
"trial_start_date": "2018-08-28T04:09:47Z",
458-
"trial_end_date": "2018-09-20T04:09:47Z",
459-
"trial_plan_name": "Business"
460+
"trial_start_date": "2018-08-28T04:09:47Z",
461+
"trial_end_date": "2018-09-20T04:09:47Z",
462+
"trial_plan_name": "Business"
460463
},
461464
"context": {
462-
"groupId": "acct_123"
463-
}
465+
"groupId": "acct_123"
466+
}
464467
}'}}} {% endcomment %}
465468

466469
```js
@@ -469,12 +472,12 @@ This event supports the following semantic properties:
469472
"type": "track",
470473
"event": "Trial Ended",
471474
"properties": {
472-
"trial_start_date": "2018-08-28T04:09:47Z",
473-
"trial_end_date": "2018-09-20T04:09:47Z",
474-
"trial_plan_name": "Business"
475+
"trial_start_date": "2018-08-28T04:09:47Z",
476+
"trial_end_date": "2018-09-20T04:09:47Z",
477+
"trial_plan_name": "Business"
475478
},
476479
"context": {
477-
"groupId": "acct_123"
478-
}
480+
"groupId": "acct_123"
481+
}
479482
}
480483
```

0 commit comments

Comments
 (0)