Triggers API

DRAFT — Internal Developer Use Only

This API reference is for internal development teams.

Overview

What it is: The triggers API provides read access to the available trigger types and their schemas. Triggers define the events that start workflows.

Endpoints

Method	Path	Description	Auth required
GET	/api/v1/triggers	List all triggers	JWT + API token
GET	/api/v1/triggers/schemas	Get trigger type schemas	JWT + API token

---

GET /api/v1/triggers

List all available trigger definitions.

Request:

GET /api/v1/triggers
Authorization: Bearer <token>

Response (200):

[
  {
    "id": "trigger-threat-score",
    "name": "Threat Score Threshold",
    "type": "threat-detection",
    "description": "Fires when an account threat score exceeds a threshold"
  },
  {
    "id": "trigger-new-account",
    "name": "New Account Discovered",
    "type": "collection",
    "description": "Fires when a new account is discovered during collection"
  }
]

---

GET /api/v1/triggers/schemas

Get the JSON schemas for all trigger types. Use these schemas to understand the configuration options for each trigger type.

Request:

GET /api/v1/triggers/schemas
Authorization: Bearer <token>

Response (200):

{
  "threat-detection": {
    "properties": {
      "threshold": { "type": "number", "minimum": 0, "maximum": 100 },
      "severity": { "type": "string", "enum": ["low", "medium", "high", "critical"] }
    }
  },
  "collection": {
    "properties": {
      "entityTypes": { "type": "array", "items": { "type": "string" } },
      "dataSourceId": { "type": "string" }
    }
  }
}