Create workflow

For the complete documentation index, see llms.txt. For the full documentation snapshot, see llms-full.txt.

Workflows are in maintenance mode

The workflows feature is in maintenance mode, and is planned for future deprecation at a date not yet specified. We will work with existing customers using workflows to migrate to a replacement solution when deprecation occurs.

Create a workflow for a feature flag. You can create a workflow directly, or you can apply a template to create a new workflow.

Creating a workflow

You can use the create workflow endpoint to create a workflow directly by adding a stages array to the request body.

For each stage, define the name, conditions when the stage should be executed, and action that describes the stage. For approval stages, only standard LaunchDarkly approvals are permitted. Workflows of kind integration-approval cannot be used for custom workflows.

Click to expand example

Example request body

{
  "name": "Progressive rollout starting in two days",
  "description": "Turn flag targeting on and increase feature rollout in 10% increments each day",
  "stages": [
    {
      "name": "10% rollout on day 1",
      "conditions": [
        {
          "kind": "schedule",
          "scheduleKind": "relative", // or "absolute"
              //  If "scheduleKind" is "absolute", set "executionDate";
              // "waitDuration" and "waitDurationUnit" will be ignored
          "waitDuration": 2,
          "waitDurationUnit": "calendarDay"
        },
        {
          "kind": "ld-approval",
          "notifyMemberIds": [ "507f1f77bcf86cd799439011" ],
          "notifyTeamKeys": [ "team-key-123abc" ]
        }
      ],
      "action": {
        "instructions": [
          {
            "kind": "turnFlagOn"
          },
          {
            "kind": "updateFallthroughVariationOrRollout",
            "rolloutWeights": {
              "452f5fb5-7320-4ba3-81a1-8f4324f79d49": 90000,
              "fc15f6a4-05d3-4aa4-a997-446be461345d": 10000
            }
          }
        ]
      }
    }
  ]
}

Creating a workflow by applying a workflow template

You can also create a workflow by applying a workflow template. If you pass a valid workflow template key as the templateKey query parameter with the request, the API will attempt to create a new workflow with the stages defined in the workflow template with the corresponding key.

Applicability of stages

Templates are created in the context of a particular flag in a particular environment in a particular project. However, because workflows created from a template can be applied to any project, environment, and flag, some steps of the workflow may need to be updated in order to be applicable for the target resource.

You can pass a dryRun query parameter to tell the API to return a report of which steps of the workflow template are applicable in the target project/environment/flag, and which will need to be updated. When the dryRun query parameter is present the response body includes a meta property that holds a list of parameters that could potentially be inapplicable for the target resource. Each of these parameters will include a valid field. You will need to update any invalid parameters in order to create the new workflow. You can do this using the parameters property, which overrides the workflow template parameters.

Overriding template parameters

You can use the parameters property in the request body to tell the API to override the specified workflow template parameters with new values that are specific to your target project/environment/flag.

Click to expand example

Example request body

{
	"name": "workflow created from my-template",
	"description": "description of my workflow",
	"parameters": [
		{
			"_id": "62cf2bc4cadbeb7697943f3b",
			"path": "/clauses/0/values",
			"default": {
				"value": ["updated-segment"]
			}
		},
		{
			"_id": "62cf2bc4cadbeb7697943f3d",
			"path": "/variationId",
			"default": {
				"value": "abcd1234-abcd-1234-abcd-1234abcd12"
			}
		}
	]
}

If there are any steps in the template that are not applicable to the target resource, the workflow will not be created, and the meta property will be included in the response body detailing which parameters need to be updated.

POST /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflows

Create workflow

cURL

