# Events (Archive)

Events are an important concept and are used in [webooks](https://docs.halosecurity.com/api/webhooks) and the [API](https://docs.halosecurity.com/api/endpoints/event).

Learn more about events and managing them within your account:

{% embed url="<https://docs.halosecurity.com/docs/platform/events>" %}

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