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 Types

Was this helpful?

Events

PreviousWebhooksNextAppendix

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 Types

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

webooks
API
EventsGet notified when changes occur.
Event TypesEvent Types that can be configured to send you alerts.