Skip to content

Commit 60ca800

Browse files
committed
Add more description around the fields in the destination settings
1 parent 5124d51 commit 60ca800

File tree

1 file changed

+20
-4
lines changed
  • src/connections/destinations/catalog/avo

1 file changed

+20
-4
lines changed

src/connections/destinations/catalog/avo/index.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,25 @@ Before connecting the Segment source to Avo, you will need an API key for your s
6767

6868
### Configure Destination
6969

70-
1. Copy the **API Key** from Avo into the field `API Key` in settings.
71-
2. Select an environment you'd like the data to go to within Avo. It should reflect from what environment the source is receiving data from. (**Production** / **Development** / **Staging**)
72-
3. **App Version Property (Optional):** If you have an event property describing the app release version of your source you can provide it under App Version. For most mobile sources, we will automatically fetch the app version from segment context. Having accurate app release versions in Avo Inspector will help you identify which releases an issue is impacting, and monitor for regressions in future releases after you’ve resolved the issue.
73-
![Select a source](images/avo-destination.png)
70+
#### Avo Inspector API Key
71+
72+
You can copy the API key from your source in Avo. The API key allows Avo to map the events from your Segment source to the Avo source, to accurately compare your source’s event schemas to your Tracking Plan in Avo.
73+
74+
#### Environment
75+
76+
Environment describes which app environment the source is sent from, `Development | Staging | Production`.
77+
Avo only generates issues for events in the `Production` environment, but you can see the event shapes for staging and development environments to make sure they are implemented correctly.
78+
79+
#### App Version Property
80+
81+
App Version Property is an optional **(but recommended!)** field. Having accurate app release versions in Avo Inspector allows you to see how events change across releases. This will help you identify which releases an issue is impacting, and monitor for regressions in future releases after an issue has been resolved.
82+
83+
Without app versions, the inspector has no way of differentiating between old and new releases, and might surface irrelevant issues based on old releases. [Learn more about how Inspector uses releases](https://www.avo.app/docs/inspector/inspector-issues-view#release-and-source-breakdown)
84+
85+
For most mobile sources, we will automatically fetch the app version from Segment Context. If you have an event property describing the app release version of your source (“E.g “app_version”) you can provide it under App Version.
86+
87+
If you are unsure of whether this applies to your source, or if you don’t know which event property to use, you can proceed with setting up the source and add this information later.
88+
89+
![Select a source](images/avo-destination.png)
7490

7591
{% include components/actions-fields.html %}

0 commit comments

Comments
 (0)