Support Snyk Learn API reference Product updates Sign up for free

SlackSettings

This document uses the REST API. For more details, see the Authentication for API page.

PreviousServiceAccounts NextSlack

Last updated 6 months ago

Was this helpful?

Create new Slack notification default settings.

Create new Slack notification default settings for a given tenant.

post

/orgs/{org_id}/slack_app/{bot_id}

Authorizations

Path parameters

org_idstring uuidrequired

Org ID

bot_idstring uuidrequired

Bot ID

Query parameters

versionstringrequired

Requested API version

Example: 2021-06-04

Pattern:

^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$

Body

dataobjectrequired

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.snyk.io/rest/orgs/{org_id}/slack_app/{bot_id}?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{"data":{"attributes":{"severity_threshold":"high","target_channel_id":"slack://channel?team=team-id&id=channel-id"},"type":"slack"}}'

201

400

401

403

404

409

500

{
  "data": {
    "attributes": {
      "severity_threshold": "high",
      "target_channel_id": "slack://channel?team=team-id&id=channel-id",
      "target_channel_name": "channel-name"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "slack"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Default settings created successfully

Get Slack integration default notification settings.

Get Slack integration default notification settings for the provided tenant ID and bot ID.

get

/orgs/{org_id}/slack_app/{bot_id}

Authorizations

Path parameters

org_idstring uuidrequired

Org ID

bot_idstring uuidrequired

Bot ID

Query parameters

versionstringrequired

Requested API version

Example: 2021-06-04

Pattern:

^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.snyk.io/rest/orgs/{org_id}/slack_app/{bot_id}?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

409

500

{
  "data": {
    "attributes": {
      "severity_threshold": "high",
      "target_channel_id": "slack://channel?team=team-id&id=channel-id",
      "target_channel_name": "channel-name"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "slack"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Default settings created successfully

Remove the given Slack App integration

delete

/orgs/{org_id}/slack_app/{bot_id}

Authorizations

Path parameters

org_idstring uuidrequired

Org ID

bot_idstring uuidrequired

Bot ID

Query parameters

versionstringrequired

Requested API version

Example: 2021-06-04

Pattern:

^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.snyk.io/rest/orgs/{org_id}/slack_app/{bot_id}?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

400

401

403

404

409

500

No body

Slack App integration successfully removed

Slack notification settings overrides for projects

Slack notification settings overrides for projects. These settings overrides the default settings configured for the tenant.

get

/orgs/{org_id}/slack_app/{bot_id}/projects

Authorizations

Path parameters

org_idstring uuidrequired

Org ID

bot_idstring uuidrequired

Bot ID

Query parameters

versionstringrequired

Requested API version

Example: 2021-06-04

Pattern:

^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$

starting_afterstring

Return the page of results immediately after this cursor

Example: v1.eyJpZCI6IjEwMDAifQo=

ending_beforestring

Return the page of results immediately before this cursor

Example: v1.eyJpZCI6IjExMDAifQo=

limitinteger int32

Number of results to return per page

Example: 10

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.snyk.io/rest/orgs/{org_id}/slack_app/{bot_id}/projects?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

409

500

{
  "data": [
    {
      "attributes": {
        "is_active": true,
        "severity_threshold": "high",
        "target_channel_id": "slack://channel?team=team-id&id=channel-id",
        "target_channel_name": "channel-name",
        "target_project_name": "snyk/goof:package.json"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "slack"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
    "last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
    "next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
  }
}

Return default settings for a tenant

Create a new Slack settings override for a given project.

Create Slack settings override for a project.

post

/orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}

Authorizations

Path parameters

org_idstring uuidrequired

Org ID

project_idstring uuidrequired

Project ID

bot_idstring uuidrequired

Bot ID

Query parameters

versionstringrequired

Requested API version

Example: 2021-06-04

Pattern:

^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$

Body

dataobjectrequired

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.snyk.io/rest/orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{"data":{"attributes":{"severity_threshold":"high","target_channel_id":"slack://channel?team=team-id&id=channel-id"},"type":"slack"}}'

201

400

401

403

404

409

500

{
  "data": {
    "attributes": {
      "is_active": true,
      "severity_threshold": "high",
      "target_channel_id": "slack://channel?team=team-id&id=channel-id",
      "target_channel_name": "channel-name",
      "target_project_name": "snyk/goof:package.json"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "slack"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Project settings created successfully

Update Slack notification settings for a project.

patch

/orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}

Authorizations

Path parameters

org_idstring uuidrequired

Org ID

bot_idstring uuidrequired

Bot ID

project_idstring uuidrequired

Project ID

Query parameters

versionstringrequired

Requested API version

Example: 2021-06-04

Pattern:

^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$

Body

dataobject

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.snyk.io/rest/orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{"data":{"attributes":{"is_active":true,"severity_threshold":"high","target_channel_id":"slack://channel?team=team-id&id=channel-id"},"id":"123e4567-e89b-12d3-a456-426614174000","type":"slack"}}'

200

400

401

403

404

409

500

{
  "data": {
    "attributes": {
      "is_active": true,
      "severity_threshold": "high",
      "target_channel_id": "slack://channel?team=team-id&id=channel-id",
      "target_channel_name": "channel-name",
      "target_project_name": "snyk/goof:package.json"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "slack"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Slack notification settings for a project updated successfully.

Remove Slack settings override for a project.

delete

/orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}

Authorizations

Path parameters

org_idstring uuidrequired

Org ID

project_idstring uuidrequired

Project ID

bot_idstring uuidrequired

Bot ID

Query parameters

versionstringrequired

Requested API version

Example: 2021-06-04

Pattern:

^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.snyk.io/rest/orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

400

401

403

404

409

500

No body

Slack settings override for the project removed successfully.