Snyk

Integrate and automate code security and scan for vulnerabilities.

Using the Snyk API with Trigger.dev

You can use Trigger.dev with any existing Node SDK or even just using fetch. Using io.runTask makes your Snyk background job resumable and appear in our dashboard.

Use io.runTask() and the official SDK or fetch.

Use our HTTP endpoint to subscribe to webhooks

Example code using Snyk

Below are some working code examples of how you can use Snyk with Trigger.dev. These samples are open source and maintained by the community, you can copy and paste them into your own projects.

Get user details from Snyk.A job that is triggered by a Snyk webhook.

1
import { TriggerClient, eventTrigger } from "@trigger.dev/sdk";
2
import z from "zod";
3
// Replace this URL with the actual API endpoint you want to call in Snyk
4
// https://docs.snyk.io/snyk-api/authentication-for-api
5
const endpointURL = `${process.env.SNYK_BASE_URL}/user/me`;
6
const createOrgEndpontUrl = `${process.env.SNYK_BASE_URL}/org`;
7

8
// Create request options
9
const requestOptions: RequestInit = {
10
  headers: {
11
    "Content-Type": "application/json; charset=utf-8",
12
    // You can find your token in your General Account Settings on
13
    // https://snyk.io/account/. See Authentication for API details.
14
    Authorization: `${process.env.SNYK_AUTH_TOKEN}`,
15
  },
16
};
17

18
client.defineJob({
19
  id: "snyk-get-my-user-details",
20
  name: "Snyk get my user details",
21
  version: "1.0.0",
22
  trigger: eventTrigger({
23
    name: "snyk-get-profile",
24
  }),
25
  run: async (payload, io, ctx) => {
26
    // Wrap an SDK call in io.runTask so it's resumable and displays in logs
27
    await io.runTask(
28
      "Get Snyk me user details",
29
      async () => {
30
        const response = await fetch(endpointURL, {
31
          method: "GET",
32
          ...requestOptions,
33
        });
34

35
        // Return the response body
36
        const res = await response.json();
37
        return res;
38
      },
39

40
      // Add metadata to improve how the task displays in the logs
41
      { name: "get snyk me user details", icon: "snyk" }
42
    );
43
  },
44
});
45

46
// Create organization in Snyk
47

48
// client.defineJob({
49
//   id: "snyk-create-org",
50
//   name: "Snyk create new organization",
51
//   version: "1.0.0",
52
//   trigger: eventTrigger({
53
//     name: "snyk-add-org",
54
//     schema: z.object({
55
//       name: z.string(),
56
//       groupId: z.string(),
57
//       sourceOrgId: z.string(),
58
//     }),
59
//   }),
60
//   run: async (payload, io, ctx) => {
61
//     // Wrap an SDK call in io.runTask so it's resumable and displays in logs
62
//     await io.runTask(
63
//       "Create Organization",
64
//       async () => {
65
//         // Make request using Fetch API
66
//         const response = await fetch(createOrgEndpontUrl, {
67
//           method: "POST",
68
//           ...requestOptions,
69
//           body: JSON.stringify(payload),
70
//         });
71

72
//         // Return the response body
73
//         const res = await response.json();
74
//         return res;
75
//       },
76

77
//       // Add metadata to improve how the task displays in the logs
78
//       { name: "create new organization in snyk", icon: "snyk" }
79
//     );
80
//   },
81
// });