provider field_notes POST /api/projects/{project_id}/field_notes/
@utdk/posthog /api/projects/{project_id}/field_notes/
field_notes_create
Create, read, update, and resolve toolbar field notes — UI feedback a user points at on their own site, surfaced to coding agents over MCP.
project_id path required
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
string

Try it

Authentication
Configure credentials for PostHog API
fieldNotesCreate
POST/api/projects/{project_id}/field_notes/
Create, read, update, and resolve toolbar field notes — UI feedback a user points at on their own site, surfaced to coding agents over MCP.

Parameters

required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Input

required
required

The note the user wrote about the element.

Lifecycle of the field note: pending, acknowledged, resolved, or dismissed. Ignored on create. * `pending` - Pending * `acknowledged` - Acknowledged * `resolved` - Resolved * `dismissed` - Dismissed

Optional note left by the agent when acknowledging, resolving, or dismissing the field note.

required

Full URL of the page the field note was made on.

required

Hostname of the page, used to scope field notes to a site.

Path portion of the URL.

required

CSS selector that locates the element on the page.

Visible text of the element, if any.

Serialized autocapture-style element chain from the element up to the document root.

Structured element metadata (inferred selectors, attributes, component hints).

Viewport size when the field note was made, as {width, height}.

URL of an uploaded screenshot captured with the field_note.

required
required
required

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import posthog from '@utdk/posthog';

await posthog.fieldNotesCreate()