hog_flows

post/api/projects/{project_id}/hog_flows/{id}/publish/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/hog_flows/{id}/publish/
  • Auth: HTTP bearer

Path parameters

idstring uuid required

A UUID string identifying this hog flow.

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

confirmboolean

False (default) previews the publish: returns the impact on people in-flight without changing anything. True applies the staged draft to the live workflow.

confirm_tokenstring

From the preview response — required when confirm=true. Expires after 15 minutes, and any draft edit invalidates it (409), so you always publish the exact draft you previewed.

Response

publishedboolean required

Whether the draft was applied to the live workflow.

in_flight_runsinteger nullable required

Runs currently in flight (parked on waits/delays or executing) that will follow the new config once published. Null when the count is unavailable.

draft_updated_atstring date-time nullable required

The staged draft's timestamp, for reference; publishing is confirmed via confirm_token.

confirm_tokenstring nullable required

Echo this back with confirm=true to publish the previewed draft. Only set on previews.

Changes

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