Webhooks (v1)

This document uses the v1 API. For more details, see the v1 API.

Create a webhook

Snyk sends a ping event to the newly configured webhook so you can check you're able to receive the transports.### Required permissions

• View Organization

• View Outbound Webhooks

• Create Outbound Webhooks

POSThttps://api.snyk.io/v1/org/{orgId}/webhooks

Path parameters

orgId*string

The organization ID to list projects for. The API_KEY must have access to this organization.

Example: "4a18d42f-0706-4ad0-b127-24078731fbed"

Body

application/json; charset=utf-8

urlstring

Webhooks can only be configured for URLs using the https protocol. http is not allowed.

secretstring

This is a password you create, that Snyk uses to sign our transports to you, so you be sure the notification is authentic. Your secret should: Be a random string with high entropy; Not be used for anything else; Only known to Snyk and your webhook transport consuming code;

any

Response

200

Body

application/json; charset=utf-8

id*string

url*string

any

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/v1/org/{orgId}/webhooks', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; charset=utf-8"
    },
    body: JSON.stringify({
      "url": "https://my.app.com/webhook-handler/snyk123",
      "secret": "a8be22bb7bed43a3ac24de3580093560"
    }),
});
const data = await response.json();

Response

200

{
  "id": "d3cf26b3-2d77-497b-bce2-23b33cc15362",
  "url": "https://my.app.com/webhook-handler/snyk123"
}

List webhooks

Snyk sends a ping event to the newly configured webhook so you can check you're able to receive the transports

Required permissions

• View Organization

• View Outbound Webhooks

GEThttps://api.snyk.io/v1/org/{orgId}/webhooks

Path parameters

orgId*string

The organization ID to list projects for. The API_KEY must have access to this organization.

Example: "4a18d42f-0706-4ad0-b127-24078731fbed"

Header parameters

Response

200

Body

application/json; charset=utf-8

results*array of Results6

total*integer (int32)

any

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/v1/org/{orgId}/webhooks', {
    method: 'GET',
    headers: {
      "Content-Type": "application/json; charset=utf-8"
    },
});
const data = await response.json();

Response

200

{
  "results": [
    {
      "id": "d3cf26b3-2d77-497b-bce2-23b33cc15362",
      "url": "https://my.app.com/webhook-handler/snyk123"
    }
  ],
  "total": 1
}

Retrieve a webhook

Required permissions

• View Organization

• View Outbound Webhooks

GEThttps://api.snyk.io/v1/org/{orgId}/webhooks/{webhookId}

Path parameters

orgId*string

The organization ID the project belongs to. The API_KEY must have access to this organization.

Example: "4a18d42f-0706-4ad0-b127-24078731fbed"

webhookId*string

The webhook ID.

Example: "463c1ee5-31bc-428c-b451-b79a3270db08"

Header parameters

Response

200

Body

application/json; charset=utf-8

id*string

url*string

any

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/v1/org/{orgId}/webhooks/{webhookId}', {
    method: 'GET',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

200

{
  "id": "d3cf26b3-2d77-497b-bce2-23b33cc15362",
  "url": "https://my.app.com/webhook-handler/snyk123"
}

Delete a webhook

Required permissions

• View Organization

• View Outbound Webhooks

• Remove Outbound Webhooks

DELETEhttps://api.snyk.io/v1/org/{orgId}/webhooks/{webhookId}

Path parameters

orgId*string

The organization ID the project belongs to. The API_KEY must have access to this organization.

Example: "4a18d42f-0706-4ad0-b127-24078731fbed"

webhookId*string

The webhook ID.

Example: "463c1ee5-31bc-428c-b451-b79a3270db08"

Header parameters

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/v1/org/{orgId}/webhooks/{webhookId}', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Ping a webhook

Required permissions

• View Organization

• View Outbound Webhooks

POSThttps://api.snyk.io/v1/org/{orgId}/webhooks/{webhookId}/ping

Path parameters

orgId*string

The organization ID the project belongs to. The API_KEY must have access to this organization.

Example: "4a18d42f-0706-4ad0-b127-24078731fbed"

webhookId*string

The webhook ID.

Example: "463c1ee5-31bc-428c-b451-b79a3270db08"

Header parameters

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/v1/org/{orgId}/webhooks/{webhookId}/ping', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();