Skip to content

Auslöser-API

ENTWURF — Nur für interne Entwickler

Diese API-Referenz ist für interne Entwicklungsteams bestimmt.

Übersicht

Was es ist: Die Auslöser-API bietet Lesezugriff auf die verfügbaren Auslösertypen und deren Schemata. Auslöser definieren die Ereignisse, die Workflows starten.

Endpunkte

MethodePfadBeschreibungAuthentifizierung erforderlich
GET/api/v1/triggersAlle Auslöser auflistenJWT + API-Token
GET/api/v1/triggers/schemasAuslösertyp-Schemata abrufenJWT + API-Token

GET /api/v1/triggers

Alle verfügbaren Auslöser-Definitionen auflisten.

Anfrage:

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

Antwort (200):

json
[
  {
    "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

Die JSON-Schemata für alle Auslösertypen abrufen. Verwenden Sie diese Schemata, um die Konfigurationsoptionen für jeden Auslösertyp zu verstehen.

Anfrage:

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

Antwort (200):

json
{
  "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" }
    }
  }
}

Hydden Documentation and Training Hub