웹훅 이벤트 및 페이로드

웹훅은 application/json의 Content-Type과 함께 전달되며, 이벤트 페이로드는 요청 본문에 JSON 형식으로 포함됩니다. 또한 다음과 같은 헤더를 함께 보냅니다.

• X-Snyk-Event - 이벤트 이름

• X-Snyk-Transport-ID - 이 전송을 식별하기 위한 GUID

• X-Snyk-Timestamp - 이벤트가 발생한 시간의 ISO 8601 타임스탬프 (예: 2020-09-25T15:27:53Z)

• X-Hub-Signature - 요청 본문의 HMAC 헥스 다이제스트(hex digest)로, 웹훅을 보호하고 요청이 실제로 Snyk에서 온 것임을 보장하는 데 사용됩니다.

• User-Agent - 요청의 출처를 식별합니다 (예: Snyk-Webhooks/XXX)

서버가 페이로드를 받도록 구성된 후에는 구성한 엔드포인트로 전송되는 모든 페이로드를 수신 대기합니다. 보안상의 이유로 Snyk에서 오는 요청으로만 제한해야 합니다.

웹훅 이벤트를 소비하는 동안 X-Snyk-Event 헤더를 반드시 확인해야 합니다. 엔드포인트는 설명된 대로 여러 이벤트 유형을 수신할 수 있기 때문입니다.

ping

ping 이벤트는 새로운 웹훅이 생성된 후에 발생하며, 웹훅 핑 API를 사용하여 수동으로 트리거할 수도 있습니다. 이는 웹훅이 Snyk으로부터 데이터를 올바르게 수신하는지 테스트하는 데 유용합니다.

ping 이벤트는 다음과 같은 요청을 수행합니다.

POST /webhook-handler/snyk123 HTTP/1.1
Host: my.app.com
X-Snyk-Event: ping/v0
X-Snyk-Transport-ID: 998fe884-18a0-45db-8ae0-e379eea3bc0a
X-Snyk-Timestamp: 2020-09-25T15:27:53Z
X-Hub-Signature: sha256=7d38cdd689735b008b3c702edd92eea23791c5f6
User-Agent: Snyk-Webhooks/044aadd
Content-Type: application/json
{
  "webhookId": "d3cf26b3-2d77-497b-bce2-23b33cc15362"
}

project_snapshot

이 이벤트는 기존 프로젝트가 테스트되고 새로운 스냅샷이 생성될 때마다 트리거됩니다. 새로운 문제의 발생 여부와 관계없이 프로젝트의 모든 테스트 시 트리거됩니다. 이 이벤트는 새로운 프로젝트가 생성되거나 가져올(Import) 때는 트리거되지 않습니다. 현재 지원되는 대상/스캔 유형은 오픈소스 및 컨테이너입니다.

POST /webhook-handler/snyk123 HTTP/1.1
Host: my.app.com
X-Snyk-Event: project_snapshot/v0
X-Snyk-Transport-ID: 998fe884-18a0-45db-8ae0-e379eea3bc0a
X-Snyk-Timestamp: 2020-09-25T15:27:53Z
X-Hub-Signature: sha256=7d38cdd689735b008b3c702edd92eea23791c5f6
User-Agent: Snyk-Webhooks/044aadd
Content-Type: application/json
{
  "project": { ... }, // API 응답과 일치하는 프로젝트 객체
  "org": { ... }, // API 응답과 일치하는 조직 객체
  "group": { ... }, // API 응답과 일치하는 그룹 객체
  "newIssues": [], // API 응답과 일치하는 새로운 문제 객체 배열
  "removedIssues": [], // API 응답과 일치하는 제거된 문제 객체 배열
}

페이로드 상세 예시

프로젝트

프로젝트 (v1) API를 참조하십시오.

