Webhooks

Webhooks are an easy way to receive push notifications in your app about new events that happen within Aikido.

How to set up

Webhooks can be set up by admins via the integration settings page and then clicking on 'Webhooks' at the bottom, or via this link.

Notifications

Aikido will execute a POST request to the provided target URL for the configured events. The POST body of the request will look like this:

{
    "event_type": "issue.open.created",
    "created_at": 1703243502,
    "dispatched_at": 1703243502,
    "workspace_id": 123,
    "payload": {
        "issue_id": 1,
        "type": "open_source",
        "severity_score": 90,
        "severity": "critical",
        "status": "open"
    }
}

event_type: the type of event (STRING) can be one of following: 'issue.open.created', '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', 'issue.unignored', 'issue.severity.changed.manual'

created_at: a timestamp of when the event was created (INT)
dispatched_at: a timestamp of when the webhook request was dispatched (INT)

payload.issue_id: the ID of the issue (INT)
payload.type: issue type, can be one of 'open_source', 'leaked_secret', 'cloud', 'iac', 'sast', 'surface_monitoring', 'malware' (STRING)
payload.severity_score: the severity score of the issue, a numeric value between 1 and 100 (INT)
payload.severity: the severity of the issue, can be one of 'critical', 'high', 'medium' or 'low' (STRING)
payload.status: the current status of the issue, will always be 'open' for this event type (STRING)

Delivery

Aikido will attempt to re-submit the notification 5 times if the request is not successfull. A request is deemed unsuccessful if HTTP status other than 200 is returned or if a timeout occurs. Aikido will always send the webhook requests from the following ip address: 52.18.113.172.