Skip to content

Commit c7d63a7

Browse files
tcgilbertmarkzegarelli
andauthored
add breyta-crm documentation (#3055)
* add breyta-crm documentation * Updated catalog, added id Co-authored-by: markzegarelli <[email protected]>
1 parent 61c2bb4 commit c7d63a7

File tree

4 files changed

+130
-0
lines changed

4 files changed

+130
-0
lines changed

.github/styles/Vocab/Docs/accept.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ async
2525
Blitzllama
2626
blocklist
2727
boolean
28+
Breyta
2829
Chargebee
2930
CloudFront
3031
Cocoapods

src/_data/catalog/destinations.yml

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7610,6 +7610,67 @@ items:
76107610
phone:
76117611
'@path': $.traits.phone
76127612
trigger: type = "identify" or type = "group"
7613+
- id: 6241e78214aad278a6322f52
7614+
display_name: Breyta CRM
7615+
name: Breyta CRM
7616+
slug: breyta-crm
7617+
hidden: false
7618+
endpoints:
7619+
- us
7620+
regions:
7621+
- us
7622+
url: connections/destinations/catalog/breyta-crm
7623+
previous_names:
7624+
- Breyta CRM
7625+
website: https://breyta.io
7626+
status: PUBLIC_BETA
7627+
categories:
7628+
- Analytics
7629+
- Customer Success
7630+
logo:
7631+
url: >-
7632+
https://public-segment-devcenter-production.s3.amazonaws.com/214ac298-7522-46be-a714-6a2f9c1be203.svg
7633+
mark:
7634+
url: >-
7635+
https://public-segment-devcenter-production.s3.amazonaws.com/7d9fc850-f53a-4ae1-b270-6c157caff98e.svg
7636+
methods:
7637+
track: true
7638+
identify: true
7639+
group: true
7640+
alias: false
7641+
page: true
7642+
platforms:
7643+
browser: true
7644+
mobile: true
7645+
server: true
7646+
components: []
7647+
browserUnbundlingSupported: false
7648+
browserUnbundlingPublic: false
7649+
replay: false
7650+
connection_modes:
7651+
device:
7652+
web: false
7653+
mobile: false
7654+
server: false
7655+
cloud:
7656+
web: false
7657+
mobile: false
7658+
server: false
7659+
settings:
7660+
- name: apiKey
7661+
type: string
7662+
defaultValue: ''
7663+
description: Breyta App Login -> Integrations -> Segment -> Copy API key
7664+
required: true
7665+
label: API Key
7666+
- name: workspaceId
7667+
type: string
7668+
defaultValue: ''
7669+
description: Your Breyta Workspace Id
7670+
required: true
7671+
label: Workspace Id
7672+
actions: []
7673+
presets: []
76137674
- id: 54521fd525e721e32a72ee98
76147675
display_name: Bronto
76157676
name: Bronto

src/_data/catalog/regional-supported.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1156,6 +1156,14 @@ destinations:
11561156
- eu
11571157
endpoints:
11581158
- us
1159+
- id: 6241e78214aad278a6322f52
1160+
display_name: Breyta CRM
1161+
slug: breyta-crm
1162+
url: connections/destinations/catalog/breyta-crm
1163+
regions:
1164+
- us
1165+
endpoints:
1166+
- us
11591167
- id: 54521fd525e721e32a72ee98
11601168
display_name: Bronto
11611169
slug: bronto
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
title: Breyta Destination
3+
id: 6241e78214aad278a6322f52
4+
---
5+
6+
[Breyta](https://breyta.io/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"}, CRM as it should be. Breyta is designed to work for you, so you can spend more time closing deals. Get actionable and automatic insights throughout your customer lifecycle.
7+
8+
This destination is maintained by Breyta. For any issues with the destination, [contact the Breyta Support team](mailto:[email protected]).
9+
10+
## Getting started
11+
12+
{% include content/connection-modes.md %}
13+
14+
1. Login to your [Breyta account](https://app.breyta.io){:target="_blank"}.
15+
2. Go to the Integrations page and click **Add New**.
16+
3. Select the Segment Integration and sign in to your Segment account to grant Breyta access.
17+
18+
## Supported methods
19+
20+
Breyta supports the following methods, as specified in the [Segment Spec](/docs/connections/spec).
21+
22+
### Page
23+
24+
Segment sends Page calls to Breyta as page events. They can be used in Breyta as event sources. You can filter and score users based on which pages they have visited.
25+
```js
26+
analytics.page()
27+
```
28+
29+
### Screen
30+
31+
Segment sends Screen calls to Breyta as screen events. They can be used in Breyta as event sources. You can filter and score users based on which screens they have visited.
32+
```obj-c
33+
[[SEGAnalytics sharedAnalytics] screen:@"Home"];
34+
```
35+
36+
### Identify
37+
38+
Segment sends Identify calls to Breyta as an identify event. When you identify a new user, Breyta creates a new User record. If the User already exists, Breyta updates the User’s properties.
39+
```js
40+
analytics.identify('userId123', {
41+
42+
});
43+
```
44+
45+
### Group
46+
47+
Segment sends Group calls to Breyta as an group event. A group event can create a Group or associate a User to a Group within Breyta.
48+
```js
49+
analytics.group('accountId123', {
50+
account_id: '12345678',
51+
name: "ABC Group"
52+
});
53+
```
54+
55+
### Track
56+
57+
Segment sends Track calls to Breyta as a track event. They can be used in Breyta as event sources. You can filter and score users based on which events they have triggered in your app.
58+
```js
59+
analytics.track('Login Button Clicked')
60+
```

0 commit comments

Comments
 (0)