Skip to content

Commit fa7ca9e

Browse files
committed
inital docs for destination
1 parent ffc7684 commit fa7ca9e

File tree

1 file changed

+51
-0
lines changed
  • src/connections/destinations/catalog/avo

1 file changed

+51
-0
lines changed
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
# The end name should be similar to `Slack Destination`
3+
title: avo destination
4+
hide-boilerplate: true
5+
hide-dossier: true
6+
---
7+
8+
<!-- This template is meant for Actions-based destinations that do not have an existing Classic or non-Actions-based version. For Actions Destinations that are a new version of a classic destination, see the doc-template-update.md template. -->
9+
10+
{% include content/plan-grid.md name="actions" %}
11+
12+
<!-- Include a brief description of the destination here, along with a link to your website. -->
13+
14+
[Avo](https://www.avo.app/) destination automatically extracts event schemas from all "track" product events from the connected source and sends it to the Avo Inspector. [Avo Inspector](https://www.avo.app/docs/inspector/start-using-inspector) compares the received events against your Avo tracking plan and surfaces any issues and discrepencies in your event tracking.
15+
16+
<!-- This include describes the requirement of A.js 2.0 or higher for Actions compatibility, and is required if your destination has a web component. -->
17+
18+
<!-- The section below explains how to enable and configure the destination. Include any configuration steps not captured below. For example, obtaining an API key from your platform and any configuration steps required to connect to the destination. -->
19+
20+
## Getting Avo API key
21+
22+
Before connecting the segment source to avo, you will need to aquire an api key for your source.
23+
24+
1. Log in/Signup to Avo
25+
2. From the sidebar, select **Sources**
26+
3. Select your source or Create a new source. (Name it similar to what the source name is inside Segment, for example "Web", "IOS", "Android")
27+
4. Press the **Inspector Setup** tab inside the source
28+
5. Copy the API key
29+
30+
## Getting started
31+
32+
1. From the Segment web app, click **Catalog**, then click **Destinations**.
33+
2. Find the Destinations Actions item in the left navigation, and click it.
34+
3. Click **Configure avo**.
35+
4. Select an existing Source to connect to **avo** (Actions).
36+
37+
<!-- The line below renders a table of connection settings (if applicable), Pre-built Mappings, and available actions. -->
38+
39+
{% include components/actions-fields.html %}
40+
41+
<!--
42+
Additional Context
43+
44+
Include additional information that you think will be useful to the user here. For information that is specific to an individual mapping, please add that as a comment so that the Segment docs team can include it in the auto-generated content for that mapping.
45+
-->
46+
47+
## Destination Settings
48+
49+
1. Copy the API key from avo into the field `API key` in settings.
50+
2. Select an environment you'd like the data to go to in Avo. It should reflect from what environment the source is coming from. (Production / Development / Staging)
51+
3. **(optional)** write the property field name for exracting appVersion if you have a special appVersion property, by default we extract it from `{segmentEvent.context.app.version}` which will result in `unversioned` if that does not exist.

0 commit comments

Comments
 (0)