Skip to content

Commit d0379f0

Browse files
committed
Updates telemetry docs
1 parent 36976b3 commit d0379f0

File tree

1 file changed

+43
-29
lines changed

1 file changed

+43
-29
lines changed

docs/telemetry-events.md

Lines changed: 43 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -898,6 +898,14 @@ or
898898
}
899899
```
900900

901+
### home/createBranch
902+
903+
> Sent when the user chooses to create a branch from the home view
904+
905+
```typescript
906+
void
907+
```
908+
901909
### home/preview/toggled
902910

903911
> Sent when the new Home view preview is toggled on/off
@@ -936,6 +944,14 @@ or
936944
}
937945
```
938946

947+
### home/startWork
948+
949+
> Sent when the user chooses to start work on an issue from the home view
950+
951+
```typescript
952+
void
953+
```
954+
939955
### launchpad/action
940956

941957
> Sent when the user takes an action on a launchpad item
@@ -1525,6 +1541,19 @@ void
15251541
}
15261542
```
15271543

1544+
### startWork/action
1545+
1546+
> Sent when the user chooses to manage integrations
1547+
1548+
```typescript
1549+
{
1550+
'action': 'connect' | 'manage',
1551+
'connected': boolean,
1552+
'instance': number,
1553+
'items.count': number
1554+
}
1555+
```
1556+
15281557
### startWork/issue/action
15291558

15301559
> Sent when the user takes an action on a StartWork issue
@@ -1535,8 +1564,7 @@ void
15351564
'connected': boolean,
15361565
'instance': number,
15371566
[`item.${string}`]: string | number | boolean,
1538-
'items.count': number,
1539-
'type': 'branch' | 'issue'
1567+
'items.count': number
15401568
}
15411569
```
15421570

@@ -1549,8 +1577,7 @@ void
15491577
'connected': boolean,
15501578
'instance': number,
15511579
[`item.${string}`]: string | number | boolean,
1552-
'items.count': number,
1553-
'type': 'branch' | 'issue'
1580+
'items.count': number
15541581
}
15551582
```
15561583

@@ -1560,8 +1587,7 @@ void
15601587
15611588
```typescript
15621589
{
1563-
'instance': number,
1564-
'type': 'branch' | 'issue'
1590+
'instance': number
15651591
}
15661592
```
15671593

@@ -1573,56 +1599,44 @@ void
15731599
{
15741600
'connected': boolean,
15751601
'instance': number,
1576-
'items.count': number,
1577-
'type': 'branch' | 'issue'
1602+
'items.count': number
15781603
}
15791604
```
15801605

15811606
### startWork/steps/connect
15821607

1583-
```typescript
1584-
{
1585-
'connected': boolean,
1586-
'instance': number,
1587-
'items.count': number,
1588-
'type': 'branch' | 'issue'
1589-
}
1590-
```
1591-
1592-
### startWork/steps/issue
1608+
> Sent when the user reaches the "connect an integration" step of Start Work
15931609
15941610
```typescript
15951611
{
15961612
'connected': boolean,
15971613
'instance': number,
1598-
'items.count': number,
1599-
'type': 'branch' | 'issue'
1614+
'items.count': number
16001615
}
16011616
```
16021617

1603-
### startWork/steps/type
1618+
### startWork/steps/issue
16041619

1605-
> Sent when the Start Work has "reloaded" (while open, e.g. user refreshed or back button) and is disconnected; use `instance` to correlate a Start Work "session"
1620+
> Sent when the user reaches the "choose an issue" step of Start Work
16061621
16071622
```typescript
16081623
{
16091624
'connected': boolean,
16101625
'instance': number,
1611-
'items.count': number,
1612-
'type': 'branch' | 'issue'
1626+
'items.count': number
16131627
}
16141628
```
16151629

1616-
### startWork/type/chosen
1630+
### startWork/title/action
16171631

1618-
> Sent when the user chooses an option to start work in the first step
1632+
> Sent when the user chooses to connect an integration
16191633
16201634
```typescript
16211635
{
1636+
'action': 'connect',
16221637
'connected': boolean,
16231638
'instance': number,
1624-
'items.count': number,
1625-
'type': 'branch' | 'issue'
1639+
'items.count': number
16261640
}
16271641
```
16281642

@@ -1669,7 +1683,7 @@ void
16691683
16701684
```typescript
16711685
{
1672-
'action': 'sign-up' | 'sign-in' | 'sign-out' | 'manage' | 'reactivate' | 'resend-verification' | 'pricing' | 'start-preview-trial' | 'upgrade'
1686+
'action': 'manage' | 'sign-up' | 'sign-in' | 'sign-out' | 'reactivate' | 'resend-verification' | 'pricing' | 'start-preview-trial' | 'upgrade'
16731687
}
16741688
```
16751689

0 commit comments

Comments
 (0)