Support Snyk Learn API reference Product updates Sign up for free

Slack

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

PreviousSlackSettings NextSnapshots (v1)

Last updated 6 months ago

Was this helpful?

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.

get

/orgs/{org_id}/slack_app/{tenant_id}/channels

Authorizations

Path parameters

org_idstring · uuidrequired

Org ID

tenant_idstring · uuidrequired

Tenant ID

Query parameters

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 · min: 10 · max: 1000 · default: 1000

Number of results to return per page

Example: 100

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/{tenant_id}/channels?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

409

500

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

List of Slack channels

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.

get

/orgs/{org_id}/slack_app/{tenant_id}/channels/{channel_id}

Authorizations

Path parameters

org_idstring · uuidrequired

Org ID

channel_idstring · urirequired

Slack Channel ID

tenant_idstring · uuidrequired

Tenant 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/{tenant_id}/channels/{channel_id}?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

409

500

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

List of Slack channels