Skip to content

Commit 306b41d

Browse files
update to third party app integration docs
1 parent 95a1d3d commit 306b41d

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

docs/learn/3d-bits/for-developers/third-party-app-integrations.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,12 +114,30 @@ While we recommend the schema below for consistency across integrations, we unde
114114

115115
### Event Name
116116

117-
Use the exact namespace:
117+
We suggest using this event name, but you could create your own namespace. We understand that you might not want to have references to a single app in your codebase.
118118

119119
```javascript
120120
3dbits.productOptions.changed
121121
```
122122

123+
Alternative:
124+
125+
```javascript
126+
yourApp.productOptions.changed
127+
```
128+
129+
**If you use `3dbits.productOptions.changed`:**
130+
- We can detect this automatically
131+
- Users won't need to manually select your app from our Input Collection Mode dropdown
132+
- The integration will work out of the box
133+
134+
**If you choose your own event name:**
135+
- Please [contact us](#contact-information) with your event name
136+
- We'll add support for your specific event
137+
- Users will need to select your app from the Input Collection Mode dropdown
138+
139+
This way we'll know which event to listen to when users configure your app for input collection.
140+
123141
### Event Data Structure (TypeScript)
124142

125143
The `detail` property of the event should follow this interface:

0 commit comments

Comments
 (0)