> For the complete documentation index, see [llms.txt](https://docs.halosecurity.com/api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.halosecurity.com/api/events.md).

# Events

Events are an important concept and are used in [webooks](/api/webhooks.md) and the [API](/api/endpoints/event.md).

Learn more about events and managing them within your account:

{% content-ref url="/spaces/kK0z6zWWTnGhKH0ukjSP/pages/MtggX3t55b2BwW9thVOd" %}
[Events](https://docs.halosecurity.com/docs/platform/events)
{% endcontent-ref %}

## 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:

{% content-ref url="/spaces/kK0z6zWWTnGhKH0ukjSP/pages/YGPGI3DWhU93ht22TqCm" %}
[Event Types](https://docs.halosecurity.com/docs/platform/events/event-types)
{% endcontent-ref %}