curl --request POST \
  --url https://app.launchdarkly.com/api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflows \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Turn flag on for 10% of customers each day",
  "name": "Progressive rollout starting in two days",
  "stages": [
    {
      "action": {
        "instructions": [
          {
            "kind": "turnFlagOn"
          },
          {
            "kind": "updateFallthroughVariationOrRollout",
            "rolloutWeights": {
              "452f5fb5-7320-4ba3-81a1-8f4324f79d49": 90000,
              "fc15f6a4-05d3-4aa4-a997-446be461345d": 10000
            }
          }
        ]
      },
      "conditions": [
        {
          "kind": "schedule",
          "scheduleKind": "relative",
          "waitDuration": 2,
          "waitDurationUnit": "calendarDay"
        }
      ],
      "name": "10% rollout on day 1"
    }
  ]
}
'

201

{
  "_id": "12ab3c4d5ef1a2345bcde67f",
  "_version": 1,
  "_conflicts": [
    {
      "stageId": "12ab3c4d5ef1a2345bcde67f",
      "message": "<string>"
    }
  ],
  "_creationDate": "1654104600000",
  "_maintainerId": "12ab3c45de678910abc12345",
  "_links": {},
  "name": "Progressive rollout starting in two days",
  "_execution": "{\"status\": \"completed\"}",
  "description": "Turn flag on for 10% of customers each day",
  "kind": "custom",
  "stages": [
    {
      "_id": "12ab3c45de678910abc12345",
      "conditions": [
        {
          "_execution": {
            "status": "completed"
          },
          "id": "12ab3c45de678910abc12345",
          "kind": "schedule",
          "scheduleKind": "relative",
          "waitDuration": 2,
          "waitDurationUnit": "calendarDay"
        }
      ],
      "action": "{ \"kind\": \"patch\", \"instructions\": [{ \"kind\": \"turnFlagOn\"}] }",
      "_execution": "{ \"status\": \"completed\" }",
      "name": "10% rollout on day 1"
    }
  ],
  "meta": {
    "parameters": [
      {
        "_id": "<string>",
        "path": "<string>",
        "default": {
          "value": "<unknown>",
          "booleanVariationValue": true,
          "ruleClause": {
            "attribute": "<string>",
            "op": "in",
            "negate": true
          }
        },
        "valid": true
      }
    ]
  },
  "templateKey": "example-workflow-template"
}

Authorizations

Authorization · string · header · required

Path Parameters

projectKey · string<string> · required

The project key

featureFlagKey · string<string> · required

The feature flag key

environmentKey · string<string> · required

The environment key

Query Parameters

templateKey · string<string>

The template key to apply as a starting point for the new workflow

dryRun · boolean

Whether to call the endpoint in dry-run mode

Body

application/json

name · string · required

The workflow name

Example:

"Progressive rollout starting in two days"

maintainerId · string

The ID of the workflow maintainer. Defaults to the workflow creator.

Example:

"12ab3c45de678910abc12345"

description · string

The workflow description

Example:

"Turn flag on for 10% of users each day"

stages · object[]

A list of the workflow stages

Show child attributes

templateKey · string

The template key

Response

201

application/json

Workflow response

_id · string · required

The ID of the workflow

Example:

"12ab3c4d5ef1a2345bcde67f"

_version · integer · required

The version of the workflow

Example:

1

_conflicts · object[] · required

Any conflicts that are present in the workflow stages

Show child attributes

_creationDate · integer<int64> · required

Timestamp of when the workflow was created

Example:

"1654104600000"

_maintainerId · string · required

The member ID of the maintainer of the workflow. Defaults to the workflow creator.

Example:

"12ab3c45de678910abc12345"

_links · object · required

The location and content type of related resources

Show child attributes

name · string · required

The name of the workflow

Example:

"Progressive rollout starting in two days"

_execution · object · required

The current execution status of the workflow

Show child attributes

Example:

"{\"status\": \"completed\"}"

description · string

A brief description of the workflow

Example:

"Turn flag on for 10% of customers each day"

kind · string

The kind of workflow

Example:

"custom"

stages · object[]

The stages that make up the workflow. Each stage contains conditions and actions.

Show child attributes

meta · object

For workflows being created from a workflow template, this value holds any parameters that could potentially be incompatible with the current project, environment, or flag

Show child attributes

templateKey · string

For workflows being created from a workflow template, this value is the template's key

Example:

"example-workflow-template"