signals

Leave a note for the scouts

Leave a steering note the scout fleet reads on its next runs. Address it to one scout via skill_name (a configured scout), to one stage of the report pipeline via a reserved audience (pipeline:report-research), or omit it for a general note every scout sees. Each call creates a new note (no upsert); delete retires one. Attributed to the authenticated user.

post/api/projects/{project_id}/signals/scout/notes/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/signals/scout/notes/
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

project_idstring required

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

Request body

contentstring required

The note's prose — feedback, a pointer, or a nudge for the scout(s) to weigh on their next runs (e.g. 'we shipped a new checkout on Tuesday, watch conversion closely', 'stop flagging the staging traffic spike'). Write it in Markdown; the run reads it verbatim.

skill_namestring

Address the note to one scout by its skill name (exact match against a configured scout on the project — check scout-config-list for the roster), or to one stage of the report pipeline by its reserved audience (pipeline:report-research). Use a pipeline audience for guidance about how reports get researched rather than about what the scouts watch, so it reaches that stage and no scout. Omit or leave blank for a general note every scout sees.

expires_atstring nullable

Optional ISO-8601 expiry. After this time the note drops out of the default list view, so time-boxed steering ('watch closely this week') retires itself. Omit for a note that stays active until deleted. Best-effort — a value that can't be parsed or is already in the past is dropped (the note stays active), not rejected, so the note is never lost.

Response

The note as created.

idstring required

Note UUID. Pass to scout-notes-delete to retire the note.

skill_namestring required

Who the note is addressed to: a configured scout's skill name, a pipeline audience (pipeline:*, e.g. pipeline:report-research), or blank for a general note every scout sees.

contentstring required

The note's prose, read verbatim by the run that picks it up.

created_atstring nullable required

ISO-8601 creation timestamp.

expires_atstring nullable required

ISO-8601 expiry, or null for a note that stays active until deleted.

created_by_namestring nullable required

Display name of the user who left the note, or null when unavailable.

originstring required

Where the note came from. human for one left directly through this API. report_dismissal for one forwarded from the note someone typed when they dismissed, snoozed, or restored one or more inbox reports: one reviewer's verdict on the reports its content names, so weigh it as evidence about those reports rather than as fleet-level steering. report_discussion for the question someone asked when they opened a discussion on a report: context to weigh, neither a verdict on the report nor a directive. report_feedback for the note someone left when rating a report useful or not: one reader's rating of the named report, context to weigh rather than a directive. report_reviewer_correction for a suggested reviewer someone added or removed on a report: evidence about who owns that surface, and a prompt to revisit the routing memory it corrects, rather than a directive.

Changes

No recorded changes to this operation across all 1 revision of this API.