Webhooks (v1)
The Webhooks API is in beta. While the API is in beta, Snyk may change the API and the structure of webhook payloads at any time, without notice. During this beta, Webhooks are available only in the Snyk US-01, US-02, EU-01, and AU-01 regions.
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
The organization ID to list projects for. The API_KEY
must have access to this organization.
4a18d42f-0706-4ad0-b127-24078731fbed
{"url":"https://my.app.com/webhook-handler/snyk123","secret":"a8be22bb7bed43a3ac24de3580093560"}
{"id":"d3cf26b3-2d77-497b-bce2-23b33cc15362","url":"https://my.app.com/webhook-handler/snyk123"}
POST /v1/org/{orgId}/webhooks HTTP/1.1
Host: api.snyk.io
Content-Type: application/json; charset=utf-8
Accept: */*
Content-Length: 96
{
"url": "https://my.app.com/webhook-handler/snyk123",
"secret": "a8be22bb7bed43a3ac24de3580093560"
}
{
"id": "d3cf26b3-2d77-497b-bce2-23b33cc15362",
"url": "https://my.app.com/webhook-handler/snyk123"
}
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
The organization ID to list projects for. The API_KEY
must have access to this organization.
4a18d42f-0706-4ad0-b127-24078731fbed
application/json; charset=utf-8
Possible values: {"results":[{"id":"d3cf26b3-2d77-497b-bce2-23b33cc15362","url":"https://my.app.com/webhook-handler/snyk123"}],"total":1}
GET /v1/org/{orgId}/webhooks HTTP/1.1
Host: api.snyk.io
Content-Type: application/json; charset=utf-8
Accept: */*
{
"results": [
{
"id": "d3cf26b3-2d77-497b-bce2-23b33cc15362",
"url": "https://my.app.com/webhook-handler/snyk123"
}
],
"total": 1
}
Required permissions
-
View Organization
-
View Outbound Webhooks
The organization ID the project belongs to. The API_KEY
must have access to this organization.
4a18d42f-0706-4ad0-b127-24078731fbed
The webhook ID.
463c1ee5-31bc-428c-b451-b79a3270db08
application/json
Possible values: {"id":"d3cf26b3-2d77-497b-bce2-23b33cc15362","url":"https://my.app.com/webhook-handler/snyk123"}
GET /v1/org/{orgId}/webhooks/{webhookId} HTTP/1.1
Host: api.snyk.io
Content-Type: application/json
Accept: */*
{
"id": "d3cf26b3-2d77-497b-bce2-23b33cc15362",
"url": "https://my.app.com/webhook-handler/snyk123"
}
Required permissions
-
View Organization
-
View Outbound Webhooks
-
Remove Outbound Webhooks
The organization ID the project belongs to. The API_KEY
must have access to this organization.
4a18d42f-0706-4ad0-b127-24078731fbed
The webhook ID.
463c1ee5-31bc-428c-b451-b79a3270db08
application/json
Possible values: DELETE /v1/org/{orgId}/webhooks/{webhookId} HTTP/1.1
Host: api.snyk.io
Content-Type: application/json
Accept: */*
No content
Required permissions
-
View Organization
-
View Outbound Webhooks
The organization ID the project belongs to. The API_KEY
must have access to this organization.
4a18d42f-0706-4ad0-b127-24078731fbed
The webhook ID.
463c1ee5-31bc-428c-b451-b79a3270db08
application/json
Possible values: POST /v1/org/{orgId}/webhooks/{webhookId}/ping HTTP/1.1
Host: api.snyk.io
Content-Type: application/json
Accept: */*
No content
Last updated
Was this helpful?