Events
Events are an important concept and are used in webooks and the API.
Learn more about events and managing them within your account:
EventsGet notified when changes occur.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:
Event TypesEvent Types that can be configured to send you alerts.Last updated
Was this helpful?