Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Segment docs to be more clear #1452

Merged
merged 1 commit into from
Jan 24, 2025
Merged

Improve Segment docs to be more clear #1452

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions docs/developer/app-store/apps/segment.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,15 @@ sequenceDiagram
## Pre-requisites

- Create an account on [Twillo Segment](https://segment.com/).
- Create a [source](https://segment.com/docs/partners/sources/) in the Segment Dashboard UI and note down the `writeKey` for this source.
- Create a HTTP API [source](https://segment.com/docs/partners/sources/) in the Segment Dashboard UI and note down the Write Key for this source.

## Installation

- Go to the Apps section in your Saleor Dashboard. Pick Twilio Segment and Install.

## Configuration

- Paste [`writeKey`](https://segment.com/docs/connections/find-writekey/) into the main configuration form in the app and click `Save`.
- Paste [Write Key](https://segment.com/docs/connections/find-writekey/) into the main configuration form in the app and click `Save`.

### Testing

Expand All @@ -82,7 +86,7 @@ To test if your app is working, create an order and update its address or shippi
## Troubleshooting

- **Events are not showing in Segment Dashboard**
- Ensure you have set your `writeKey` in the app configuration screen.
- Ensure you have set your Write Key in the app configuration screen.
- Trigger one of the supported events (see [application flow section](#application-flow) for more details).

## Development
Expand Down