Webhooks (v1)

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

Create a webhook

post

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

Path parameters
orgIdstringRequired

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

Example: 4a18d42f-0706-4ad0-b127-24078731fbed
Body
all ofOptional
and
anyOptionalExample: {"url":"https://my.app.com/webhook-handler/snyk123","secret":"a8be22bb7bed43a3ac24de3580093560"}
Responses
200Success
application/json; charset=utf-8
Responseall of
and
anyOptionalExample: {"id":"d3cf26b3-2d77-497b-bce2-23b33cc15362","url":"https://my.app.com/webhook-handler/snyk123"}
post
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"
}
200Success
{
  "id": "d3cf26b3-2d77-497b-bce2-23b33cc15362",
  "url": "https://my.app.com/webhook-handler/snyk123"
}

List webhooks

get

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

Path parameters
orgIdstringRequired

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

Example: 4a18d42f-0706-4ad0-b127-24078731fbed
Header parameters
Content-Typestring · enumRequiredExample: application/json; charset=utf-8Possible values:
Responses
200Success
application/json; charset=utf-8
Responseall of
and
anyOptionalExample: {"results":[{"id":"d3cf26b3-2d77-497b-bce2-23b33cc15362","url":"https://my.app.com/webhook-handler/snyk123"}],"total":1}
get
GET /v1/org/{orgId}/webhooks HTTP/1.1
Host: api.snyk.io
Content-Type: application/json; charset=utf-8
Accept: */*
200Success
{
  "results": [
    {
      "id": "d3cf26b3-2d77-497b-bce2-23b33cc15362",
      "url": "https://my.app.com/webhook-handler/snyk123"
    }
  ],
  "total": 1
}

Retrieve a webhook

get

Required permissions

  • View Organization

  • View Outbound Webhooks

Path parameters
orgIdstringRequired

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

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

The webhook ID.

Example: 463c1ee5-31bc-428c-b451-b79a3270db08
Header parameters
Content-Typestring · enumRequiredExample: application/jsonPossible values:
Responses
200Success
application/json; charset=utf-8
Responseall of
and
anyOptionalExample: {"id":"d3cf26b3-2d77-497b-bce2-23b33cc15362","url":"https://my.app.com/webhook-handler/snyk123"}
get
GET /v1/org/{orgId}/webhooks/{webhookId} HTTP/1.1
Host: api.snyk.io
Content-Type: application/json
Accept: */*
200Success
{
  "id": "d3cf26b3-2d77-497b-bce2-23b33cc15362",
  "url": "https://my.app.com/webhook-handler/snyk123"
}

Delete a webhook

delete

Required permissions

  • View Organization

  • View Outbound Webhooks

  • Remove Outbound Webhooks

Path parameters
orgIdstringRequired

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

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

The webhook ID.

Example: 463c1ee5-31bc-428c-b451-b79a3270db08
Header parameters
Content-Typestring · enumRequiredExample: application/jsonPossible values:
Responses
200Success
delete
DELETE /v1/org/{orgId}/webhooks/{webhookId} HTTP/1.1
Host: api.snyk.io
Content-Type: application/json
Accept: */*
200Success

No content

Ping a webhook

post

Required permissions

  • View Organization

  • View Outbound Webhooks

Path parameters
orgIdstringRequired

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

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

The webhook ID.

Example: 463c1ee5-31bc-428c-b451-b79a3270db08
Header parameters
Content-Typestring · enumRequiredExample: application/jsonPossible values:
Responses
200Success
post
POST /v1/org/{orgId}/webhooks/{webhookId}/ping HTTP/1.1
Host: api.snyk.io
Content-Type: application/json
Accept: */*
200Success

No content

Last updated

Was this helpful?

Revision created

Add comment to emphasize required filters hidden in GitBook collapsed field