Skip to main content

create_issue

Facts

DescriptionCreate an issue
SchemaConnectors.GitHubEnterpriseServer.functions.CreateIssue
ServiceGitHub Enterprise Server

Input parameters

Required input parameters

github_enterprise_server_access_tokenslack#/types/credential/oauth2Required

GitHub Enterprise Access token. See the authentication section for details.

repositorystringRequired

The repository in which to create a new issue

Examples
lukerussell/salesapp
titlestringRequired

The title of the newly-created issue

Examples
GrammarBot Report

Optional input parameters

descriptionstringOptional

The description of the newly-created issue

Output parameters

Required output parameters

bodystringRequired

Description

issue_numberstringRequired

Issue number

issue_urlstringRequired

Issue URL

titlestringRequired

Issue title

Authentication

Required workspace environment variables

This connector relies on workspace environment variables for authentication.

Before adding this connector to a workflow, the following workspace environment variables need to be configured by a workspace admin:

  • GITHUB_ENTERPRISE_DOMAIN

Admins can set workspace environment variables for connectors that require them from within Workflow Builder, in the Manage Integrations section.

To open the Manage Integrations section, open Workflow Builder and access the additional options menu to the right of the Create Workflow button.

End-user authentication

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

{
  "github_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 the app.

Usage info

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

import_map.json
{
    "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 Slack function.

my_workflow_file.ts
SomeWorkflow.addStep(
  Connectors.GitHubEnterpriseServer.functions.CreateIssue, {
  //...

🧙🏼 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 X is referring to an unknown step output parameter Y

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