Conditions

Introduction

Conditions control whether a Trigger's Actions should execute.

A Condition can be attached directly to a Trigger or nested inside a ConditionGroup to build complex boolean logic.

Model Definition

Relations

Key	Relation	Type	Relation Field(s)
attachable	Trigger or ConditionGroup	Morph To	attachable_id, attachable_type

Attachable Types

• trigger - Attaches the condition to a Trigger.

• conditionGroup - Nests the condition in a ConditionGroup.

• formFieldDisplayCondition - Attaches the condition to a form-field display condition.

Types

• systemVariable - Compares a resolved System Variable.

• formFieldValue - Compares a form-field value.

• taskStatus - Compares a task status.

Operators

• equal - Matches equal values.

• not_equal - Matches unequal values.

• greater - Matches a greater value.

• greater_equal - Matches an equal or greater value.

• lower - Matches a lower value.

• lower_equal - Matches an equal or lower value.

• is_null - Matches a missing value without requiring value.

• not_null - Matches a present value without requiring value.

• contains - Matches when the source contains value.

• not_contains - Matches when the source does not contain value.

System Variable Handling

For a systemVariable condition, key must contain a valid key-only System Variable, such as system.user.id. Do not wrap the key in braces or add a formatter.

For every condition type, value may contain a validated rendered template, such as User ID: {{ system.user.id }}. Invalid template syntax and invalid System Variable expressions are rejected during creation and update.

Create

Create a new Condition.

Definition

POST /api/conditions

Request Keys

Key	Type	Default	Description
attachable_type*	string	-	Selects one of the supported Attachable Types.
attachable_id*	integer	-	ID of the parent attachable entity.
type*	string	-	Selects one of the supported Types.
key*	string | integer	-	Type-specific condition key (e.g. system variable key or form field ID).
operator*	string	-	Selects one of the supported Operators.
value	string | null	-	Comparison value; supports validated rendered templates.

Keys with * are required.

Behavior

• value is required unless operator is is_null or not_null.

• A systemVariable condition requires key to use key-only syntax.

Example Request

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('POST', '/api/conditions', [
    'headers' => ['Authorization' => "Bearer {accessToken}"],
    'json' => [
        'attachable_type' => 'trigger',
        'attachable_id' => 42,
        'type' => 'systemVariable',
        'key' => 'system.user.id',
        'operator' => 'equal',
        'value' => '123'
    ]
]);

Example Response

{
  "status": "success",
  "data": {
    "id": 1,
    "attachable_type": "trigger",
    "attachable_id": 42,
    "type": "systemVariable",
    "key": "system.user.id",
    "operator": "equal",
    "value": "123",
    "created_at": "2024-01-01 10:00:00",
    "updated_at": "2024-01-01 10:00:00",
    "deleted_at": null
  }
}

Update

Update an existing Condition.

Definition

PUT /api/conditions/{condition}

Route Parameters

Parameter	Type	Description
condition	integer	Condition ID.

Request Keys

Key	Type	Default	Description
attachable_type	string	-	Selects one of the supported Attachable Types.
attachable_id	integer	-	New parent entity ID.
type	string	-	Selects one of the supported Types.
key	string | integer	-	Updated type-specific condition key.
operator	string	-	Selects one of the supported Operators.
value	string | null	-	Updated comparison value; supports validated rendered templates.

Behavior

• Only submitted keys are updated.

• The resulting condition must keep a valid type-specific key, operator, and value combination. A systemVariable key uses key-only syntax.

Example Request

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('PUT', '/api/conditions/1', [
    'headers' => ['Authorization' => "Bearer {accessToken}"],
    'json' => [
        'key' => 'system.user.email',
        'operator' => 'not_equal',
        'value' => '[e-mail]'
    ]
]);

Example Response

{
  "status": "success",
  "data": {
    "id": 1,
    "attachable_type": "trigger",
    "attachable_id": 42,
    "type": "systemVariable",
    "key": "system.user.email",
    "operator": "not_equal",
    "value": "[e-mail]",
    "created_at": "2024-01-01 10:00:00",
    "updated_at": "2024-01-02 11:00:00",
    "deleted_at": null
  }
}

Delete

Delete a Condition.

Definition

DELETE /api/conditions/{condition}

Route Parameters

Parameter	Type	Description
condition	integer	Condition ID.

Example Request

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('DELETE', '/api/conditions/1', [
    'headers' => ['Authorization' => "Bearer {accessToken}"]
]);

Example Response

{
  "status": "success",
  "data": null
}