LogoLogo
DocsSupportDashboard
  • Introduction
    • Data Types
    • Target Filtering
    • Scan Selection
    • Pagination & Sorting
    • Permissions
    • Appendix
  • Authentication
  • Webhooks
  • Events
  • Appendix
    • Targets Filter
    • Date Match
    • IP Range
  • Endpoints
    • Discovery
    • Target
    • Scan
    • Issue
    • Tag
    • Port
    • DNS
    • HTTP
    • Whois
    • Technology
    • Website
    • Acknowledged
    • Event
    • Dark Web
    • Integration
    • PCI
    • Report
    • User
    • Account
    • Security
    • File
    • Work
Powered by GitBook

© 2024 Halo Security

On this page
  • Standard response format
  • Example data
  • Events List

Was this helpful?

Events (Archive)

Last updated 6 months ago

Was this helpful?

Events are an important concept and are used in and the .

Learn more about events and managing them within your account:

Standard response format

Events return JSON data with several standard fields, as well as event-specific fields that are detailed in the documentation for that event. These standard fields are the following:

FIeld
Type
Description

event_id

string

ID of the event that was triggered

subject

string

Description of the event

key

string

Key name of the event

url

string

URL to access the event ID

Example data

An example of the standard response returned by an Event

{
    "event_id": "202201010112004328b91bcffff5941efffffa426450d098f",
    "subject": "Subject",
    "key": "key-name",
    "url": "https://www.halosecurity.com/link?q=user-event&id=202201010112004328b91bcffff5941efffffa426450d098f"
}

Events List

There are many kinds of events. Each kinds has a distinct key that you can use to filter events or configure integrations. The full list is below:

Key
Subject

API Key Added

User Added

Domain Added

New Domain Host Discovered

Scan Complete

First Scan Complete

Scan Started

New Domain TLD Discovered

Firewall Port Banner Changed

Firewall Port Opened

New Issue Detected

Network Added

New Network IP Discovered

Network IP Offline

New Network Port Discovered

Network Port Closed

Scan Complete

First Scan Complete

Scan Started

PCI Report Approved

PCI Report Has Expired

PCI Report Expires Soon

PCI Report Expires Today

PCI Report Rejected

Project Engineer Assigned

Project File Attached

Project State Changed

Target Added

Scan Failed

Scan Complete

First Scan Complete

Scan Started

New Technology

New Technology (First Scan)

SSL Certificate Expired

SSL Certificate Expiring

SSL Certificate New Country

SSL Certificate New Issuer

SSL Certificate Risk

Monitored Website Cookie Changed

Website Cookie New Country

Website Cookie Out-of-Scope

Website Cookie Risk

Monitored Website Download Changed

Website Download New Country

Website Download Out-of-Scope

Website Download Risk

Monitored Website Form Changed

Website Form New Country

Website Form Out-of-Scope

Website Form Risk

Monitored Website Header Changed

Website Header Risk

Website Link New Country

Website Link New Email

Website Link New Phone

Website Link Out-of-Scope

Website Link Risk

Monitored Website Script Changed

Website Script New Country

Website Script Out-of-Scope

Website Script Risk

Website Traffic New Country

Website Traffic Out-of-Scope

Domain Registration Changes

Domain Registration Expired

Domain Registration Expiring

account-apikey-add
account-user-add
domain-add
domain-host-add
domain-scan-finish
domain-scan-first
domain-scan-start
domain-tld-add
firewall-banner-change
firewall-port-add
issue-add
network-add
network-ip-add
network-ip-remove
network-port-add
network-port-remove
network-scan-finish
network-scan-first
network-scan-start
pci-report-approved
pci-report-expire-past
pci-report-expire-soon
pci-report-expire-today
pci-report-rejected
project-engineer
project-file
project-state
target-add
target-scan-failed
target-scan-finish
target-scan-first
target-scan-start
technology-add
technology-add-first-scan
website-cert-expired
website-cert-expiring
website-cert-new-country
website-cert-new-issuer
website-cert-risk
website-cookie-monitor-change
website-cookie-new-country
website-cookie-oos
website-cookie-risk
website-download-monitor-change
website-download-new-country
website-download-oos
website-download-risk
website-form-monitor-change
website-form-new-country
website-form-oos
website-form-risk
website-header-monitor-change
website-header-risk
website-link-new-country
website-link-new-email
website-link-new-phone
website-link-oos
website-link-risk
website-script-monitor-change
website-script-new-country
website-script-oos
website-script-risk
website-traffic-new-country
website-traffic-oos
website-whois-change
website-whois-expired
website-whois-expiring
webooks
API
EventsHalo Security Docs
Logo