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.

Create an issue

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

Facts

Create an issue

Schema:	`Connectors.AtlassianBitbucket.functions.CreateIssue`
Service:	Bitbucket

Input parameters

Required parameters

bitbucket_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" }

workspace

string

·Required

The ID of the workspace containing the repository where you wish to create a new issue

Example

"ABC12345-changeme"

repo_slug

string

·Required

The ID of the repository where you wish to create a new issue

Example

"DEF54321-changeme"

title

string

·Required

Title of the issue

Example

"Fix DB query latency"

description

string

·Required

Description of the issue

Example

"DB latency up 4s/query since adding cat gifs to all results"

assignee_uuid

string

·Required

The unique ID of the Bitbucket user to be assigned this issue

Example

"U123456-changeme"

Optional parameters

kind

string

·Optional

The specific kind of issue to create

priority

string

·Optional

The specific priority of the issue

Output parameters

Required parameters

issue_id

string

·Required

Issue ID

title

string

·Required

Title

kind

string

·Required

Kind

priority

string

·Required

Priority

issue_url

string

·Required

URL of the issue

Authentication

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

This connector only supports using the credentials of the user running the workflow, so the credential_source of this connector's access token parameter must be set to "END_USER".

End-user authentication

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

bitbucket_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.AtlassianBitbucket.functions.CreateIssue, {
    // The ID of the workspace containing the repository where you wish to create a new issue
    workspace: "ABC12345-changeme",

    // The ID of the repository where you wish to create a new issue
    repo_slug: "DEF54321-changeme",

    // Title of the issue
    title: "Fix DB query latency",

    // Description of the issue
    description: "DB latency up 4s/query since adding cat gifs to all results",

    // (Optional) The specific kind of issue to create
    // kind: "enhancement",

    // (Optional) The specific priority of the issue
    // priority: "blocker",

    // The unique ID of the Bitbucket user to be assigned this issue
    assignee_uuid: "U123456-changeme",

    bitbucket_access_token: { credential_source: "END_USER" }
  }
);

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