"project": {
  "name": "snyk/goof",
  "id": "af137b96-6966-46c1-826b-2e79ac49bbd9",
  "created": "2018-10-29T09:50:54.014Z",
  "origin": "github",
  "type": "maven",
  "readOnly": false,
  "testFrequency": "daily",
  "totalDependencies": 42,
  "issueCountsBySeverity": {
    "low": 13,
    "medium": 8,
    "high": 4,
    "critical": 5
  },
  "imageId": "sha256:caf27325b298a6730837023a8a342699c8b7b388b8d878966b064a1320043019",
  "imageTag": "latest",
  "imageBaseImage": "alpine:3",
  "imagePlatform": "linux/arm64",
  "imageCluster": "Production",
  "hostname": null,
  "remoteRepoUrl": "https://github.com/snyk/goof.git",
  "lastTestedDate": "2019-02-05T08:54:07.704Z",
  "browseUrl": "https://app.snyk.io/org/4a18d42f-0706-4ad0-b127-24078731fbed/project/af137b96-6966-46c1-826b-2e79ac49bbd9",
  "importingUser": {
    "id": "e713cf94-bb02-4ea0-89d9-613cce0caed2",
    "name": "[email protected]",
    "username": "exampleUser",
    "email": "[email protected]"
  },
  "isMonitored": false,
  "branch": null,
  "targetReference": null,
  "tags": [
    {
      "key": "example-tag-key",
      "value": "example-tag-value"
    }
  ],
  "attributes": {
    "criticality": [
      "high"
    ],
    "environment": [
      "backend"
    ],
    "lifecycle": [
      "development"
    ]
  },
  "remediation": {
    "upgrade": {},
    "patch": {},
    "pin": {}
  }
}

조직

조직 (v1) API를 참조하십시오.

"org": {
  "name": "My Org",
  "id": "a04d9cbd-ae6e-44af-b573-0556b0ad4bd2",
  "slug": "my-org",
  "url": "https://api.snyk.io/v1/org/my-org",
  "created": "2020-11-18T10:39:00.983Z"
}

그룹

그룹 (v1) API를 참조하십시오.

"group": {
  "name": "ACME Inc.",
   "id": "a060a49f-636e-480f-9e14-38e773b2a97f"
}

문제

{
  "id": "npm:ms:20170412",
  "issueType": "vuln",
  "pkgName": "ms",
  "pkgVersions": [
    "1.0.0"
  ],
  "issueData": {
    "id": "npm:ms:20170412",
    "title": "Regular Expression Denial of Service (ReDoS)",
    "severity": "low",
    "url": "https://snyk.io/vuln/npm:ms:20170412",
    "description": "Lorem ipsum",
    "identifiers": {
      "CVE": [],
      "CWE": [
        "CWE-400"
      ],
      "ALTERNATIVE": [
        "SNYK-JS-MS-10509"
      ]
    },
    "credit": [
      "Snyk Security Research Team"
    ],
    "exploitMaturity": "no-known-exploit",
    "semver": {
      "vulnerable": [
        ">=0.7.1 <2.0.0"
      ]
    },
    "publicationTime": "2017-05-15T06:02:45Z",
    "disclosureTime": "2017-04-11T21:00:00Z",
    "CVSSv3": "CVSS:3.0/AV:N/AC:H/PR:N/UI:N/S:U/C:N/I:N/A:L",
    "cvssScore": 3.7,
    "language": "js",
    "patches": [
      {
        "id": "patch:npm:ms:20170412:2",
        "urls": [
          "https://snyk-patches.s3.amazonaws.com/npm/ms/20170412/ms_071.patch"
        ],
        "version": "=0.7.1",
        "comments": [],
        "modificationTime": "2019-12-03T11:40:45.866206Z"
      }
    ],
    "nearestFixedInVersion": "2.0.0"
  },
  "isPatched": false,
  "isIgnored": false,
  "fixInfo": {
    "isUpgradable": false,
    "isPinnable": false,
    "isPatchable": true,
    "nearestFixedInVersion": "2.0.0"
  },
  "priority": {
    "score": 399,
    "factors": [
      {
        "name": "isFixable",
        "description": "Has a fix available"
      },
      {
        "name": "cvssScore",
        "description": "CVSS 3.7"
      }
    ]
  }
}