Skip to main content

Checkmarx One API - Webhooks

Webhooks are used to trigger external activities when specified events occur in Checkmarx One (e.g., successful scan or failed scan). This makes it easy to integrate Checkmarx One into your CI/CD workflow.

The Webhooks APIs enable users to perform all CRUD activities on Webhooks. They are also used to get various types of data about the Webhooks in your account.

Webhooks Endpoints

The URL for Webhooks endpoints is <base_url>/api/webhooks

Endpoint Summary

The following is a list of Checkmarx One APIs that relate to Webhooks:

API

Method

Endpoint

Description

POST Project Webhook

POST

/api/webhooks/projects{project-id}

Create a webhook that is associated with the specified Project.

GET Project Webhooks

GET

/api/webhooks/projects{project-id}

Get a list of webhooks associated with the specified Project.

GET (Specific) Webhook

GET

/api/webhooks/{id}

Get a specific webhook.

PATCH Update Webhook

PATCH

/api/webhooks/{id}

Update a specific webhook.

DELETE Webhook

DELETE

/api/webhooks/{id}

Delete a webhook.

Swagger

To view these APIs in the Swagger UI and run sample API calls, go to <base_url>/spec/v1/ and select Webhooks in the definition field.