automationruleAPI-Referenz
GET
/v2/automationrule/catalogAutomationsmöglichkeiten und Kontoreferenzen lesen
Liest verfügbare Trigger, Kontextfelder, Datentypen, Operatoren und Aktionen sowie maximale Gruppentiefe/Anzahlen. Ohne trigger sind fields/actions nach Auslöser gruppiert, mit trigger flache Listen. account_options enthält die tatsächlich schreibbaren Benutzerfelder, geeignete E-Mail-Felder, Tags und zulässige E-Mail-/Teilnehmer-PDF-Vorlagen. Dynamische Kontofelder sind eine offene kontospezifische Konfiguration; gültige Referenzen aus diesem Katalog übernehmen. Kein Definitionsspeichern oder Ausführen. Regel-/Ausführungszeitstempel werden als ISO-8601-String oder null ausgegeben.
Operation-ID get_v2_automationrule_catalog
01
Vertrag & Verhalten
- Dokumentationsstand
- reviewed
- Ändert Zustand
- Nein
- Als readOnly markiert
- Ja
- Für Automation markiert
- Ja
GET-Verhalten laut Spezifikation
read
02
Authentifizierung
Eine der folgenden Alternativen muss erfüllt sein (ODER). Innerhalb jeder Alternative werden alle angegebenen Schemas gemeinsam benötigt (UND).
Alternative 1
bearerAuthhttp · bearerExisting edoobox v2 access token. Never substitute API key/secret headers.
Format: JWT
Security-Schema als JSON
{
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT",
"description": "Existing edoobox v2 access token. Never substitute API key/secret headers."
}accountContextapiKeySelected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.
header: edid
Security-Schema als JSON
{
"type": "apiKey",
"in": "header",
"name": "edid",
"description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}Alternative 2
sessionCookieapiKeyExisting browser login session, with the same permission checks as Bearer authentication.
cookie: _edlogin
Security-Schema als JSON
{
"type": "apiKey",
"in": "cookie",
"name": "_edlogin",
"description": "Existing browser login session, with the same permission checks as Bearer authentication."
}accountContextapiKeySelected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.
header: edid
Security-Schema als JSON
{
"type": "apiKey",
"in": "header",
"name": "edid",
"description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}03
Parameter
Query-Parameter
triggeroptionalAuslöser; bestimmt verfügbare Kontextfelder und Aktionen.
string
Erlaubte Werte
"api.post.user""api.post.booking""api.post.offer""communication.booking_confirmation.before_send""communication.certificate.before_send"Vollständiges Schema als JSON
{
"type": "string",
"enum": [
"api.post.user",
"api.post.booking",
"api.post.offer",
"communication.booking_confirmation.before_send",
"communication.certificate.before_send"
]
}Header
languageoptionalAccount language code, where the resource supports setLanguage().
string
Schema-Beispiel
"de"Vollständiges Schema als JSON
{
"type": "string",
"examples": [
"de"
]
}04
Request Body
Kein Request Body in der Spezifikation beschrieben.
05
Antworten
9HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.
200application/json
data enthält das dokumentierte Ergebnisobjekt bzw. die Ergebnisliste; error=false und success=true.
application/json
object
success boolean error boolean | string error_code string data object definition_version integer erforderlich triggers array erforderlich Array-Elemente
object
key string erforderlich contexts array erforderlich Array-Elemente
string
fields array erforderlich Array-Elemente
string
actions array erforderlich Array-Elemente
string
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
fields Typ nicht eingeschränkt erforderlich anyOf · Mindestens eine Variante muss passen
Variante 1 array Array-Elemente
object
key string erforderlich entity string erforderlich property string erforderlich data_type string erforderlich dynamic boolean source_key string label string input_type string enabled boolean read_only boolean Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Variante 2 array Array-Elemente
object
trigger string erforderlich fields array erforderlich Array-Elemente
object
key string erforderlich entity string erforderlich property string erforderlich data_type string erforderlich dynamic boolean source_key string label string input_type string enabled boolean read_only boolean Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
operators object erforderlich Schema für zusätzliche Felder
array
Array-Elemente
string
actions Typ nicht eingeschränkt erforderlich Array-Elemente
Typ nicht eingeschränkt
Normalisierte Aktion oder fehlerhafter Entwurfseintrag; Aktivierung erfordert vollständige Validierung.
anyOf · Mindestens eine Variante muss passen
Variante 1 Typ nicht eingeschränkt Variante 2 object | array | string | number | boolean | null anyOf · Mindestens eine Variante muss passen
Variante 1 array Array-Elemente
object
type string erforderlich contexts array Array-Elemente
string
contexts_any array Array-Elemente
string
execution string erforderlich Erlaubte Werte
"async""synchronous"parameters object erforderlich Schema für zusätzliche Felder
string
field_source string writable_fields array Array-Elemente
string
recipient_types array Array-Elemente
string
recipient_field_source string target_types array Array-Elemente
string
template_kind string template_compatibility string Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Variante 2 array Array-Elemente
object
trigger string erforderlich actions array erforderlich Array-Elemente
object
type string erforderlich contexts array Array-Elemente
string
contexts_any array Array-Elemente
string
execution string erforderlich Erlaubte Werte
"async""synchronous"parameters object erforderlich Schema für zusätzliche Felder
string
field_source string writable_fields array Array-Elemente
string
recipient_types array Array-Elemente
string
recipient_field_source string target_types array Array-Elemente
string
template_kind string template_compatibility string Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
limits object erforderlich group_depth integer erforderlich conditions integer erforderlich actions integer erforderlich Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
account_options object erforderlich user_data_fields array Array-Elemente
object
key string erforderlich entity string erforderlich property string erforderlich data_type string erforderlich dynamic boolean source_key string label string input_type string enabled boolean read_only boolean Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
user_writable_fields array Array-Elemente
object
key string erforderlich entity string erforderlich property string erforderlich data_type string erforderlich dynamic boolean source_key string label string input_type string enabled boolean read_only boolean Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
user_email_fields array Array-Elemente
object
key string erforderlich entity string erforderlich property string erforderlich data_type string erforderlich dynamic boolean source_key string label string input_type string enabled boolean read_only boolean Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
tags array Array-Elemente
object
id string erforderlich Öffentliche v2-ID aus dem aktuellen Konto.
- pattern
"^tag_[a-f0-9]{12}_-?[0-9]+$"
name string erforderlich value string erforderlich contexts array erforderlich Array-Elemente
string
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
email_templates array Array-Elemente
object
id string erforderlich Öffentliche v2-ID aus dem aktuellen Konto.
- pattern
"^et_[a-f0-9]{12}_-?[0-9]+$"
family_id string erforderlich Öffentliche v2-ID aus dem aktuellen Konto.
- pattern
"^emailtemplate_[a-f0-9]{12}_-?[0-9]+$"
name string erforderlich display_name string erforderlich type string erforderlich kind string erforderlich compatibility string erforderlich languages array erforderlich Array-Elemente
string
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
pdf_templates array Array-Elemente
object
id string erforderlich Öffentliche v2-ID aus dem aktuellen Konto.
- pattern
"^et_[a-f0-9]{12}_-?[0-9]+$"
family_id string erforderlich Öffentliche v2-ID aus dem aktuellen Konto.
- pattern
"^emailtemplate_[a-f0-9]{12}_-?[0-9]+$"
name string erforderlich display_name string erforderlich type string erforderlich kind string erforderlich compatibility string erforderlich languages array erforderlich Array-Elemente
string
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
type string Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Vollständiges Schema als JSON
{
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"error": {
"type": [
"boolean",
"string"
]
},
"error_code": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"definition_version": {
"type": "integer"
},
"triggers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"contexts": {
"type": "array",
"items": {
"type": "string"
}
},
"fields": {
"type": "array",
"items": {
"type": "string"
}
},
"actions": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true,
"required": [
"key",
"contexts",
"fields",
"actions"
]
}
},
"fields": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"entity": {
"type": "string"
},
"property": {
"type": "string"
},
"data_type": {
"type": "string"
},
"dynamic": {
"type": "boolean"
},
"source_key": {
"type": "string"
},
"label": {
"type": "string"
},
"input_type": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"read_only": {
"type": "boolean"
}
},
"additionalProperties": true,
"required": [
"key",
"entity",
"property",
"data_type"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"properties": {
"trigger": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"entity": {
"type": "string"
},
"property": {
"type": "string"
},
"data_type": {
"type": "string"
},
"dynamic": {
"type": "boolean"
},
"source_key": {
"type": "string"
},
"label": {
"type": "string"
},
"input_type": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"read_only": {
"type": "boolean"
}
},
"additionalProperties": true,
"required": [
"key",
"entity",
"property",
"data_type"
]
}
}
},
"additionalProperties": true,
"required": [
"trigger",
"fields"
]
}
}
]
},
"operators": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"actions": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"contexts": {
"type": "array",
"items": {
"type": "string"
}
},
"contexts_any": {
"type": "array",
"items": {
"type": "string"
}
},
"execution": {
"type": "string",
"enum": [
"async",
"synchronous"
]
},
"parameters": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"field_source": {
"type": "string"
},
"writable_fields": {
"type": "array",
"items": {
"type": "string"
}
},
"recipient_types": {
"type": "array",
"items": {
"type": "string"
}
},
"recipient_field_source": {
"type": "string"
},
"target_types": {
"type": "array",
"items": {
"type": "string"
}
},
"template_kind": {
"type": "string"
},
"template_compatibility": {
"type": "string"
}
},
"additionalProperties": true,
"required": [
"type",
"execution",
"parameters"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"properties": {
"trigger": {
"type": "string"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"contexts": {
"type": "array",
"items": {
"type": "string"
}
},
"contexts_any": {
"type": "array",
"items": {
"type": "string"
}
},
"execution": {
"type": "string",
"enum": [
"async",
"synchronous"
]
},
"parameters": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"field_source": {
"type": "string"
},
"writable_fields": {
"type": "array",
"items": {
"type": "string"
}
},
"recipient_types": {
"type": "array",
"items": {
"type": "string"
}
},
"recipient_field_source": {
"type": "string"
},
"target_types": {
"type": "array",
"items": {
"type": "string"
}
},
"template_kind": {
"type": "string"
},
"template_compatibility": {
"type": "string"
}
},
"additionalProperties": true,
"required": [
"type",
"execution",
"parameters"
]
}
}
},
"additionalProperties": true,
"required": [
"trigger",
"actions"
]
}
}
],
"items": {
"description": "Normalisierte Aktion oder fehlerhafter Entwurfseintrag; Aktivierung erfordert vollständige Validierung.",
"anyOf": [
{},
{
"type": [
"object",
"array",
"string",
"number",
"boolean",
"null"
]
}
]
}
},
"limits": {
"type": "object",
"properties": {
"group_depth": {
"type": "integer"
},
"conditions": {
"type": "integer"
},
"actions": {
"type": "integer"
}
},
"additionalProperties": true,
"required": [
"group_depth",
"conditions",
"actions"
]
},
"account_options": {
"type": "object",
"properties": {
"user_data_fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"entity": {
"type": "string"
},
"property": {
"type": "string"
},
"data_type": {
"type": "string"
},
"dynamic": {
"type": "boolean"
},
"source_key": {
"type": "string"
},
"label": {
"type": "string"
},
"input_type": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"read_only": {
"type": "boolean"
}
},
"additionalProperties": true,
"required": [
"key",
"entity",
"property",
"data_type"
]
}
},
"user_writable_fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"entity": {
"type": "string"
},
"property": {
"type": "string"
},
"data_type": {
"type": "string"
},
"dynamic": {
"type": "boolean"
},
"source_key": {
"type": "string"
},
"label": {
"type": "string"
},
"input_type": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"read_only": {
"type": "boolean"
}
},
"additionalProperties": true,
"required": [
"key",
"entity",
"property",
"data_type"
]
}
},
"user_email_fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"entity": {
"type": "string"
},
"property": {
"type": "string"
},
"data_type": {
"type": "string"
},
"dynamic": {
"type": "boolean"
},
"source_key": {
"type": "string"
},
"label": {
"type": "string"
},
"input_type": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"read_only": {
"type": "boolean"
}
},
"additionalProperties": true,
"required": [
"key",
"entity",
"property",
"data_type"
]
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^tag_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus dem aktuellen Konto."
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"contexts": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true,
"required": [
"id",
"name",
"value",
"contexts"
]
}
},
"email_templates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^et_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus dem aktuellen Konto."
},
"family_id": {
"type": "string",
"pattern": "^emailtemplate_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus dem aktuellen Konto."
},
"name": {
"type": "string"
},
"display_name": {
"type": "string"
},
"type": {
"type": "string"
},
"kind": {
"type": "string"
},
"compatibility": {
"type": "string"
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true,
"required": [
"id",
"family_id",
"name",
"display_name",
"type",
"kind",
"compatibility",
"languages"
]
}
},
"pdf_templates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^et_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus dem aktuellen Konto."
},
"family_id": {
"type": "string",
"pattern": "^emailtemplate_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus dem aktuellen Konto."
},
"name": {
"type": "string"
},
"display_name": {
"type": "string"
},
"type": {
"type": "string"
},
"kind": {
"type": "string"
},
"compatibility": {
"type": "string"
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true,
"required": [
"id",
"family_id",
"name",
"display_name",
"type",
"kind",
"compatibility",
"languages"
]
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true,
"required": [
"definition_version",
"triggers",
"fields",
"operators",
"actions",
"limits",
"account_options"
]
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}Beispiel
{
"success": true,
"error": false,
"data": {
"definition_version": 1,
"triggers": [
{
"key": "api.post.user",
"contexts": [
"user"
],
"fields": [
"user.email"
],
"actions": [
"note.create"
]
}
],
"fields": [
{
"key": "user.email",
"entity": "user",
"property": "email",
"data_type": "text"
}
],
"operators": {
"text": [
"equals",
"not_equals",
"contains",
"is_empty",
"is_not_empty"
]
},
"actions": [
{
"type": "note.create",
"contexts_any": [
"user",
"booking"
],
"execution": "async",
"parameters": {
"subject": "text",
"message": "text",
"targets": "note_target_list"
},
"target_types": [
"user"
]
}
],
"limits": {
"group_depth": 2,
"conditions": 50,
"actions": 10
},
"account_options": {
"user_data_fields": [],
"user_writable_fields": [],
"user_email_fields": [],
"tags": [],
"email_templates": [],
"pdf_templates": []
}
}
}400application/json
Invalid request.
application/json
Typ nicht eingeschränkt
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED40006"
}401application/json
Missing/expired token, missing account context, account paused or model-specific authorization failure.
application/json
Typ nicht eingeschränkt
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED40103"
}402application/json
Missing/invalid action data or subscription/operation restriction.
application/json
Typ nicht eingeschränkt
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED80100"
}403application/json
Permission denied. Browser CORS rejection may have an empty body.
application/json
Typ nicht eingeschränkt
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED40340"
}404application/json
Unknown resource/action or unsupported method.
application/json
Typ nicht eingeschränkt
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED80019"
}422application/json
Validation failed.
application/json
Typ nicht eingeschränkt
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED80020"
}429application/json
Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.
Response Header
Retry-After
Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.
string
Schema-Beispiel
"30"Vollständiges Schema als JSON
{
"type": "string",
"examples": [
"30"
]
}application/json
Typ nicht eingeschränkt
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED42902"
}502application/json
Server-side operation failed.
application/json
Typ nicht eingeschränkt
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED50201"
}06
Quelle & Metadaten
Quelle laut Spezifikation
application/models/v2/Automationrule.php:38getAutomationrule()Diese Angaben stammen unverändert aus der gelieferten OpenAPI-Datei. Zusätzliche Freigaben, Vorbedingungen, sensible Felder und Hinweise stehen in den Erweiterungen.
x-edoobox-mutates-state
falsex-edoobox-mutationReview
{
"source": {
"file": "application/models/v2/Automationrule.php",
"line": 38
},
"reason": "Read rules, existing execution history or static catalog/samples; no execution is started."
}x-edoobox-runtimeMutationGuard
falsex-edoobox-get-effect
"read"x-edoobox-documentationReview
{
"file": "docs/openapi/operation-contracts/01-membership.json",
"notes": []
}x-edoobox-source
{
"file": "application/models/v2/Automationrule.php",
"method": "getAutomationrule",
"line": 38,
"branch": {
"file": "application/models/v2/Automationrule.php",
"line": 43
}
}x-edoobox-documentationStatus
"reviewed"x-edoobox-readOnly
truex-edoobox-safeForAutomation
truex-edoobox-permission
{
"resource": "automationrule",
"short": "auru",
"checkedByDispatcher": true,
"levels": [
1,
3,
4
],
"description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
}Vollständige Operation als JSON
{
"operationId": "get_v2_automationrule_catalog",
"summary": "Automationsmöglichkeiten und Kontoreferenzen lesen",
"description": "Liest verfügbare Trigger, Kontextfelder, Datentypen, Operatoren und Aktionen sowie maximale Gruppentiefe/Anzahlen. Ohne trigger sind fields/actions nach Auslöser gruppiert, mit trigger flache Listen. account_options enthält die tatsächlich schreibbaren Benutzerfelder, geeignete E-Mail-Felder, Tags und zulässige E-Mail-/Teilnehmer-PDF-Vorlagen. Dynamische Kontofelder sind eine offene kontospezifische Konfiguration; gültige Referenzen aus diesem Katalog übernehmen. Kein Definitionsspeichern oder Ausführen. Regel-/Ausführungszeitstempel werden als ISO-8601-String oder null ausgegeben.",
"tags": [
"automationrule"
],
"security": [
{
"bearerAuth": [],
"accountContext": []
},
{
"sessionCookie": [],
"accountContext": []
}
],
"parameters": [
{
"name": "trigger",
"in": "query",
"required": false,
"description": "Auslöser; bestimmt verfügbare Kontextfelder und Aktionen.",
"schema": {
"type": "string",
"enum": [
"api.post.user",
"api.post.booking",
"api.post.offer",
"communication.booking_confirmation.before_send",
"communication.certificate.before_send"
]
}
},
{
"name": "language",
"in": "header",
"required": false,
"description": "Account language code, where the resource supports setLanguage().",
"schema": {
"type": "string",
"examples": [
"de"
]
}
}
],
"responses": {
"200": {
"description": "data enthält das dokumentierte Ergebnisobjekt bzw. die Ergebnisliste; error=false und success=true.",
"content": {
"application/json": {
"example": {
"success": true,
"error": false,
"data": {
"definition_version": 1,
"triggers": [
{
"key": "api.post.user",
"contexts": [
"user"
],
"fields": [
"user.email"
],
"actions": [
"note.create"
]
}
],
"fields": [
{
"key": "user.email",
"entity": "user",
"property": "email",
"data_type": "text"
}
],
"operators": {
"text": [
"equals",
"not_equals",
"contains",
"is_empty",
"is_not_empty"
]
},
"actions": [
{
"type": "note.create",
"contexts_any": [
"user",
"booking"
],
"execution": "async",
"parameters": {
"subject": "text",
"message": "text",
"targets": "note_target_list"
},
"target_types": [
"user"
]
}
],
"limits": {
"group_depth": 2,
"conditions": 50,
"actions": 10
},
"account_options": {
"user_data_fields": [],
"user_writable_fields": [],
"user_email_fields": [],
"tags": [],
"email_templates": [],
"pdf_templates": []
}
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"error": {
"type": [
"boolean",
"string"
]
},
"error_code": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"definition_version": {
"type": "integer"
},
"triggers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"contexts": {
"type": "array",
"items": {
"type": "string"
}
},
"fields": {
"type": "array",
"items": {
"type": "string"
}
},
"actions": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true,
"required": [
"key",
"contexts",
"fields",
"actions"
]
}
},
"fields": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"entity": {
"type": "string"
},
"property": {
"type": "string"
},
"data_type": {
"type": "string"
},
"dynamic": {
"type": "boolean"
},
"source_key": {
"type": "string"
},
"label": {
"type": "string"
},
"input_type": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"read_only": {
"type": "boolean"
}
},
"additionalProperties": true,
"required": [
"key",
"entity",
"property",
"data_type"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"properties": {
"trigger": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"entity": {
"type": "string"
},
"property": {
"type": "string"
},
"data_type": {
"type": "string"
},
"dynamic": {
"type": "boolean"
},
"source_key": {
"type": "string"
},
"label": {
"type": "string"
},
"input_type": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"read_only": {
"type": "boolean"
}
},
"additionalProperties": true,
"required": [
"key",
"entity",
"property",
"data_type"
]
}
}
},
"additionalProperties": true,
"required": [
"trigger",
"fields"
]
}
}
]
},
"operators": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"actions": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"contexts": {
"type": "array",
"items": {
"type": "string"
}
},
"contexts_any": {
"type": "array",
"items": {
"type": "string"
}
},
"execution": {
"type": "string",
"enum": [
"async",
"synchronous"
]
},
"parameters": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"field_source": {
"type": "string"
},
"writable_fields": {
"type": "array",
"items": {
"type": "string"
}
},
"recipient_types": {
"type": "array",
"items": {
"type": "string"
}
},
"recipient_field_source": {
"type": "string"
},
"target_types": {
"type": "array",
"items": {
"type": "string"
}
},
"template_kind": {
"type": "string"
},
"template_compatibility": {
"type": "string"
}
},
"additionalProperties": true,
"required": [
"type",
"execution",
"parameters"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"properties": {
"trigger": {
"type": "string"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"contexts": {
"type": "array",
"items": {
"type": "string"
}
},
"contexts_any": {
"type": "array",
"items": {
"type": "string"
}
},
"execution": {
"type": "string",
"enum": [
"async",
"synchronous"
]
},
"parameters": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"field_source": {
"type": "string"
},
"writable_fields": {
"type": "array",
"items": {
"type": "string"
}
},
"recipient_types": {
"type": "array",
"items": {
"type": "string"
}
},
"recipient_field_source": {
"type": "string"
},
"target_types": {
"type": "array",
"items": {
"type": "string"
}
},
"template_kind": {
"type": "string"
},
"template_compatibility": {
"type": "string"
}
},
"additionalProperties": true,
"required": [
"type",
"execution",
"parameters"
]
}
}
},
"additionalProperties": true,
"required": [
"trigger",
"actions"
]
}
}
],
"items": {
"description": "Normalisierte Aktion oder fehlerhafter Entwurfseintrag; Aktivierung erfordert vollständige Validierung.",
"anyOf": [
{},
{
"type": [
"object",
"array",
"string",
"number",
"boolean",
"null"
]
}
]
}
},
"limits": {
"type": "object",
"properties": {
"group_depth": {
"type": "integer"
},
"conditions": {
"type": "integer"
},
"actions": {
"type": "integer"
}
},
"additionalProperties": true,
"required": [
"group_depth",
"conditions",
"actions"
]
},
"account_options": {
"type": "object",
"properties": {
"user_data_fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"entity": {
"type": "string"
},
"property": {
"type": "string"
},
"data_type": {
"type": "string"
},
"dynamic": {
"type": "boolean"
},
"source_key": {
"type": "string"
},
"label": {
"type": "string"
},
"input_type": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"read_only": {
"type": "boolean"
}
},
"additionalProperties": true,
"required": [
"key",
"entity",
"property",
"data_type"
]
}
},
"user_writable_fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"entity": {
"type": "string"
},
"property": {
"type": "string"
},
"data_type": {
"type": "string"
},
"dynamic": {
"type": "boolean"
},
"source_key": {
"type": "string"
},
"label": {
"type": "string"
},
"input_type": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"read_only": {
"type": "boolean"
}
},
"additionalProperties": true,
"required": [
"key",
"entity",
"property",
"data_type"
]
}
},
"user_email_fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"entity": {
"type": "string"
},
"property": {
"type": "string"
},
"data_type": {
"type": "string"
},
"dynamic": {
"type": "boolean"
},
"source_key": {
"type": "string"
},
"label": {
"type": "string"
},
"input_type": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"read_only": {
"type": "boolean"
}
},
"additionalProperties": true,
"required": [
"key",
"entity",
"property",
"data_type"
]
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^tag_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus dem aktuellen Konto."
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"contexts": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true,
"required": [
"id",
"name",
"value",
"contexts"
]
}
},
"email_templates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^et_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus dem aktuellen Konto."
},
"family_id": {
"type": "string",
"pattern": "^emailtemplate_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus dem aktuellen Konto."
},
"name": {
"type": "string"
},
"display_name": {
"type": "string"
},
"type": {
"type": "string"
},
"kind": {
"type": "string"
},
"compatibility": {
"type": "string"
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true,
"required": [
"id",
"family_id",
"name",
"display_name",
"type",
"kind",
"compatibility",
"languages"
]
}
},
"pdf_templates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^et_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus dem aktuellen Konto."
},
"family_id": {
"type": "string",
"pattern": "^emailtemplate_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus dem aktuellen Konto."
},
"name": {
"type": "string"
},
"display_name": {
"type": "string"
},
"type": {
"type": "string"
},
"kind": {
"type": "string"
},
"compatibility": {
"type": "string"
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true,
"required": [
"id",
"family_id",
"name",
"display_name",
"type",
"kind",
"compatibility",
"languages"
]
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true,
"required": [
"definition_version",
"triggers",
"fields",
"operators",
"actions",
"limits",
"account_options"
]
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}
}
}
},
"400": {
"description": "Invalid request.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED40006"
}
}
}
},
"401": {
"description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED40103"
}
}
}
},
"402": {
"description": "Missing/invalid action data or subscription/operation restriction.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED80100"
}
}
}
},
"403": {
"description": "Permission denied. Browser CORS rejection may have an empty body.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED40340"
}
}
}
},
"404": {
"description": "Unknown resource/action or unsupported method.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED80019"
}
}
}
},
"422": {
"description": "Validation failed.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED80020"
}
}
}
},
"429": {
"description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED42902"
}
}
},
"headers": {
"Retry-After": {
"description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.",
"schema": {
"type": "string",
"examples": [
"30"
]
}
}
}
},
"502": {
"description": "Server-side operation failed.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED50201"
}
}
}
}
},
"x-edoobox-mutates-state": false,
"x-edoobox-mutationReview": {
"source": {
"file": "application/models/v2/Automationrule.php",
"line": 38
},
"reason": "Read rules, existing execution history or static catalog/samples; no execution is started."
},
"x-edoobox-runtimeMutationGuard": false,
"x-edoobox-get-effect": "read",
"x-edoobox-documentationReview": {
"file": "docs/openapi/operation-contracts/01-membership.json",
"notes": []
},
"x-edoobox-source": {
"file": "application/models/v2/Automationrule.php",
"method": "getAutomationrule",
"line": 38,
"branch": {
"file": "application/models/v2/Automationrule.php",
"line": 43
}
},
"x-edoobox-documentationStatus": "reviewed",
"x-edoobox-readOnly": true,
"x-edoobox-safeForAutomation": true,
"x-edoobox-permission": {
"resource": "automationrule",
"short": "auru",
"checkedByDispatcher": true,
"levels": [
1,
3,
4
],
"description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
}
}