canvases

Invoke one registered action verb as the viewer.

The canvas must declare the verb in capabilities.posthog.actions (the reviewed permission boundary); the write itself runs with the viewer's own permissions, exactly as if they acted in the app.

post/api/projects/{project_id}/canvases/{id}/actions/invoke/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/canvases/{id}/actions/invoke/
  • Auth: HTTP bearer

Path parameters

idstring uuid required

A UUID string identifying this canvas.

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

verbstring required

Registered verb to invoke, e.g. 'tasks.create'.

payloadobject

Verb-specific arguments, validated against the verb's payload schema.

Response

verbstring required

The verb that executed.

resultobject required

Verb-specific result, e.g. {'task_id': ...} for tasks.create.

Changes

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