Snyk IssueTrigger

Snyk IssueTrigger
Certified
Trigger on new Snyk issues

Polls Snyk for issues and emits one execution for each newly detected issue.

yaml
type: io.kestra.plugin.snyk.IssueTrigger

Examples

Alert on new critical issues

yaml
id: snyk_alert_on_new_issues
namespace: company.security

triggers:
  - id: new_critical_issue
    type: io.kestra.plugin.snyk.IssueTrigger
    token: "{{ secret('SNYK_API_TOKEN') }}"
    orgId: "{{ secret('SNYK_ORG_ID') }}"
    severities:
      - CRITICAL
    interval: PT15M

tasks:
  - id: log_issue
    type: io.kestra.plugin.core.log.Log
    message: "New Snyk issue: {{ trigger.issueId }}"

Properties

orgId *string

Snyk organization ID

Snyk organization whose issues the trigger monitors.

token *string

Snyk API token

API token used to authenticate with Snyk. Store it as a Kestra secret.

allowConcurrent boolean

Defaultfalse

Specifies whether a trigger is allowed to start a new execution even if a previous run is still in progress.

apiVersion string

Default2024-10-15

Snyk REST API version

Snyk REST API version in YYYY-MM-DD format, optionally followed by a stability suffix. Defaults to 2024-10-15.

baseUrl string

Defaulthttps://api.snyk.io/rest

Snyk REST API base URL

Official regional Snyk REST API base URL. The default is https://api.snyk.io/rest.

interval string

DefaultPT15M

Formatduration

Polling interval

How often Snyk is polled (default PT15M). The trigger emits one execution per evaluation, so a backlog drains at one issue per interval.

options

HTTP client options

Optional HTTP settings such as timeouts, proxy, and TLS.

Definitions

io.kestra.core.http.client.configurations.HttpConfiguration

allowFailedbooleanstring

Defaultfalse

If true, allow a failed response code (response code >= 400)

allowedResponseCodesarray

SubTypeinteger

List of response code allowed for this request

auth

The authentication to use.

io.kestra.core.http.client.configurations.BasicAuthConfiguration

type*object

passwordstring

The password for HTTP basic authentication.

usernamestring

The username for HTTP basic authentication.

io.kestra.core.http.client.configurations.BearerAuthConfiguration

type*object

tokenstring

The token for bearer token authentication.

io.kestra.core.http.client.configurations.DigestAuthConfiguration

type*object

passwordstring

The password for HTTP Digest authentication.

usernamestring

The username for HTTP Digest authentication.

defaultCharsetstring

DefaultUTF-8

The default charset for the request.

java.nio.charset.Charset

enabledTcpExtendedKeepAlivebooleanstring

Defaulttrue

Whether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).

Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.

followRedirectsbooleanstring

Defaulttrue

Whether redirects should be followed automatically.

logsarray

SubTypestring

Possible Values

REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODY

The enabled log.

proxy

The proxy configuration.

io.kestra.core.http.client.configurations.ProxyConfiguration

addressstring

The address of the proxy server.

passwordstring

The password for proxy authentication.

portintegerstring

The port of the proxy server.

typestring

DefaultDIRECT

Possible Values

DIRECTHTTPSOCKS

The type of proxy to use.

usernamestring

The username for proxy authentication.

ssl

The SSL request options

io.kestra.core.http.client.configurations.SslOptions

insecureTrustAllCertificatesbooleanstring

Whether to disable checking of the remote SSL certificate.

Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.

timeout

The timeout configuration.

io.kestra.core.http.client.configurations.TimeoutConfiguration

connectTimeoutstring

The time allowed to establish a connection to the server before failing.

readIdleTimeoutstring

DefaultPT5M

The time allowed for a read connection to remain idle before closing it.

severities array

SubTypestring

Possible Values

CRITICALHIGHMEDIUMLOW

Optional severity filter

Severities to monitor. If omitted, issues of all severity levels are monitored.

stopAfter array

SubTypestring

Possible Values

CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

List of execution states after which a trigger should be stopped (a.k.a. disabled).

when string

Defaulttrue

A condition that determines whether the trigger should run.

A Pebble expression evaluated at trigger time. The trigger fires only when the expression evaluates to a truthy value (true, a non-empty string, a non-zero number). Use this to gate trigger execution on dynamic runtime values such as execution labels, flow variables, or environment conditions.

Outputs

issue object

Snyk issue

Complete JSON: API issue object returned by Snyk.

issueId string

Snyk issue ID

Identifier of the issue that caused this execution.