List webhooks

List webhooks

get/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:read

Response

The list of created webhooks

idstring

The id of the webhook

target_urlstring

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'

The event type of the webhook

health_status'unknown' | 'failing' | 'success'

The health status of the webhook

latest_http_status_codeinteger

The latest http status code of the webhook

Example response

[
  {
    "id": 1,
    "target_url": "https://example.com/webhook",
    "event_type": "issue.open.created",
    "health_status": "success",
    "latest_http_status_code": 200
  },
  {
    "id": 2,
    "target_url": "https://example.com/webhook",
    "event_type": "issue.snoozed",
    "health_status": "failing",
    "latest_http_status_code": 400
  }
]

Changes

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