Skip to content

Commit d5096b9

Browse files
authored
Merge pull request #1400 from segmentio/bucket-documentation
Bucket documentation
2 parents 6265d98 + 15b7d3b commit d5096b9

File tree

5 files changed

+123
-134
lines changed

5 files changed

+123
-134
lines changed

src/_data/catalog/destination_categories.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PLATFORM API. DO NOT EDIT
2-
# destination categories last updated 2021-02-02
2+
# destination categories last updated 2021-02-05
33
items:
44
- display_name: Email Marketing
55
slug: email-marketing

src/_data/catalog/destinations.yml

Lines changed: 67 additions & 131 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PLATFORM API. DO NOT EDIT
2-
# destination data last updated 2021-02-02
2+
# destination data last updated 2021-02-05
33
items:
44
- display_name: ActiveCampaign
55
slug: activecampaign
@@ -3852,6 +3852,57 @@ items:
38523852
server: false
38533853
previous_names:
38543854
- Bronto
3855+
- display_name: Bucket
3856+
slug: bucket
3857+
name: catalog/destinations/bucket
3858+
description: Feature analytics
3859+
hidden: false
3860+
url: connections/destinations/catalog/bucket
3861+
status: PUBLIC_BETA
3862+
logo:
3863+
url: >-
3864+
https://public-segment-devcenter-production.s3.amazonaws.com/38de1154-e733-4aae-a53e-c1c4379e80ee.svg
3865+
mark:
3866+
url: >-
3867+
https://public-segment-devcenter-production.s3.amazonaws.com/85ce41ab-9262-469c-bb6a-d76c21717f8b.svg
3868+
categories:
3869+
- Analytics
3870+
components: []
3871+
platforms:
3872+
browser: true
3873+
server: true
3874+
mobile: true
3875+
browserUnbundlingSupported: false
3876+
browserUnbundlingPublic: false
3877+
methods:
3878+
alias: false
3879+
group: true
3880+
identify: true
3881+
page_view: false
3882+
track: true
3883+
settings:
3884+
- name: apiKey
3885+
display_name: API Key
3886+
type: STRING
3887+
deprecated: false
3888+
required: true
3889+
string_validators:
3890+
regexp: '^.{8,}$'
3891+
description: >-
3892+
The API key is your App ID. Find it under Settings (cog wheel) when logged
3893+
in.
3894+
settings: []
3895+
connection_modes:
3896+
device:
3897+
web: false
3898+
mobile: false
3899+
server: false
3900+
cloud:
3901+
web: false
3902+
mobile: false
3903+
server: false
3904+
previous_names:
3905+
- Bucket
38553906
- display_name: BugHerd
38563907
slug: bugherd
38573908
name: catalog/destinations/bugherd
@@ -4089,7 +4140,9 @@ items:
40894140
required: true
40904141
string_validators:
40914142
regexp: '^.{8,}$'
4092-
description: You can find your API in the Calixa Account page.
4143+
description: >-
4144+
If you installed via OAuth do not change this API Key. If you need help,
4145+
please contact [email protected]
40934146
settings: []
40944147
connection_modes:
40954148
device:
@@ -10862,123 +10915,6 @@ items:
1086210915
previous_names:
1086310916
- IbmUbx
1086410917
- IBM UBX
10865-
- display_name: Impact
10866-
slug: impact
10867-
name: catalog/destinations/impact-radius
10868-
description: >-
10869-
Impact provides a SaaS based digital marketing platform that enables digital
10870-
brands and agencies to maximize the return of ad spend across digital,
10871-
mobile, and offline channels.
10872-
hidden: true
10873-
url: connections/destinations/catalog/impact
10874-
status: PUBLIC_BETA
10875-
logo:
10876-
url: 'https://cdn.filepicker.io/api/file/1avybzL4Qme1ov9WNd89'
10877-
mark:
10878-
url: 'https://cdn.filepicker.io/api/file/jWF3kw6BSBiYKMvG9dTf'
10879-
categories:
10880-
- Attribution
10881-
- Referrals
10882-
components:
10883-
- type: CLOUD
10884-
platforms:
10885-
browser: false
10886-
server: true
10887-
mobile: true
10888-
browserUnbundlingSupported: true
10889-
browserUnbundlingPublic: false
10890-
methods:
10891-
alias: false
10892-
group: false
10893-
identify: true
10894-
page_view: true
10895-
track: true
10896-
settings:
10897-
- name: accountSid
10898-
display_name: Account SID
10899-
type: STRING
10900-
deprecated: false
10901-
required: true
10902-
string_validators:
10903-
regexp: ''
10904-
description: >-
10905-
Your Impact Account SID. This can be found by clicking on the gear icon in
10906-
your Impact dashboard and selecting API Access. Please contact your Impact
10907-
support team if your are having issues finding this.
10908-
settings: []
10909-
- name: actionTrackers
10910-
display_name: Action Trackers
10911-
type: MAP
10912-
deprecated: false
10913-
required: false
10914-
description: >-
10915-
This setting is used to map your Segment event names to Impact **Action
10916-
Trackers**. Please enter the name(s) of the Segment `track` events you
10917-
would like to use on the left and the Action Tracker Id's they should
10918-
integrate with on the right. Please reference our documentation for more
10919-
info.
10920-
settings: []
10921-
- name: authorizationToken
10922-
display_name: Authorization Token
10923-
type: STRING
10924-
deprecated: false
10925-
required: true
10926-
string_validators:
10927-
regexp: ''
10928-
description: >-
10929-
Your Impact Authorization Token. This can be found by clicking on the gear
10930-
icon in your Impact dashboard and selecting API Access (it will be labeled
10931-
**Auth Token**). Please contact your Impact support team if your are
10932-
having issues finding this.
10933-
settings: []
10934-
- name: campaignId
10935-
display_name: Campaign ID
10936-
type: NUMBER
10937-
deprecated: false
10938-
required: true
10939-
number_validators:
10940-
min: 1
10941-
max: 0
10942-
description: >-
10943-
Each Segment data source needs to be associated with an Impact Campaign
10944-
ID. This ID can be found in the top right corner of your Impact dashboard.
10945-
It is the number next to the name of your Impact project.
10946-
settings: []
10947-
- name: mobileEvents
10948-
display_name: Mobile Events
10949-
type: MIXED
10950-
deprecated: false
10951-
required: false
10952-
description: >-
10953-
This setting is used to map your Segment events to your Mobile App Events
10954-
in Impact. Each mapping consists of the Segment event name and the
10955-
corresponding App ID and Event Code you would like to map it to. Please
10956-
reference our documentation for more info.
10957-
settings: []
10958-
- name: trackingDomain
10959-
display_name: Tracking Domain
10960-
type: STRING
10961-
deprecated: false
10962-
required: true
10963-
string_validators:
10964-
regexp: ''
10965-
description: >-
10966-
Your Impact tracking domain is used to properly attribute conversion
10967-
events. To find yours, from your Impact dashboard click on Tracking
10968-
Settings > General. It should look like `projectname.sjv.io`.
10969-
settings: []
10970-
connection_modes:
10971-
device:
10972-
web: false
10973-
mobile: false
10974-
server: false
10975-
cloud:
10976-
web: false
10977-
mobile: true
10978-
server: true
10979-
previous_names:
10980-
- Impact Radius
10981-
- Impact
1098210918
- display_name: Improvely
1098310919
slug: improvely
1098410920
name: catalog/destinations/improvely
@@ -13060,7 +12996,7 @@ items:
1306012996
deprecated: false
1306112997
required: true
1306212998
string_validators:
13063-
regexp: ^\d+$
12999+
regexp: ''
1306413000
description: 'Your CID should be a series of numbers, like `9289`.'
1306513001
settings: []
1306613002
- name: blockload
@@ -13504,17 +13440,6 @@ items:
1350413440
required: false
1350513441
description: Map your Segment properties to the Marketo Activity Fields
1350613442
settings:
13507-
- name: segmentProperty
13508-
display_name: Segment Property Name
13509-
type: STRING
13510-
deprecated: false
13511-
required: true
13512-
string_validators:
13513-
regexp: ''
13514-
description: >-
13515-
Enter the Segment Property Name. This is case sensitive so make sure
13516-
the name matches exactly how you are passing it in your .track() call.
13517-
settings: []
1351813443
- name: marketoAttributeName
1351913444
display_name: Marketo Field Name
1352013445
type: STRING
@@ -13546,6 +13471,17 @@ items:
1354613471
required: false
1354713472
description: Mark this property as the Primary field in Marketo.
1354813473
settings: []
13474+
- name: segmentProperty
13475+
display_name: Segment Property Name
13476+
type: STRING
13477+
deprecated: false
13478+
required: true
13479+
string_validators:
13480+
regexp: ''
13481+
description: >-
13482+
Enter the Segment Property Name. This is case sensitive so make sure
13483+
the name matches exactly how you are passing it in your .track() call.
13484+
settings: []
1354913485
- name: event
1355013486
display_name: Segment Event Name
1355113487
type: STRING

