No results for ""
EXPAND ALL
  • Home
  • API docs

GIVE DOCS FEEDBACK

Approvals capability

Read time: 5 minutes
Last edited: May 01, 2024

Overview

This topic explains how to use the approvals integration framework capability.

About approvals

LaunchDarkly's approvals feature gives account members the ability to request approval for changes to feature flags in LaunchDarkly. To learn more, read about the Approvals feature workflow.

You can use the approval capability to specify third-party approval systems in LaunchDarkly. Once you enable them, these approval systems prevent changes to feature flags until an external approval process completes successfully.

The "Request ServiceNow approval" dialog.
The "Request ServiceNow approval" dialog.

Configuration

You can specify global configuration details, such as API keys and subdomains, using formVariables. Additionally, you can utilize the approval capability's environmentFormVariables and flagFormVariables properties to provide more granular configuration options.

The environment form variables property

The optional environmentFormVariables property provides an additional point of configuration for settings that are environment-specific. The settings appear as additional fields in the environment's "Approval settings" panel. To learn more, read Configuring approvals for an environment.

For example, the ServiceNow manifest uses environmentFormVariables to give members the ability to specify a different change request template for different environments.

The flag form variables property

The optional flagFormVariables property adds additional integration-specific fields to the "Request approval" dialog for members to complete each time they create an approval request. The flagFormVariables schema matches the schema for the global formVariables property.

Lifecycle requests

The approval capability makes several distinct requests to the third-party integration service throughout the lifecycle of a feature flag approval request.

These requests are as follows:

  • creationRequest
  • statusRequest
  • postApplyRequest
  • deletionRequest
  • memberListRequest

Here is a sequence diagram of the requests:

A sequence diagram of approval requests.
A sequence diagram of approval requests.

The creation request property

The creationRequest property describes the approval creation HTTP request and the parser it uses to process the JSON response.

The following fields specify the request and response parsing:

  • endpoint: A templatable URL, method, and set of headers. To learn more, read Endpoints.
  • (optional) jsonBody: A template string used to represent the JSON payload sent in the approval creation HTTP request.
  • (optional) parser: A mapping of property names to locations in the JSON response payload specified by a JSON pointer. To learn more, read Approval status parser.

The status request property

The statusRequest property describes the approval status check HTTP request and the parser it uses to determine if the approval should be considered approved or rejected.

The following fields specify the request and response parsing:

  • endpoint: A templatable URL, method, and set of headers. To learn more, read Endpoints.
  • (optional) jsonBody: A template string used to represent the JSON payload sent in the approval status HTTP request.
  • (optional) parser: A mapping of property names to locations in the JSON response payload specified by a JSON pointer. To learn more, read Approval status parser.

The post apply request property

The postApplyRequest property describes the HTTP request to make after you have applied the changes applied in LaunchDarkly.

The following fields specify the request and response parsing:

  • endpoint: A templatable URL, method, and set of headers. To learn more, read Endpoints.
  • (optional) jsonBody: A template string used to represent the JSON payload sent in the approval status HTTP request.
  • (optional) parser: A mapping of property names to locations in the JSON response payload specified by a JSON pointer. To learn more, read Approval status parser.

The deletion request property

The deletionRequest property describes the HTTP request to make after you have rejected the changes in LaunchDarkly.

The following fields specify the request and response parsing:

  • endpoint: A templatable URL, method, and set of headers. To learn more, read Endpoints.
  • (optional) jsonBody: A template string used to represent the JSON payload sent in the approval status HTTP request.
  • (optional) parser: A mapping of property names to locations in the JSON response payload specified by a JSON pointer. To learn more, read Approval status parser.

The member list request property

The memberListRequest describes the HTTP request used to fetch third-party member IDs and map them to LaunchDarkly members. LaunchDarkly makes this request immediately after configuring the integration.

The following fields specify the request and response parsing:

  • endpoint: A templatable URL, method and set of headers. To learn more, read Endpoints.
  • (optional) jsonBody: A template string used to represent the JSON payload sent in the approval status HTTP request.
  • (optional) parser: A mapping of property names to locations in the JSON response payload specified by a JSON pointer. To learn more, read Member list parser.

Approval parsers

There are two kinds of approval parsers: approval status parsers and member list parsers.

Approval status parser

You can use the approval status parser to retrieve and coerce relevant data from the approval capability's lifecycle requests.

The following properties specify this parser:

  • statusValue: The JSON pointer representation of a location in the HTTP response body that indicates the status of the approval request, typically numeric.
  • (optional) statusDisplay: The JSON pointer representation of a location in the HTTP response body that indicates the human-readable status of the approval request. If you do not specify statusDisplay, the LaunchDarkly UI will display the statusValue.
  • approvalMatcher: A regex pattern LaunchDarkly uses to determine if it should consider the parsed statusValue "approved."
  • (optional) rejectionMatcher: A regex pattern LaunchDarkly uses to determine if it should consider the parsed statusValue "rejected."
  • urlTemplate: A template string representing the canonical URL hosted on the third-party service.

Member list parser

You can use the member list parser to retrieve and coerce lists of third-party member IDs and email addresses. This list of member data is used to associate the third-party member with the LaunchDarkly member.

The following properties specify this parser:

  • memberArrayPath: The JSON pointer representation of a location in the HTTP response body that contains the list of member information.
  • memberItems: an object containing two required properties, email and memberId. These properties are JSON pointer representations of relative locations in a single-member item that correspond to the member's email address and ID, respectively.