StackHawk Documentation StackHawk Logo HawkDocs

No results found

Try different keywords or check your spelling

Search documentation

Find guides, API references, and more

esc

Webhook

webhook

The Webhook integration sends HTTP POST requests to your API endpoints when StackHawk events occur. Use webhooks to connect StackHawk with internal tools, custom dashboards, or any service that accepts HTTP callbacks.

Configure webhooks to receive notifications for any of these events:

EventDescription
Scan StartedFires when a scan begins
Scan CompletedFires when a scan finishes successfully, includes findings data
Scan ErroredFires when a scan encounters an error
EventDescription
User ActivityFires on user actions within your organization, such as inviting users, adding API keys, modifying integrations, and more
Organization ActivityFires on organization-level events such as triaged alerts sent to third parties

Each webhook request includes a JSON payload with event details. You can configure custom authentication headers, filter by specific event types, and test webhooks before enabling them for production use.

  • A StackHawk account
  • A plan with the Webhook Integration enabled. Contact StackHawk Support to enable it.
  1. Log into StackHawk and navigate to the Webhook Integration page.
  2. Click Add Webhook. In the panel that opens, configure:
    • Name and Description
    • Scan Data For — select target application(s) or “All Applications”
    • Events — select which events trigger the webhook (e.g. Scan Started, Scan Completed, Scan Errored, User Activity, Organization Activity)
    • User Activity Types — optionally filter which user activities to receive (leave empty for all)
    • Organization Activity Types — optionally filter which organization activities to receive (leave empty for all)
    • Auth Header Name and Auth Header Value — optional authentication headers
    • Webhook Endpoint URL — your HTTPS endpoint
  3. Click Save. StackHawk sends a test payload and displays the response. Use Test to send additional test requests for debugging.
  4. Toggle the webhook to Enabled to start receiving live events.

Create Webhook Integration Screenshot

  • 44.227.38.189
  • 54.69.98.33
  • 44.227.81.160

Click the menu on any webhook to access management options:

ActionDescription
EditModify webhook settings, endpoint, or event triggers
Enable/DisableToggle whether the webhook receives live events
DeleteRemove the webhook permanently

Webhook Management Integration Screenshot

Enabled webhooks receive a JSON payload via HTTP POST for each triggered event. If you configured authentication headers, they are included in the request.

The Scan Completed payload includes:

  • Scan metadata (ID, application, environment, timestamps)
  • Findings with vulnerability details and affected paths
  • CompletedScanStats summary of findings by severity and triage status

Example payload:

{
  "service": "StackHawk",
  "scanCompleted": {
    "scan": {
      "id": "21a4f2da-740b-40d9-9557-696d8aca6a76",
      "hawkscanVersion": "4.0.0",
      "env": "Development",
      "status": "COMPLETED",
      "application": "Contosso",
      "startedTimestamp": "2021-05-18T00:26:41.892Z",
      "scanURL": "https://app.stackhawk.com/scans/21a4f2da-740b-40d9-9557-696d8aca6a76",
      "tags": [
        {
          "name": "category",
          "value": "${CATEGORY_FROM_ENV:default}"
        }
      ]
    },
    "scanDuration": "1",
    "spiderDuration": "33",
    "completedScanStats": {
      "urlsCount": "5",
      "duration": "34",
      "scanResultsStats": {
        "totalCount": "3",
        "lowCount": "2",
        "mediumCount": "0",
        "highCount": "0",
        "lowTriagedCount": "0",
        "mediumTriagedCount": "1",
        "highTriagedCount": "0"
      }
    },
    "findings": [
      {
        "pluginId": "10106",
        "pluginName": "HTTP Only Site",
        "severity": "Medium"