AIaikido

Add webhook

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

Request body

target_urlstring 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

Example request

{
  "target_url": "https://example.com/webhook",
  "event_type": "issue.open.created"
}

Response

The webhook has been added

webhook_idinteger

The id of the webhook

Example response

{
  "webhook_id": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.