Notifications API

DRAFT — Internal Developer Use Only

This API reference is for internal development teams.

Overview

What it is: The notifications API provides access to the available notification event types that Discovery can emit. These events drive automation workflows and external integrations.

Endpoints

Method	Path	Description	Auth required
GET	/internal/v1/notification/events	List notification event types	JWT + API token

---

GET /internal/v1/notification/events

List all available notification event types.

Request:

GET /internal/v1/notification/events
Authorization: Bearer <token>

Response (200):

{
  "events": [
    {
      "type": "collection.completed",
      "description": "Fired when a data source collection run completes",
      "payload": ["dataSourceId", "entityCount", "status", "duration"]
    },
    {
      "type": "threat.detected",
      "description": "Fired when a new threat is detected for an identity",
      "payload": ["entityId", "threatScore", "ruleId", "severity"]
    },
    {
      "type": "account.discovered",
      "description": "Fired when a new account is discovered",
      "payload": ["accountId", "dataSourceId", "entityType"]
    },
    {
      "type": "certification.created",
      "description": "Fired when a new certification campaign is created",
      "payload": ["certificationId", "scope", "reviewerCount"]
    }
  ]
}