Snyk Apps

Support API docs Product updates Sign up for free

Search…

Snyk Apps

Introduction
Snyk Apps are in beta and only an App’s developer (Snyk Organization) can install the Snyk App they created. Snyk wants to learn more about what the community needs before launching the Snyk App marketplace.
Snyk Apps are integrations that extend the functionality of the Snyk platform, allowing you to create a Snyk experience to suit your specific needs. For example, a Snyk App might automate Snyk’s application security testing as part of a build tool. Another Snyk App might stream Snyk’s security testing results into an incident management tool.
The easiest way to start building a new Snyk App is to clone the Demo Snyk Apps GitHub repository. See Quickstart: clone the Snyk demo app.
See the Snyk Apps blog post for more details.
This document describes how to create a new Snyk App in the language of your choice, and can be used along with the API documentation (experimental) and Snyk OAuth2 API documentation.
Snyk Apps are based on the Snyk API, so that your integrations are inherently stable and secure.
Integrating Apps with Snyk
The Snyk Apps platform uses an OAuth 2.0 authorization flow. This allows your Snyk App to get an access token to act on a users’ behalf, depending on the scopes you request. There are many OAuth 2.0 libraries available that will greatly simplify the integration. The Snyk Apps Demo uses the popular JavaScript library passportjs.
See the Snyk OAuth2 API documentation for details.
How do Apps connect?
When a user authorizes a Snyk App, the user selects how to connect, to either an Organization (Org) or a Group (with access to either all or one of the Group's Orgs). The resulting connection is no longer tied to that specific user, so it is not bound by the user’s access or lifecycle but is linked to the Org’s lifecycle. You can read more about Orgs in What’s a Snyk organization and Groups in What's a Snyk group.
The scopes of an App determine which actions an App can perform while connected to a Snyk account. Currently, scopes are related to actions performed through Snyk Orgs, which determine the API endpoints that can be used in an App. Endpoints authorized through a Snyk Group are not yet supported. You can read more about scopes in Requesting scopes.
The final step of the integration process is to get the ID of the Snyk organization the user has authorized. This ID is needed to use most API endpoints, so the App must associate it with your user's account/workspace for future use.
Quickstart: clone the Snyk demo app
The easiest way to start building a new Snyk App is to clone the Demo Snyk Apps Github repository. You can either modify the demo to suit your App design or use it as a base for creating your own Snyk App.
See Getting started with Snyk Apps for more details.

Troubleshooting for Visual Studio Code extension

Getting started with Snyk Apps

Last modified 1mo ago

Export as PDF

Copy link

Edit on GitHub

Outline

Introduction

Integrating Apps with Snyk

How do Apps connect?

Quickstart: clone the Snyk demo app