Skip to content

Commit ae6a45b

Browse files
authored
Merge branch 'segmentio:develop' into reddit-capi-docs
2 parents 1652cd9 + b2aa094 commit ae6a45b

File tree

14 files changed

+424
-24
lines changed

14 files changed

+424
-24
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 PUBLIC API. DO NOT EDIT
2-
# destination categories last updated 2024-11-26
2+
# destination categories last updated 2024-12-05
33
items:
44
- display_name: A/B Testing
55
slug: a-b-testing

src/_data/catalog/destinations.yml

Lines changed: 135 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# destination data last updated 2024-11-26
2+
# destination data last updated 2024-12-05
33
items:
44
- id: 637e8d185e2dec264895ea89
55
display_name: 1Flow
@@ -108163,6 +108163,131 @@ items:
108163108163
actions: []
108164108164
presets: []
108165108165
partnerOwned: false
108166+
- id: 6720ddceaa24532723b39d63
108167+
display_name: Singlestore
108168+
name: Singlestore
108169+
slug: singlestore
108170+
hidden: false
108171+
endpoints:
108172+
- US
108173+
regions:
108174+
- us-west-2
108175+
- eu-west-1
108176+
url: connections/destinations/catalog/singlestore
108177+
previous_names:
108178+
- Singlestore
108179+
website: https://www.singlestore.com
108180+
status: PUBLIC_BETA
108181+
categories:
108182+
- Raw Data
108183+
- Analytics
108184+
logo:
108185+
url: https://cdn-devcenter.segment.com/c4bfae1b-e5a6-43ff-8277-d0cf02b54114.svg
108186+
mark:
108187+
url: https://cdn-devcenter.segment.com/04b8886a-5fe7-4c05-aab8-4436cd43fbce.svg
108188+
methods:
108189+
track: true
108190+
identify: true
108191+
group: true
108192+
alias: true
108193+
screen: false
108194+
page: true
108195+
platforms:
108196+
browser: true
108197+
mobile: false
108198+
server: true
108199+
warehouse: false
108200+
cloudAppObject: false
108201+
linkedAudiences: true
108202+
components: []
108203+
browserUnbundlingSupported: false
108204+
browserUnbundlingPublic: false
108205+
replay: false
108206+
connection_modes:
108207+
device:
108208+
web: false
108209+
mobile: false
108210+
server: false
108211+
cloud:
108212+
web: true
108213+
mobile: false
108214+
server: true
108215+
settings:
108216+
- name: dbName
108217+
type: string
108218+
defaultValue: ''
108219+
description: The name of the database.
108220+
required: true
108221+
label: Database Name
108222+
- name: environment
108223+
type: select
108224+
defaultValue: Prod
108225+
description: The environment of the Singlestore database.
108226+
required: true
108227+
label: Environment
108228+
- name: host
108229+
type: string
108230+
defaultValue: ''
108231+
description: The host of the Singlestore database.
108232+
required: true
108233+
label: Host
108234+
- name: password
108235+
type: password
108236+
defaultValue: ''
108237+
description: The password of the Singlestore database.
108238+
required: true
108239+
label: Password
108240+
- name: port
108241+
type: number
108242+
defaultValue: 3306
108243+
description: The port of the Singlestore database.
108244+
required: true
108245+
label: Port
108246+
- name: username
108247+
type: string
108248+
defaultValue: ''
108249+
description: The username of the Singlestore database.
108250+
required: true
108251+
label: Username
108252+
actions:
108253+
- id: xxgUnx4BHqGLDYCJ4TiWPW
108254+
name: Send Data
108255+
slug: send
108256+
description: Send data to Singlestore.
108257+
platform: CLOUD
108258+
hidden: false
108259+
defaultTrigger: >-
108260+
type = "track" or type = "screen" or type = "identify" or type = "page" or
108261+
type = "group" or type = "alias"
108262+
fields:
108263+
- id: o4FSHmgGNDZjGayk4VpDqK
108264+
sortOrder: 0
108265+
fieldKey: database
108266+
label: Database
108267+
type: STRING
108268+
description: The name of the SingleStore database to send data to.
108269+
placeholder: ''
108270+
required: true
108271+
multiple: false
108272+
choices: null
108273+
dynamic: true
108274+
allowNull: false
108275+
- id: pV6xn9yXzxddMKs6EU2Ps2
108276+
sortOrder: 1
108277+
fieldKey: message
108278+
label: Message
108279+
type: OBJECT
108280+
description: The complete event payload.
108281+
placeholder: ''
108282+
defaultValue:
108283+
'@path': $.
108284+
required: true
108285+
multiple: false
108286+
choices: null
108287+
dynamic: false
108288+
allowNull: false
108289+
presets: []
108290+
partnerOwned: true
108166108291
- id: 5c768ec31413290001ebdd2e
108167108292
display_name: Singular
108168108293
name: Singular
@@ -113797,6 +113922,12 @@ items:
113797113922
mobile: false
113798113923
server: true
113799113924
settings:
113925+
- name: audience_identifier
113926+
type: select
113927+
defaultValue: computation_key
113928+
description: The audience identifier from your Taboola account.
113929+
required: false
113930+
label: Audience Identifier
113800113931
- name: client_id
113801113932
type: string
113802113933
defaultValue: ''
@@ -113818,7 +113949,7 @@ items:
113818113949
hidden: false
113819113950
defaultTrigger: type = "track"
113820113951
fields:
113821-
- id: 5LsQp4x4a2mc1wS4x3DyGK
113952+
- id: hYPMUogwA6UXaPijimwgGy
113822113953
sortOrder: 3
113823113954
fieldKey: user_email
113824113955
label: Email address
@@ -113839,7 +113970,7 @@ items:
113839113970
dynamic: false
113840113971
allowNull: false
113841113972
hidden: false
113842-
- id: idcYjf4xSRKXSH3vaBhuxv
113973+
- id: mrsc76C98Fes6horASeqQU
113843113974
sortOrder: 5
113844113975
fieldKey: enable_batching
113845113976
label: Batch events
@@ -113854,7 +113985,7 @@ items:
113854113985
choices: null
113855113986
dynamic: false
113856113987
allowNull: false
113857-
- id: kGx5FWvwYVYNB7jgs8Jx4W
113988+
- id: 5gysPJ3QfJvkihzwjJsW1x
113858113989
sortOrder: 6
113859113990
fieldKey: device_id
113860113991
label: Mobile Device ID

