Ignore 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

Ignore an issue

Schema:	`Connectors.Snyk.functions.CreateIgnore`
Service:	Snyk

Input parameters

Required parameters

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

org_id

string

·Required

The ID of the organization

project_id

string

·Required

The ID of the project that contains the issue you wish to ignore

issue_id

string

·Required

The ID of the issue to ignore

reason_type

string

·Required

The specific reason why this issue is being ignored

Example

One of: "not-vulnerable", "wont-fix", "temporary-ignore"

disregard_if_fixable

boolean

·Required

Only ignore the issue if no upgrade or patch is available

Optional parameters

reason

string

·Optional

The reason for ignoring the issue

Output parameters

Required parameters

issue_id

string

·Required

Issue ID

reason_type

string

·Required

Reason Type

reason

string

·Required

Reason

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.

snyk_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@0.2.0/",
    "deno-slack-sdk/": "https://deno.land/x/deno_slack_sdk@2.7.0/",
    "deno-slack-api/": "https://deno.land/x/deno_slack_api@2.2.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.Snyk.functions.CreateIgnore, {
  //...

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