workflow_data_suggestions

Changed on

Workflow ideas written by AI from the project's own events. Both calls are free for the customer.

post/api/projects/{project_id}/workflow_data_suggestions/build/

Request

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

suggestion_idstring required

The id of a suggestion from the list endpoint.

retryboolean

Start a new build when the last one failed. Leave it false when asking for a running build's status.

save_draftboolean

Save the built draft in the project and return its workflow_id. Blank settings, like a webhook URL, stay blank and are listed in missing_inputs. Leave it false to get the workflow back without saving.

Response

status'ready' | 'building' | 'failed' required
  • ready - Ready
  • building - Building
  • failed - Failed
workflowunknown required
uses_saved_templateboolean required

Whether an email step reuses a saved email template.

workflow_idstring nullable required

With status ready and save_draft: the id of the saved draft workflow. Null otherwise.

Changes

  • 1fdf8604a9b9Revision changes
    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 9a021d87533dRevision changes
    • info

      endpoint added