Skip to content

Commit 7b04788

Browse files
authored
Merge pull request #4768 from segmentio/thomas/sources
new section on event naming conventions
2 parents 60e3b42 + cf03863 commit 7b04788

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

src/partners/sources.md

+22-3
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Before you begin, you need access to the Developer Portal. To access the Develop
1212
2. Once approved, you'll receive an invitation to join the Segment Developer Portal.
1313
3. Log in to Segment, navigate to the User dropdown in the top right of the screen, and click [**Developer Portal**](https://app.segment.com/dev-portal){:target="_blank"}.
1414

15-
## Build the Source
15+
## Build the source
1616

1717
1. Once in the Developer Portal, navigate to **Integrations** and click **Build integration** > **Build a source**
1818

@@ -34,7 +34,26 @@ Building your source will require defining the event data that you send to Segme
3434

3535
If you break the spec, you are breaking the promise of Segment, which is grounds for removal from the catalog. To learn about the semantics of the five supported API calls, and the semantic event names and properties Segment recognizes, read the [Segment Spec](/docs/connections/spec).
3636

37-
Within the Spec, there are a few requirements for partner Streams worth pointing out.
37+
Within the Spec, there are a few requirements for partner Streams worth pointing out.
38+
39+
### Naming conventions
40+
41+
When you're creating events and the properties associated with them, you want to be crystal clear about the casing. This might seem nitpicky, but it's imperative in the long run. Segment recommends `Proper Case` for event names, and `snake_case` for properties. If you have platform-specific requirements that necessitate the use of different casing, it is permissible.
42+
43+
Here are the five most common options:
44+
45+
- `all lowercase` — account created
46+
47+
- `snake_case` — account_created
48+
49+
- `Proper Case` — Account Created
50+
51+
- `camelCase` — accountCreated
52+
53+
- `Sentence case` — Account created
54+
55+
You can read more about Segment's recommended naming conventions [here](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/){:target="_blank"}.
56+
3857

3958
### `userId`
4059

@@ -91,7 +110,7 @@ Segment offers customers the option to lead on data residency by providing [regi
91110
- Oregon (US Default) — `api.segment.io/v1`
92111
- Dublin — `events.eu1.segmentapis.com/`
93112

94-
## Test your Source
113+
## Test your source
95114

96115
1. From your source's page in the Developer Portal, navigate to **Settings** > **Add to workspace**. From the dropdown, select the Segment workspace you'll use to test your source, and click **Add to workspace**. The selected workspace will open in a new tab.
97116

0 commit comments

Comments
 (0)