Events

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

Learn more about events and managing them within your account:

EventsHalo Security Docs

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
account-apikey-add	API Key Added
account-user-add	User Added
domain-add	Domain Added
domain-host-add	New Domain Host Discovered
domain-scan-finish	Scan Complete
domain-scan-first	First Scan Complete
domain-scan-start	Scan Started
domain-tld-add	New Domain TLD Discovered
firewall-banner-change	Firewall Port Banner Changed
firewall-port-add	Firewall Port Opened
issue-add	New Issue Detected
network-add	Network Added
network-ip-add	New Network IP Discovered
network-ip-remove	Network IP Offline
network-port-add	New Network Port Discovered
network-port-remove	Network Port Closed
network-scan-finish	Scan Complete
network-scan-first	First Scan Complete
network-scan-start	Scan Started
pci-report-approved	PCI Report Approved
pci-report-expire-past	PCI Report Has Expired
pci-report-expire-soon	PCI Report Expires Soon
pci-report-expire-today	PCI Report Expires Today
pci-report-rejected	PCI Report Rejected
project-engineer	Project Engineer Assigned
project-file	Project File Attached
project-state	Project State Changed
target-add	Target Added
target-scan-failed	Scan Failed
target-scan-finish	Scan Complete
target-scan-first	First Scan Complete
target-scan-start	Scan Started
technology-add	New Technology
technology-add-first-scan	New Technology (First Scan)
website-cert-expired	SSL Certificate Expired
website-cert-expiring	SSL Certificate Expiring
website-cert-new-country	SSL Certificate New Country
website-cert-new-issuer	SSL Certificate New Issuer
website-cert-risk	SSL Certificate Risk
website-cookie-monitor-change	Monitored Website Cookie Changed
website-cookie-new-country	Website Cookie New Country
website-cookie-oos	Website Cookie Out-of-Scope
website-cookie-risk	Website Cookie Risk
website-download-monitor-change	Monitored Website Download Changed
website-download-new-country	Website Download New Country
website-download-oos	Website Download Out-of-Scope
website-download-risk	Website Download Risk
website-form-monitor-change	Monitored Website Form Changed
website-form-new-country	Website Form New Country
website-form-oos	Website Form Out-of-Scope
website-form-risk	Website Form Risk
website-header-monitor-change	Monitored Website Header Changed
website-header-risk	Website Header Risk
website-link-new-country	Website Link New Country
website-link-new-email	Website Link New Email
website-link-new-phone	Website Link New Phone
website-link-oos	Website Link Out-of-Scope
website-link-risk	Website Link Risk
website-script-monitor-change	Monitored Website Script Changed
website-script-new-country	Website Script New Country
website-script-oos	Website Script Out-of-Scope
website-script-risk	Website Script Risk
website-traffic-new-country	Website Traffic New Country
website-traffic-oos	Website Traffic Out-of-Scope
website-whois-change	Domain Registration Changes
website-whois-expired	Domain Registration Expired
website-whois-expiring	Domain Registration Expiring