canvases

Create a new, empty canvas in a channel; give it source by publishing a project.

post/api/projects/{project_id}/canvases/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/canvases/
  • Auth: 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

namestring required

Display name for the canvas.

channel_idstring uuid required

Id of the channel the canvas belongs to.

kind'freeform' | 'grid' | 'component'
  • freeform - freeform
  • grid - grid
  • component - component
descriptionstring

Short prose describing the canvas. For components this is the store-search text agents match against — say what the widget shows and what its config controls.

template_idstring

Canvas template identifier.

Response

idstring uuid required
namestring required
kind'freeform' | 'grid' | 'component' required
  • freeform - freeform
  • grid - grid
  • component - component
descriptionstring required

Short prose describing the canvas. For components, the store-search text.

channelstring uuid required
template_idstring required
generation_task_idstring uuid nullable required
pinnedboolean required

Whether the canvas is pinned to its channel.

pinned_atstring date-time nullable required
current_version_idstring uuid nullable required

Id of the live source version — pass as expected_current_version_id on publish. Null before the first publish.

published_build_idstring uuid nullable required

Id of the canvas's live (last successful, still-eligible) build. Null until a build completes.

created_atstring date-time required
updated_atstring date-time required
urlstring required

Canonical link to the canvas in the PostHog app. The only valid way to link to a canvas — share this when pointing a user at it; never construct a canvas URL.

Changes

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