flows

Publish a flow

Makes the flow readable by anyone with its link, with no account and nothing to accept. The public view never includes assignees, comments, uploaded files or task notes, and its items cannot be opened. Returns the flow, including its publicUrl.

post/v1/flows/{flowId}/publish

Request

  • Base URL: https://api.flowral.app
  • URL: https://api.flowral.app/v1/flows/{flowId}/publish
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (client credentials, token URL https://api.flowral.app/v1/oauth/token, scopes: flows:write)

Path parameters

flowIdstring required

Response

SUCCESS

idstring required
namestring required
descriptionstring nullable
archivedboolean required
publicboolean

Whether this flow is published — readable by anyone with its link, with no account. Assignees, comments and files are never included in the public view.

publicUrlstring nullable

The published link, or null when the flow is private.

dueDatestring date-time

The date the flow is meant to land, if one is set.

taskCountinteger
doneCountinteger
readyCountinteger

Tasks that can be started right now.

createdAtstring date-time
updatedAtstring date-time

Example response

{
  "id": "flw_2b8e10",
  "publicUrl": "https://platform.flowral.app/public/flow/flw_2b8e10"
}

Changes

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