Skip to content

Commit c666fcc

Browse files
author
Thomas Gilbert
committed
new section on event naming conventions
1 parent 60e3b42 commit c666fcc

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

src/partners/sources.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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 also want to be crystal clear about the casing. This might seem nitpicky, but it's imperative in the long run. We recommend `Proper Case` for event names, and `snake_case` for properties. If you need to deviate for specific reasons to your platform this is allowable.
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 in [here](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/){:target="_blank"}.
56+
3857

3958
### `userId`
4059

0 commit comments

Comments
 (0)