---
title: "Add webhook"
method: POST
path: "/webhooks"
---

# Add webhook

`POST /webhooks`

## Request

- Base URL: `https://app.aikido.dev/api/public/v1`
- URL: `https://app.aikido.dev/api/public/v1/webhooks`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://app.aikido.io/api/oauth/token` scopes: `webhooks:write`

Add webhook

## Request body

- object
  - `target_url` string, required: The target url of the webhook
  - `event_type` 'issue.open.created' | 'issue.open.created.open_source' | 'issue.open.created.sast' | 'issue.snoozed' | 'issue.ignored.manual' | 'ci.gate.failed' | 'issue.closed' | 'ci.gate.passed' | 'issue.sla.breached' | 'zen.attack' | 'zen.attack_wave' | 'zen.outbound.discovered' | 'scan.image.finished' | 'scan.domain.finished' | 'issue.unignored' | 'issue.unignored.manual' | 'issue.severity.changed.manual' | 'configuration_issue.detected' | 'inbox.issues.request.created' | 'pentest.running' | 'pentest.paused' | 'pentest.finished' | 'pentest.failed' | 'pentest.cancelled', required: The event type of the webhook

## Response `200`

The webhook has been added

- object
  - `webhook_id` integer: The id of the webhook

---

[API](https://skmtc.dev/aikido/apis/aikido-security-api-documentation.md) - [All operations](https://skmtc.dev/aikido/apis/aikido-security-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/aikido/apis/aikido-security-api-documentation/revisions/da8691338133?raw)