Skip to content

AVO-2568: document how the import API decides "Include in Codegen" #1738

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

Open
ada-avo wants to merge 1 commit into
base: main
Choose a base branch
from
Open

AVO-2568: document how the import API decides "Include in Codegen" #1738

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
13 changes: 12 additions & 1 deletion pages/reference/public-api/import-tracking-plan.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ The format produced by Avo's [JSON Schema export](/reference/public-api/export-t
| `description` | string | Event description | |
| `eventType` | string | — | Events with type `"variant"` are skipped with a warning |
| `tags` | `string[]` | Event tags | |
| `sources` | `{ name: string }[]` | Source names | Only the `name` field is extracted |
| `sources` | `{ name: string }[]` | Source names | Only the `name` field is extracted. `implementWithCodegen` is ignored — see [Include in Codegen](#include-in-codegen) for how the setting is decided |
| `stakeholderDomains` | `{ name: string, isOwner: bool }[]` | Domain names + owner | The domain with `isOwner: true` becomes the event owner |
| `categories` | `string[]` | **Not imported** | Export contains goal IDs, not names — left empty to avoid phantom categories |
| `rules.nameMapping` | `{ name, destinationId }[]` | Event name mapping | |
Expand Down Expand Up @@ -241,6 +241,17 @@ The following will cause a parse error:

- Unresolved `$ref` — only inline schemas are supported

## Include in Codegen

The import does not read `implementWithCodegen` from the payload. Instead, when the import attaches a source to an event, it decides "Include in Codegen" the same way the Avo UI does when you attach a source by hand:

- **On**, if your plan includes codegen **and** the source is configured for codegen — it has a programming language, a platform, and at least one destination.
- **Off**, otherwise. A source the import itself creates is always off, because a brand-new source has no language or platform yet.

This applies only when a source is **newly attached** to an event. Re-importing an event whose source is already attached leaves the existing setting untouched, so a toggle you changed in the UI is never overwritten by a later import.

To change "Include in Codegen" on an event that is already attached to a source, use the Avo MCP server's `save_items` tool (`setSourceCodegen`) or the Avo UI.

## Import Methods

### Add Only (default)
Expand Down
Loading