src/_data/catalog/destinations_private.yml

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# destination data last updated 2024-11-26
2+
# destination data last updated 2024-12-05
33
items:
44
- id: 54521fd925e721e32a72eee1
55
display_name: Pardot
@@ -670,14 +670,24 @@ items:
670670
browserUnbundlingPublic: false
671671
replay: false
672672
settings:
673-
- name: apiKey
673+
- name: accountid
674+
type: string
675+
defaultValue: ''
676+
description: Rokt ID assigned to your particular account.
677+
required: true
678+
label: Rokt Account ID
679+
- name: rpub
680+
type: string
681+
defaultValue: ''
682+
description: Rokt public key, starts with `rpub-`
683+
required: true
684+
label: Rokt public key
685+
- name: rsec
674686
type: password
675687
defaultValue: ''
676-
description: >-
677-
APIKey used for Rokt API authorization before sending custom audiences
678-
data
688+
description: Rokt secret key, starts with `rsec-`
679689
required: true
680-
label: API Key provided by Rokt integration
690+
label: Rokt secret key
681691
actions:
682692
- id: oNpU37CaJbuxq7PqBGEYz4
683693
name: Sync Engage Audience to Rokt
@@ -689,7 +699,7 @@ items:
689699
hidden: false
690700
defaultTrigger: type = "track" or type = "identify"
691701
fields:
692-
- id: hkunPAdr3JHSMDGCW8Hr7P
702+
- id: aCdquof3Bd6c3wug29BeEY
693703
sortOrder: 0
694704
fieldKey: custom_audience_name
695705
label: Custom Audience Name
@@ -704,7 +714,7 @@ items:
704714
dynamic: false
705715
allowNull: false
706716
hidden: false
707-
- id: k8zCN8YH12e6N9EqeTbK3m
717+
- id: 4qkzJunzrb3ZTtn5VEXgHo
708718
sortOrder: 1
709719
fieldKey: segment_computation_action
710720
label: Segment Computation Action
@@ -721,7 +731,7 @@ items:
721731
dynamic: false
722732
allowNull: false
723733
hidden: false
724-
- id: 4rPpCohUqos6N47caU35ct
734+
- id: fq5EwYtoVfnBh5wRJ6YMhH
725735
sortOrder: 2
726736
fieldKey: email
727737
label: Email
@@ -742,7 +752,7 @@ items:
742752
dynamic: false
743753
allowNull: false
744754
hidden: false
745-
- id: ab4jivj6fXuTQ4TM68JERi
755+
- id: ae6rFSFRB9dSGZNVAxPxjb
746756
sortOrder: 3
747757
fieldKey: traits_or_props
748758
label: traits or properties object
@@ -765,7 +775,7 @@ items:
765775
dynamic: false
766776
allowNull: false
767777
hidden: false
768-
- id: vH5iWCWZpV15WjgDFTnCXd
778+
- id: btfk8jdv6uDRh7KT6dmcwC
769779
sortOrder: 4
770780
fieldKey: enable_batching
771781
label: enable batching to rokt api

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 PUBLIC API. DO NOT EDIT
2-
# source categories last updated 2024-11-26
2+
# source categories last updated 2024-12-05
33
items:
44
- display_name: A/B Testing
55
slug: a-b-testing

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 PUBLIC API. DO NOT EDIT
2-
# sources last updated 2024-11-26
2+
# sources last updated 2024-12-05
33
items:
44
- id: 8HWbgPTt3k
55
display_name: .NET