src/_data/catalog/source_categories.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PLATFORM API. DO NOT EDIT
2-
# source cateogries last updated 2021-02-02
2+
# source cateogries last updated 2021-02-05
33
items:
44
- display_name: Server
55
slug: server

src/_data/catalog/sources.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PLATFORM API. DO NOT EDIT
2-
# sources last updated 2021-02-02
2+
# sources last updated 2021-02-05
33
items:
44
- display_name: .NET
55
slug: net
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: Bucket Destination
3+
rewrite: true
4+
---
5+
[Bucket](https://bucket.so/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) features analytics for SaaS companies.
6+
7+
This destination is maintained by Bucket. For any issues with the destination, [contact the Bucket Support team](mailto:[email protected]).
8+
9+
## Getting Started
10+
11+
{% include content/connection-modes.md %}
12+
13+
1. From the Destinations catalog page in the Segment App, click **Add Destination**.
14+
2. Search for "Bucket" in the Destinations Catalog, and select the Bucket destination.
15+
3. Choose which Source should send data to the Bucket destination.
16+
4. Go to [Bucket's Settings](https://bucket.so) and find and copy the "App ID".
17+
5. Enter the App ID as "API Key" in the "Bucket" destination settings in Segment.
18+
19+
## Identify
20+
21+
If you aren't familiar with the Segment Spec, take a look at the [Identify method documentation](https://segment.com/docs/connections/spec/identify/) to learn about what it does. An example call would look like:
22+
23+
```js
24+
analytics.identify('userId123', {
25+
name: 'John Doe',
26+
27+
});
28+
```
29+
30+
Segment sends Identify calls to Bucket as an `identify` event which updates User profiles.
31+
32+
## Group
33+
34+
If you aren't familiar with the Segment Spec, take a look at the [Group method documentation](https://segment.com/docs/connections/spec/group/) to learn about what it does. An example call would look like:
35+
36+
```js
37+
analytics.identify('groupId123', {
38+
name: 'Acme, Inc',
39+
});
40+
```
41+
42+
Segment sends Group calls to Bucket as a `group` event which updates Company profiles.
43+
44+
## Track
45+
46+
If you aren't familiar with the Segment Spec, take a look at the [Track method documentation](https://segment.com/docs/connections/spec/track/) to learn about what it does. An example call would look like:
47+
48+
```js
49+
analytics.track('Login Button Clicked', {
50+
})
51+
```
52+
53+
Segment sends Track calls to Bucket as a `track` event which updates the Features page.

0 commit comments

Comments
 (0)