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.

Update a target in a segment

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

Facts

Update a target in a segment

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

Input parameters

Required parameters
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" }
The key of the project in which the feature flag containing the target segment to update is located

Example
"project-key-123abc"
The environment associated with this feature flag

Example
"env123-123abc"
The key of the target segment to update

Example
"123abc"
The kind of target segment operation for this update

Example
One of: "addIncludedTargets", "removeIncludedTargets", "addExcludedTargets", "removeExcludedTargets"
The target type (e.g., the context) associated with the target operation

Example
"mytype-abc123"
The target key to associate with this update

Example
"feat-t3-abc987"
Optional parameters
A comment associated with this update

Output parameters

Required parameters
Segment name
Segment description
Segment key
Environment key
Update target comment
Target operation type

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.UpdateTargetSegment, {
  //...

🧙🏼 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.