-
Notifications
You must be signed in to change notification settings - Fork 750
docs(endpoints): Add documentation for HogQL variable validation #14986
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.
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
Merged
sarahxsanders
merged 4 commits into
master
from
docs-writer-ai-update-2026-02-12T15-24-00-053Z
Feb 13, 2026
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
0d6f505
docs(endpoints): add variable validation error troubleshooting for PR…
inkeep[bot] 23f96cf
docs(endpoints): add variable validation section based on PR #47622
inkeep[bot] 6d6cb7c
fix: Use CalloutBox component and code blocks for error messages in t…
inkeep[bot] 23f780d
docs(endpoints): Use code blocks for error messages in variables.mdx
inkeep[bot] File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -36,6 +36,20 @@ curl -X POST \ | |
| "<ph_app_host>/api/projects/{project_id}/endpoints/{endpoint_name}/run" | ||
| ``` | ||
|
|
||
| ### Variable validation | ||
|
|
||
| When you create or update an endpoint, PostHog validates that every variable placeholder in your query has a matching variable definition. | ||
|
|
||
| For each `{variables.X}` placeholder in your query, you must define a variable with `code_name` set to `X`. Create and manage variables in [data management variables](https://app.posthog.com/data-management/variables). | ||
|
|
||
| If validation fails, you'll see one of these errors: | ||
|
|
||
| - **"Query references undefined variable(s)"** - Your query uses a placeholder that doesn't have a matching variable definition. Define the variable with the correct `code_name`. | ||
| - **"Variable ID(s) not valid UUIDs"** - Variable IDs must be valid UUIDs. | ||
| - **"Variable ID(s) not found"** - The variable doesn't exist. Create it in data management first. | ||
|
||
|
|
||
| See [troubleshooting](/docs/endpoints/troubleshooting#variable-errors) for more details. | ||
|
|
||
| ### Materialization | ||
|
|
||
| SQL-based endpoints with variables can be [materialized](/docs/endpoints/materialization) when each variable is used in a `WHERE` clause with a supported comparison operator. | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this needs to be updated to use the right callout component, with proper spacing