Docs
Tutorials
Developer Program
Your apps
This automations page is moving! We've been working hard at building out our tools documentation at tools.slack.dev — the new home of our Deno Slack SDK and Slack CLI docs! You can start using the new docs today, but we'll keep the content on both sites up to date during the transition.
Learn more

Create approval request to update a feature flag's state

Connector functions are a new addition to Slack automations. We recommend understanding the systems and APIs you're integrating with before setup.

Facts

Create approval request to update a feature flag's state

Schema: Connectors.Launchdarkly.functions.CreateApprovalRequestUpdateFlag
Service: LaunchDarkly

Input parameters

Required parameters
launchdarkly_access_token
slack#/types/credential/oauth2
·Required
Determines whether this connector will use the credentials of the user starting the workflow or the credentials configured by an app collaborator. See the Authentication section on this page for details.

Example
{ credential_source: "END_USER" }
project_key
string
·Required
The key of the project in which to create a new request to update a feature flag

Example
"project-key-123abc"
feature_flag_key
string
·Required
The key of the feature flag that this update request is being created for

Example
"feature-123abc"
environment_key
string
·Required
The environment associated with this feature flag update approval request

Example
"env123-123abc"
feature_flag_state
string
·Required
The state to associate with this feature flag request

Example
One of: "turnFlagOn", "turnFlagOff"
description
string
·Required
A brief description of this change

Example
"Enable rollout to area 3"
Optional parameters
notify_teams
array
·Optional
An array of keys for teams that should be notified to review this request
notify_members
array
·Optional
An array of member IDs that should be notified to review this request
comment
string
·Optional
Comments that should be included with this request to notified teams and members

Output parameters

Required parameters
id
string
·Required
Approval request identifier
review_status
string
·Required
Approval request review status
key
string
·Required
Feature flag key
environment_key
string
·Required
Environment key
description
string
·Required
Approval request description
comment
string
·Required
Approval request comment
feature_flag_state
string
·Required
Feature flag state

Authentication

A connector's access token property specifies how the connector handles authentication.

End-user authentication

user Workflows that include a connector function relying on end-user authentication can can only be started with a link trigger.

launchdarkly_access_token: {
    credential_source: "END_USER"
}

End-user experience: User will be prompted to link their external account via OAuth when they first start the workflow that contains this connector.

Developer experience: Developer does not have to implement authentication in app.

How to use

First, import Connectors from deno-slack-hub into your project's import_map.json file, like this:

{
  "imports": {
    "deno-slack-hub/": "https://deno.land/x/deno_slack_hub@2.2.0/",
    "deno-slack-sdk/": "https://deno.land/x/deno_slack_sdk@2.14.2/",
    "deno-slack-api/": "https://deno.land/x/deno_slack_api@2.8.0/",
  }
}

Next, import Connectors at the top of your workflow's definition file:

// my_workflow_file.ts
import { Connectors } from "deno-slack-hub/mod.ts";

Finally, add the connector as a step in your workflow just like you would a built-in Slack function.

SomeWorkflow.addStep(
  Connectors.Launchdarkly.functions.CreateApprovalRequestUpdateFlag, {
  //...

🧙🏼 Your admin may need to approve the connector first. If your workspace has been configured to only allow admin-approved apps, the CLI will prompt you to send an admin approval request the first time you try to use a connector that hasn't been approved by an admin yet. While waiting for admin approval, the CLI may report an error like this:

Workflow function... is referring to an unknown step output parameter...

You can safely ignore this error; it will go away as soon as your workspace admin approves your request to use the connector.

Which API is right for me?
We'll help you make decisions based on your goals and our capabilities.