Zapier와 Snyk 웹훅 사용 방법

Snyk API v1 문서는 참조(Reference)에 있습니다.

​통합 예시

Zapier에서 새로운 Zap을 생성합니다.

트리거

요청 헤더에 액세스하려면 Catch Raw Hook 트리거를 생성합니다. 이 트리거는 요청 페이로드를 문자열로 제공하므로 JSON으로 파싱해야 합니다.

요청을 보낼 웹훅 URL을 받게 됩니다.

your-url URL을 사용하여 Snyk에서 API를 통해 웹훅을 생성합니다.

POST /api/v1/org/{orgId}/webhooks HTTP/2
> Host: snyk.io
> Authorization: token {authToken}
> Content-Type: application/json
| {
|   "url": "https://hooks.zapier.com/hooks/catch/9002958/oemlgkz/",
|   "secret": "my-secret-string"
| }

API는 새로운 웹훅 정보를 응답합니다.

< HTTP/2 200 
< Content-Type: application/json
| {
|   "id": "{webhookId}",
|   "url": "https://hooks.zapier.com/hooks/catch/9002958/oemlgkz/",
| }

웹훅에 핑(Ping)을 보내 Zapier 트리거를 테스트할 수 있습니다.

> POST /api/v1/org/{orgId}/webhooks/{webhookId}/ping HTTP/2
> Host: snyk.io
> Authorization: token {authToken}
> Content-Type: application/json

목록에서 핑 요청을 선택하고 필드를 매핑합니다.

작업 (페이로드 검증)

페이로드를 검증하기 위한 JS 작업을 생성합니다.

"Code by Zapier" → "Run Javascript"

headers['X-Hub-Signature']와 payload string을 스니펫 변수에 매핑합니다.

이 스니펫은 Zap 필드에 isValid: boolean 변수를 추가합니다.

my-secret-string 문자열을 웹훅의 시크릿 문자열로 바꿉니다.

const crypto = require('crypto');
const secret = "my-secret-string";

function makeSignature(body, secret) {
  const hmac = crypto.createHmac('sha256', secret);
  hmac.update(body, 'utf8');

  return `sha256=${hmac.digest('hex')}`;
}

try {
  const body = JSON.parse(inputData.body);
  const { project, org, group, newIssues } = body;

  output = { 
    isValid: inputData.signature === makeSignature(inputData.body, secret)
  };
} catch (err) {
  output = { isValid: false, err: err.message };
}

스니펫을 테스트하고 isValid === true인지 확인합니다.

작업 (페이로드 파싱)

페이로드 문자열을 Zapier에서 사용하는 형식으로 파싱하기 위한 또 다른 작업을 생성합니다.

동일하게 JS 작업을 생성합니다.

**"Code by Zapier" → "Run Javascript"**를 선택하고 다음과 같이 필드를 매핑합니다.

그리고 다음 JS 스니펫을 사용합니다.

try {
  output = JSON.parse(inputData.body);
} catch (err) {
  output = { err: err.message };
}

요청 페이로드를 파싱하고 Zap 변수에 매핑합니다.

작업 (문제 형식 지정)

새로운 문제(New issues)는 객체 목록입니다. Zapier는 문자열 목록을 필요로 합니다. newIssues를 string[] 형식으로 변환합니다.

JS 작업을 하나 더 생성합니다.

**"Code by Zapier" → "Run Javascript"**를 선택하고 다음 스니펫을 붙여넣습니다.

function formatIssue({ pkgName, pkgVersions, issueData }) {
  return `
  <a href="${issueData.url}">${issueData.title}</a><br/>
  Vulnerability in ${pkgName} (${pkgVersions.join(', ')}). ${issueData.severity} severity.
`;
}

try {
  const { newIssues, ...body } = JSON.parse(inputData.body);

  output = { ...body, newIssues: newIssues.map(formatIssue) };
} catch (err) {
  output = { newIssues: [], err: err.message };
}

작업 (필터링)

모든 필드를 제공한 후, 해당 이벤트를 사용할지 결정합니다.

필터링을 위해 "Filter by Zapier" 앱을 생성합니다.

필터링 방법을 선택합니다.

작업 (알림 전송)

모든 필드에 액세스하여 알림 템플릿을 작성합니다. 이메일을 보내거나 다른 알림 유형을 선택합니다.