Slack

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

Get a list of Slack channels

Requires the Snyk Slack App to be set up for this org, will retrieve a list of channels the Snyk Slack App can access. Note that it is currently only possible to page forwards through this collection, no prev links will be generated and the ending_before parameter will not function.

GEThttps://api.snyk.io/rest/orgs/{org_id}/slack_app/{tenant_id}/channels

Path parameters

org_id*string (uuid)

Org ID

tenant_id*string (uuid)

Tenant ID

Query parameters

Response

200400401403404409500

List of Slack channels

Headers

Body

application/vnd.api+json

data*array of SlackChannel (object)

jsonapi*JsonApi (object)

links*PaginatedLinks (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/slack_app/{tenant_id}/channels?version=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409500

{
  "data": [
    {
      "attributes": {
        "name": "general",
        "type": "public"
      },
      "id": "slack://channel?team=T123456&id=C123456",
      "type": "slack_channel"
    }
  ],
  "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"
  }
}

Get Slack Channel name by Slack Channel ID.

Requires the Snyk Slack App to be set up for this org. It will return the Slack channel name for the provided Slack channel ID.

GEThttps://api.snyk.io/rest/orgs/{org_id}/slack_app/{tenant_id}/channels/{channel_id}

Path parameters

org_id*string (uuid)

Org ID

channel_id*string (uri)

Slack Channel ID

tenant_id*string (uuid)

Tenant ID

Query parameters

Response

200400401403404409500

List of Slack channels

Headers

Body

application/vnd.api+json

data*SlackChannel (object)

jsonapi*JsonApi (object)

links*SelfLink (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/slack_app/{tenant_id}/channels/{channel_id}?version=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409500

{
  "data": {
    "attributes": {
      "name": "general",
      "type": "public"
    },
    "id": "slack://channel?team=T123456&id=C123456",
    "type": "slack_channel"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}