src/connections/destinations/catalog/actions-liveramp-audiences/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,9 @@ The LiveRamp Audiences destination can be connected to **Twilio Engage sources o
4141
7. In the settings that appear in the side panel, toggle the Send Track option on and do not change the Audience Entered/Audience Exited event names. Click Save Settings
4242
8. File a [support case](https://docs.liveramp.com/connect/en/considerations-when-uploading-the-first-file-to-an-audience.html#creating-a-support-case){:target="_blank"} with the LiveRamp team to configure and enable ingestion.
4343

44+
> info "Mapping tester availability"
45+
> The Mapping Tester isn't available for this destination. Since this destination requires batched events for activation, testing can only be performed end-to-end with a connected source.
46+
4447
{% include components/actions-fields.html settings="false"%}
4548

4649
## Limitations
Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
---
2+
title: AWS S3 (Actions) Destination
3+
hide-boilerplate: true
4+
hide-dossier: false
5+
id: 66eaa166f650644f04389e2c
6+
private: true
7+
beta: true
8+
# versions:
9+
# - name: AWS S3 (Classic)
10+
# link: /docs/connections/destinations/catalog/aws-s3/
11+
---
12+
{% include content/plan-grid.md name="actions" %}
13+
14+
The AWS S3 (Actions) destination allows you to store event data as objects in a secure, scalable cloud storage solution. Each event is written to your S3 bucket, organized into a customizable folder structure such as by event type or timestamp. This makes it easy to manage, archive, and analyze data using downstream tools or AWS services.
15+
16+
17+
## Benefits of AWS S3 (Actions) vs AWS S3 Classic
18+
The traditional AWS S3 Classic destination enabled the storage of raw logs containing data Segment received, directly into your S3 bucket. While this provided a straightforward data storage solution, users often needed to implement additional processing to standardize or transform these logs (in JSON format) for downstream analytics or integrations.
19+
20+
The AWS S3 (Actions) destination enhances this capability by introducing configurable options to format and structure event data prior to storage. This new approach offers several key benefits:
21+
22+
* **Standardized Data Formatting**. AWS S3 (Actions) lets you define consistent output formats for your data, either CSV or TXT file formats, in a folder definition that you choose. The previous AWS S3 Classic Destination only allowed raw JSON payloads stored within a specific folder called `"segment-logs"`.
23+
24+
* **Configurable Data Translation**. AWS S3 (Actions) supports translation rules that can map raw event attributes to more meaningful or actionable representations. You can configure these rules to meet specific data schema requirements by either adding in custom columns or using the default ones.
25+
26+
* **Enhanced Delivery Controls**. The destination provides advanced options for batch size controls and file naming conventions. These controls can help optimize efficiency and simplify data retrieval workflows.
27+
28+
## Getting started
29+
Setting up the AWS S3 (Actions) destination is a straightforward process designed to help you configure and deploy standardized event data to your Amazon S3 bucket. Follow these steps to get started:
30+
31+
### Prerequisites
32+
Ensure you have the following in place before configuring the AWS S3 (Actions) destination:
33+
34+
- Amazon S3 Bucket: Create a bucket in your AWS account or use an existing one where you want to store the event data.
35+
- AWS IAM Permissions: Verify that you have appropriate IAM roles with write access to the S3 bucket and permissions for the Segment connection.
36+
- IAM Access IDs: Prepare your AWS IAM ARN ID and IAM External ID. These will be needed to authenticate and authorize Segment with your S3 bucket.
37+
38+
39+
### Step 1: Create an IAM role in the AWS console
40+
To set up the IAM role to properly authorize Segment with the AWS S3 (Actions) destination:
41+
42+
1. Log in to your AWS account.
43+
2. Create a new or use an existing bucket with `PutObject`, `GetObject`, `ListObject` access to the S3 bucket.
44+
3. Navigate to **IAM > Roles > Create Role**.
45+
4. Provide the following policy permissions for the IAM that was just created:
46+
```json
47+
{
48+
"Version": "2012-10-17",
49+
"Statement": [
50+
{
51+
"Sid": "PutObjectsInBucket",
52+
"Effect": "Allow",
53+
"Action": [
54+
"s3:PutObject",
55+
"s3:PutObjectAcl"
56+
],
57+
"Resource": "arn:aws:s3:::<YOUR_BUCKET_NAME>/*"
58+
}
59+
]
60+
}
61+
```
62+
5. Click on the Trust Relationships tab and edit the trust policy to allow the IAM user to assume the role. If a user is not already created, refer to the AWS documentation to create a user.
63+
```json
64+
{
65+
"Version": "2012-10-17",
66+
"Statement": [
67+
{
68+
"Sid": "",
69+
"Effect": "Allow",
70+
"Principal": {
71+
"AWS":
72+
"arn:aws:iam::595280932656:role/customer-s3-prod-action-destination-access"
73+
},
74+
"Action": "sts:AssumeRole",
75+
"Condition": {
76+
"StringEquals": {
77+
"sts:ExternalId": "<YOUR_EXTERNAL_ID>"
78+
}
79+
}
80+
}
81+
]
82+
}
83+
```
84+
## Step 2: Add the AWS S3 (Actions) Destination in Segment
85+
To finish the configuration, enable the AWS S3 (Actions) Destination in your workspace.
86+
87+
1. Add the **AWS S3 (Actions)** destination from the Destinations tab of the catalog.
88+
2. Select the data source you want to connect to the destination.
89+
3. Provide a unique name for the destination.
90+
4. Complete the destination settings:
91+
* Enter the name of the region in which the bucket you created above resides.
92+
* Enter the name of the bucket you created above. Be sure to enter the bucket's **name** and not URI.
93+
* Enter the ARN of the IAM role you created above. The ARN should follow the format `arn:aws:iam::ACCOUNT_ID:role/ROLE_NAME.`
94+
* Enter the IAM External ID, which is a value set in the Trust Relationship under your AWS IAM Role.
95+
5. Enable the destination.
96+
6. Verify the Segment data is stored in the S3 bucket by navigating to the `<your_S3_bucket>/` in the AWS console.
97+
98+
{% include components/actions-fields.html settings="true"%}
99+
100+

0 commit comments

Comments
 (0)