Skip to content

Trigger

Defines an automated function invocation that executes in response to specific Unit lifecycle events in ConfigHub. Triggers can be used to implement validation rules, automated transformations, or other custom logic that should run when configuration changes occur. Each Trigger is associated with a specific Space and can be configured to execute on events.

Triggers can be either validating (checking configuration validity without modifying it) or mutating (making changes to the configuration). They can be disabled, and validating triggers can be set to Warn mode to produce non-blocking ApplyWarnings instead of ApplyGates.

Operations

Method Endpoint Description
GET /space/{space_id}/trigger List Triggers
GET /trigger List of Triggers across spaces
GET /space/{space_id}/trigger/{trigger_id} Get Trigger
POST /space/{space_id}/trigger Create Trigger
POST /trigger Bulk create (clone) multiple triggers
PATCH /space/{space_id}/trigger/{trigger_id} Patch Trigger
PUT /space/{space_id}/trigger/{trigger_id} Update Trigger
PATCH /trigger Bulk patch multiple triggers
DELETE /space/{space_id}/trigger/{trigger_id} Delete Trigger
DELETE /trigger Bulk delete multiple triggers

List Triggers

GET /space/{space_id}/trigger

List Triggers

Operation ID: ListTriggers

Parameters

Path Parameters

Parameter Type Required Description
space_id string Unique identifier for a space_id

Query Parameters

Parameter Type Required Description
where string The specified string is an expression for the purpose of filtering the list of Triggers returned. The expression syntax was inspired by SQL. It supports conjunctions using AND of relational expressions of the form attribute operator attribute_or_literal. The attribute names are case-sensitive and PascalCase, as in the JSON encoding. Strings support the following operators: <, >, <=, >=, =, !=, LIKE, NOT LIKE, ILIKE, ~~, !~~, ~, ~*, !~, !~*, IN, NOT IN. String pattern operators: LIKE and ~~ for pattern matching with % and _ wildcards, ILIKE for case-insensitive pattern matching, NOT LIKE and !~~ for negated pattern matching. String regex operators: ~ for regex matching, ~* for case-insensitive regex, !~ and !~* for regex not matching (case-sensitive and insensitive). Integers support the following operators: <, >, <=, >=, =, !=, IN, NOT IN. UUIDs and boolean attributes support equality and inequality only. UUID and time literals must be quoted as string literals. String literals are quoted with single quotes, such as 'string'. Time literals use the same form as when serialized as JSON, such as: CreatedAt > '2025-02-18T23:16:34'. Integer and boolean literals are also supported for attributes of those types. Arrays support the ? operator to to match any element of the array, as in ApprovedBy ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'. Arrays can perform LEN() to check for length, as in LEN(ApprovedBy) > 0. Map support the dot notation to specify a particular map key, as in Labels.tier = 'Backend'. Maps support IS NULL and IS NOT NULL with dot notation to check for key absence or presence, as in Labels.tier IS NULL (key doesn't exist) or Labels.tier IS NOT NULL (key exists). Comparison results can be tested with IS TRUE, IS FALSE, IS NOT TRUE, and IS NOT FALSE. These are useful for nullable columns: MergeSourceID = '<uuid>' IS NOT FALSE matches rows where MergeSourceID equals the value OR is NULL. The IN and NOT IN operators accept a comma-separated list of values in parentheses, such as Slug IN ('slugone', 'slugtwo') or Labels.environment IN ('prod', 'staging'). Conjunctions are supported using the AND operator. An example conjunction is: CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'. Supported attributes for filtering on Trigger: Annotations, BridgeWorkerID, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Hash, InvocationID, Labels, OrganizationID, OtherDataSource, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, Validating, Warn, WhereResource, WhereUnit. The whole string must be query-encoded.
filter string UUID of a Filter entity to apply to the Trigger list. The Filter must be in the same Organization as the user credentials. The Filter's From field must match the entity type being filtered (Trigger). For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
contains string Free text search that approximately matches the specified string against string fields and map keys/values. The search is case-insensitive and uses pattern matching to find entities containing the text. Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. For map fields (like Labels and Annotations), the search matches both map keys and values. The search uses OR logic across all searchable fields, so matching any field will return the entity. If both 'where' and 'contains' parameters are specified, they are combined with AND logic. Searchable fields for Trigger include string and map-type attributes from the queryable attributes list. The whole string must be query-encoded.
include string Include clause for expanding related entities in the response for Trigger. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. Supported attributes for Trigger are BridgeWorkerID, InvocationID, OrganizationID, SpaceID, UnitFilterID. The whole string must be query-encoded.
select string Select clause for specifying which fields to include in the response for Trigger. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. If not specified, all fields are returned. Entity and parent IDs (like OrganizationID, SpaceID, TriggerID) and Slug are always returned regardless of the select parameter. Fields used in where and contains filters are also automatically included. Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. The whole string must be query-encoded.

Responses

Status Description Content-Type Schema
200 OK application/json Array of ExtendedTrigger
400 Trigger request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 Trigger not found. application/json StandardErrorResponse
500 Something went wrong while processing Trigger. application/json StandardErrorResponse
default Unexpected error. application/json StandardErrorResponse

List of Triggers across spaces

GET /trigger

Retrieves a list of Triggers across spaces in the Organization

Operation ID: ListAllTriggers

Parameters

Query Parameters

Parameter Type Required Description
where string The specified string is an expression for the purpose of filtering the list of Triggers returned. The expression syntax was inspired by SQL. It supports conjunctions using AND of relational expressions of the form attribute operator attribute_or_literal. The attribute names are case-sensitive and PascalCase, as in the JSON encoding. Strings support the following operators: <, >, <=, >=, =, !=, LIKE, NOT LIKE, ILIKE, ~~, !~~, ~, ~*, !~, !~*, IN, NOT IN. String pattern operators: LIKE and ~~ for pattern matching with % and _ wildcards, ILIKE for case-insensitive pattern matching, NOT LIKE and !~~ for negated pattern matching. String regex operators: ~ for regex matching, ~* for case-insensitive regex, !~ and !~* for regex not matching (case-sensitive and insensitive). Integers support the following operators: <, >, <=, >=, =, !=, IN, NOT IN. UUIDs and boolean attributes support equality and inequality only. UUID and time literals must be quoted as string literals. String literals are quoted with single quotes, such as 'string'. Time literals use the same form as when serialized as JSON, such as: CreatedAt > '2025-02-18T23:16:34'. Integer and boolean literals are also supported for attributes of those types. Arrays support the ? operator to to match any element of the array, as in ApprovedBy ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'. Arrays can perform LEN() to check for length, as in LEN(ApprovedBy) > 0. Map support the dot notation to specify a particular map key, as in Labels.tier = 'Backend'. Maps support IS NULL and IS NOT NULL with dot notation to check for key absence or presence, as in Labels.tier IS NULL (key doesn't exist) or Labels.tier IS NOT NULL (key exists). Comparison results can be tested with IS TRUE, IS FALSE, IS NOT TRUE, and IS NOT FALSE. These are useful for nullable columns: MergeSourceID = '<uuid>' IS NOT FALSE matches rows where MergeSourceID equals the value OR is NULL. The IN and NOT IN operators accept a comma-separated list of values in parentheses, such as Slug IN ('slugone', 'slugtwo') or Labels.environment IN ('prod', 'staging'). Conjunctions are supported using the AND operator. An example conjunction is: CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'. Supported attributes for filtering on Trigger: Annotations, BridgeWorkerID, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Hash, InvocationID, Labels, OrganizationID, OtherDataSource, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, Validating, Warn, WhereResource, WhereUnit. The whole string must be query-encoded.
filter string UUID of a Filter entity to apply to the Trigger list. The Filter must be in the same Organization as the user credentials. The Filter's From field must match the entity type being filtered (Trigger). For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
contains string Free text search that approximately matches the specified string against string fields and map keys/values. The search is case-insensitive and uses pattern matching to find entities containing the text. Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. For map fields (like Labels and Annotations), the search matches both map keys and values. The search uses OR logic across all searchable fields, so matching any field will return the entity. If both 'where' and 'contains' parameters are specified, they are combined with AND logic. Searchable fields for Trigger include string and map-type attributes from the queryable attributes list. The whole string must be query-encoded.
include string Include clause for expanding related entities in the response for Trigger. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. Supported attributes for Trigger are BridgeWorkerID, InvocationID, OrganizationID, SpaceID, UnitFilterID. The whole string must be query-encoded.
select string Select clause for specifying which fields to include in the response for Trigger. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. If not specified, all fields are returned. Entity and parent IDs (like OrganizationID, SpaceID, TriggerID) and Slug are always returned regardless of the select parameter. Fields used in where and contains filters are also automatically included. Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. The whole string must be query-encoded.

Responses

Status Description Content-Type Schema
200 OK application/json Array of ExtendedTrigger
400 Trigger request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 Trigger not found. application/json StandardErrorResponse
500 Something went wrong while processing Trigger. application/json StandardErrorResponse
default Unexpected error. application/json StandardErrorResponse

Get Trigger

GET /space/{space_id}/trigger/{trigger_id}

Get Trigger

Operation ID: GetTrigger

Parameters

Path Parameters

Parameter Type Required Description
space_id string Unique identifier for a space_id
trigger_id string Unique identifier for a trigger_id

Query Parameters

Parameter Type Required Description
include string Include clause for expanding related entities in the response for Trigger. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. Supported attributes for Trigger are BridgeWorkerID, InvocationID, OrganizationID, SpaceID, UnitFilterID. The whole string must be query-encoded.
select string Select clause for specifying which fields to include in the response for Trigger. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. If not specified, all fields are returned. Entity and parent IDs (like OrganizationID, SpaceID, TriggerID) and Slug are always returned regardless of the select parameter. Fields used in where and contains filters are also automatically included. Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. The whole string must be query-encoded.

Responses

Status Description Content-Type Schema
200 OK application/json ExtendedTrigger
400 Trigger request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 Trigger not found. application/json StandardErrorResponse
500 Something went wrong while processing Trigger. application/json StandardErrorResponse
default Unexpected error. application/json StandardErrorResponse

Create Trigger

POST /space/{space_id}/trigger

Create Trigger

Operation ID: CreateTrigger

Parameters

Path Parameters

Parameter Type Required Description
space_id string Unique identifier for a space_id

Query Parameters

Parameter Type Required Description
allow_exists string Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity

Request Body

Content-Type: application/json

Schema: Trigger

Responses

Status Description Content-Type Schema
200 Defines an automated function invocation that executes in response to specific Unit lifecycle events in ConfigHub. Triggers can be used to implement validation rules, automated transformations, or other custom logic that should run when configuration changes occur. Each Trigger is associated with a specific Space and can be configured to execute on events. Triggers can be either validating (checking configuration validity without modifying it) or mutating (making changes to the configuration). They can be disabled, and validating triggers can be set to Warn mode to produce non-blocking ApplyWarnings instead of ApplyGates. application/json Trigger
400 Trigger request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 Trigger not found. application/json StandardErrorResponse
409 Trigger data conflict. Data has changed since last read. application/json StandardErrorResponse
500 Something went wrong while processing Trigger. application/json StandardErrorResponse
default Unexpected error. application/json StandardErrorResponse

Bulk create (clone) multiple triggers

POST /trigger

Clone multiple triggers selected by query parameters with optional name prefixes and destination spaces

Operation ID: BulkCreateTriggers

Parameters

Query Parameters

Parameter Type Required Description
where string The specified string is an expression for the purpose of filtering the list of Triggers returned. The expression syntax was inspired by SQL. It supports conjunctions using AND of relational expressions of the form attribute operator attribute_or_literal. The attribute names are case-sensitive and PascalCase, as in the JSON encoding. Strings support the following operators: <, >, <=, >=, =, !=, LIKE, NOT LIKE, ILIKE, ~~, !~~, ~, ~*, !~, !~*, IN, NOT IN. String pattern operators: LIKE and ~~ for pattern matching with % and _ wildcards, ILIKE for case-insensitive pattern matching, NOT LIKE and !~~ for negated pattern matching. String regex operators: ~ for regex matching, ~* for case-insensitive regex, !~ and !~* for regex not matching (case-sensitive and insensitive). Integers support the following operators: <, >, <=, >=, =, !=, IN, NOT IN. UUIDs and boolean attributes support equality and inequality only. UUID and time literals must be quoted as string literals. String literals are quoted with single quotes, such as 'string'. Time literals use the same form as when serialized as JSON, such as: CreatedAt > '2025-02-18T23:16:34'. Integer and boolean literals are also supported for attributes of those types. Arrays support the ? operator to to match any element of the array, as in ApprovedBy ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'. Arrays can perform LEN() to check for length, as in LEN(ApprovedBy) > 0. Map support the dot notation to specify a particular map key, as in Labels.tier = 'Backend'. Maps support IS NULL and IS NOT NULL with dot notation to check for key absence or presence, as in Labels.tier IS NULL (key doesn't exist) or Labels.tier IS NOT NULL (key exists). Comparison results can be tested with IS TRUE, IS FALSE, IS NOT TRUE, and IS NOT FALSE. These are useful for nullable columns: MergeSourceID = '<uuid>' IS NOT FALSE matches rows where MergeSourceID equals the value OR is NULL. The IN and NOT IN operators accept a comma-separated list of values in parentheses, such as Slug IN ('slugone', 'slugtwo') or Labels.environment IN ('prod', 'staging'). Conjunctions are supported using the AND operator. An example conjunction is: CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'. Supported attributes for filtering on Trigger: Annotations, BridgeWorkerID, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Hash, InvocationID, Labels, OrganizationID, OtherDataSource, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, Validating, Warn, WhereResource, WhereUnit. The whole string must be query-encoded.
filter string UUID of a Filter entity to apply to the Trigger list. The Filter must be in the same Organization as the user credentials. The Filter's From field must match the entity type being filtered (Trigger). For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
contains string Free text search that approximately matches the specified string against string fields and map keys/values. The search is case-insensitive and uses pattern matching to find entities containing the text. Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. For map fields (like Labels and Annotations), the search matches both map keys and values. The search uses OR logic across all searchable fields, so matching any field will return the entity. If both 'where' and 'contains' parameters are specified, they are combined with AND logic. Searchable fields for Trigger include string and map-type attributes from the queryable attributes list. The whole string must be query-encoded.
include string Include clause for expanding related entities in the response for Trigger. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. Supported attributes for Trigger are BridgeWorkerID, InvocationID, OrganizationID, SpaceID, UnitFilterID. The whole string must be query-encoded.
name_prefixes string Comma-separated list of prefixes to apply to cloned Trigger names
where_space string The specified string is an expression for the purpose of filtering the list of Spaces returned. The expression syntax was inspired by SQL. It supports conjunctions using AND of relational expressions of the form attribute operator attribute_or_literal. The attribute names are case-sensitive and PascalCase, as in the JSON encoding. Strings support the following operators: <, >, <=, >=, =, !=, LIKE, NOT LIKE, ILIKE, ~~, !~~, ~, ~*, !~, !~*, IN, NOT IN. String pattern operators: LIKE and ~~ for pattern matching with % and _ wildcards, ILIKE for case-insensitive pattern matching, NOT LIKE and !~~ for negated pattern matching. String regex operators: ~ for regex matching, ~* for case-insensitive regex, !~ and !~* for regex not matching (case-sensitive and insensitive). Integers support the following operators: <, >, <=, >=, =, !=, IN, NOT IN. UUIDs and boolean attributes support equality and inequality only. UUID and time literals must be quoted as string literals. String literals are quoted with single quotes, such as 'string'. Time literals use the same form as when serialized as JSON, such as: CreatedAt > '2025-02-18T23:16:34'. Integer and boolean literals are also supported for attributes of those types. Arrays support the ? operator to to match any element of the array, as in ApprovedBy ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'. Arrays can perform LEN() to check for length, as in LEN(ApprovedBy) > 0. Map support the dot notation to specify a particular map key, as in Labels.tier = 'Backend'. Maps support IS NULL and IS NOT NULL with dot notation to check for key absence or presence, as in Labels.tier IS NULL (key doesn't exist) or Labels.tier IS NOT NULL (key exists). Comparison results can be tested with IS TRUE, IS FALSE, IS NOT TRUE, and IS NOT FALSE. These are useful for nullable columns: MergeSourceID = '<uuid>' IS NOT FALSE matches rows where MergeSourceID equals the value OR is NULL. The IN and NOT IN operators accept a comma-separated list of values in parentheses, such as Slug IN ('slugone', 'slugtwo') or Labels.environment IN ('prod', 'staging'). Conjunctions are supported using the AND operator. An example conjunction is: CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'. Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, Permissions, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt. Where expression to select destination spaces for cloning triggers The whole string must be query-encoded.
filter_space string UUID of a Filter entity to apply to the Space list. The Filter must be in the same Organization as the user credentials. The Filter's From field must match the entity type being filtered (Space). For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
allow_exists string Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity

Request Body

Content-Type: application/merge-patch+json

Responses

Status Description Content-Type Schema
200 OK application/json Array of TriggerCreateOrUpdateResponse
207 Multi-Status (partial success) application/json Array of TriggerCreateOrUpdateResponse
400 Trigger request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 Trigger not found. application/json StandardErrorResponse
409 Trigger data conflict. Data has changed since last read. application/json StandardErrorResponse
500 Something went wrong while processing Trigger. application/json StandardErrorResponse
default Unexpected error. application/json StandardErrorResponse

Patch Trigger

PATCH /space/{space_id}/trigger/{trigger_id}

Patch Trigger

Operation ID: PatchTrigger

Parameters

Path Parameters

Parameter Type Required Description
space_id string Unique identifier for a space_id
trigger_id string Unique identifier for a trigger_id

Request Body

Content-Type: application/merge-patch+json

Responses

Status Description Content-Type Schema
200 Defines an automated function invocation that executes in response to specific Unit lifecycle events in ConfigHub. Triggers can be used to implement validation rules, automated transformations, or other custom logic that should run when configuration changes occur. Each Trigger is associated with a specific Space and can be configured to execute on events. Triggers can be either validating (checking configuration validity without modifying it) or mutating (making changes to the configuration). They can be disabled, and validating triggers can be set to Warn mode to produce non-blocking ApplyWarnings instead of ApplyGates. application/json Trigger
400 Trigger request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 Trigger not found. application/json StandardErrorResponse
409 Trigger data conflict. Data has changed since last read. application/json StandardErrorResponse
500 Something went wrong while processing Trigger. application/json StandardErrorResponse
default Unexpected error. application/json StandardErrorResponse

Update Trigger

PUT /space/{space_id}/trigger/{trigger_id}

Update Trigger

Operation ID: UpdateTrigger

Parameters

Path Parameters

Parameter Type Required Description
space_id string Unique identifier for a space_id
trigger_id string Unique identifier for a trigger_id

Request Body

Content-Type: application/json

Schema: Trigger

Responses

Status Description Content-Type Schema
200 Defines an automated function invocation that executes in response to specific Unit lifecycle events in ConfigHub. Triggers can be used to implement validation rules, automated transformations, or other custom logic that should run when configuration changes occur. Each Trigger is associated with a specific Space and can be configured to execute on events. Triggers can be either validating (checking configuration validity without modifying it) or mutating (making changes to the configuration). They can be disabled, and validating triggers can be set to Warn mode to produce non-blocking ApplyWarnings instead of ApplyGates. application/json Trigger
400 Trigger request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 Trigger not found. application/json StandardErrorResponse
409 Trigger data conflict. Data has changed since last read. application/json StandardErrorResponse
500 Something went wrong while processing Trigger. application/json StandardErrorResponse
default Unexpected error. application/json StandardErrorResponse

Bulk patch multiple triggers

PATCH /trigger

Apply JSON merge patch to multiple triggers selected by query parameters

Operation ID: BulkPatchTriggers

Parameters

Query Parameters

Parameter Type Required Description
where string The specified string is an expression for the purpose of filtering the list of Triggers returned. The expression syntax was inspired by SQL. It supports conjunctions using AND of relational expressions of the form attribute operator attribute_or_literal. The attribute names are case-sensitive and PascalCase, as in the JSON encoding. Strings support the following operators: <, >, <=, >=, =, !=, LIKE, NOT LIKE, ILIKE, ~~, !~~, ~, ~*, !~, !~*, IN, NOT IN. String pattern operators: LIKE and ~~ for pattern matching with % and _ wildcards, ILIKE for case-insensitive pattern matching, NOT LIKE and !~~ for negated pattern matching. String regex operators: ~ for regex matching, ~* for case-insensitive regex, !~ and !~* for regex not matching (case-sensitive and insensitive). Integers support the following operators: <, >, <=, >=, =, !=, IN, NOT IN. UUIDs and boolean attributes support equality and inequality only. UUID and time literals must be quoted as string literals. String literals are quoted with single quotes, such as 'string'. Time literals use the same form as when serialized as JSON, such as: CreatedAt > '2025-02-18T23:16:34'. Integer and boolean literals are also supported for attributes of those types. Arrays support the ? operator to to match any element of the array, as in ApprovedBy ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'. Arrays can perform LEN() to check for length, as in LEN(ApprovedBy) > 0. Map support the dot notation to specify a particular map key, as in Labels.tier = 'Backend'. Maps support IS NULL and IS NOT NULL with dot notation to check for key absence or presence, as in Labels.tier IS NULL (key doesn't exist) or Labels.tier IS NOT NULL (key exists). Comparison results can be tested with IS TRUE, IS FALSE, IS NOT TRUE, and IS NOT FALSE. These are useful for nullable columns: MergeSourceID = '<uuid>' IS NOT FALSE matches rows where MergeSourceID equals the value OR is NULL. The IN and NOT IN operators accept a comma-separated list of values in parentheses, such as Slug IN ('slugone', 'slugtwo') or Labels.environment IN ('prod', 'staging'). Conjunctions are supported using the AND operator. An example conjunction is: CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'. Supported attributes for filtering on Trigger: Annotations, BridgeWorkerID, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Hash, InvocationID, Labels, OrganizationID, OtherDataSource, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, Validating, Warn, WhereResource, WhereUnit. The whole string must be query-encoded.
filter string UUID of a Filter entity to apply to the Trigger list. The Filter must be in the same Organization as the user credentials. The Filter's From field must match the entity type being filtered (Trigger). For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
contains string Free text search that approximately matches the specified string against string fields and map keys/values. The search is case-insensitive and uses pattern matching to find entities containing the text. Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. For map fields (like Labels and Annotations), the search matches both map keys and values. The search uses OR logic across all searchable fields, so matching any field will return the entity. If both 'where' and 'contains' parameters are specified, they are combined with AND logic. Searchable fields for Trigger include string and map-type attributes from the queryable attributes list. The whole string must be query-encoded.
include string Include clause for expanding related entities in the response for Trigger. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. Supported attributes for Trigger are BridgeWorkerID, InvocationID, OrganizationID, SpaceID, UnitFilterID. The whole string must be query-encoded.

Request Body

Content-Type: application/merge-patch+json

Responses

Status Description Content-Type Schema
200 OK application/json Array of TriggerCreateOrUpdateResponse
207 Multi-Status: Mixed success and failure results application/json Array of TriggerCreateOrUpdateResponse
400 Trigger request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 Trigger not found. application/json StandardErrorResponse
409 Trigger data conflict. Data has changed since last read. application/json StandardErrorResponse
500 Something went wrong while processing Trigger. application/json StandardErrorResponse
default Unexpected error. application/json StandardErrorResponse

Delete Trigger

DELETE /space/{space_id}/trigger/{trigger_id}

Delete Trigger

Operation ID: DeleteTrigger

Parameters

Path Parameters

Parameter Type Required Description
space_id string Unique identifier for a space_id
trigger_id string Unique identifier for a trigger_id

Responses

Status Description Content-Type Schema
200 Response for successful delete operation application/json DeleteResponse
400 Trigger request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 Trigger not found. application/json StandardErrorResponse
409 Trigger data conflict. Data has changed since last read. application/json StandardErrorResponse
422 Trigger could not be deleted. application/json StandardErrorResponse
500 Something went wrong while processing Trigger. application/json StandardErrorResponse
default Unexpected error. application/json StandardErrorResponse

Bulk delete multiple triggers

DELETE /trigger

Delete multiple triggers selected by query parameters

Operation ID: BulkDeleteTriggers

Parameters

Query Parameters

Parameter Type Required Description
where string The specified string is an expression for the purpose of filtering the list of Triggers returned. The expression syntax was inspired by SQL. It supports conjunctions using AND of relational expressions of the form attribute operator attribute_or_literal. The attribute names are case-sensitive and PascalCase, as in the JSON encoding. Strings support the following operators: <, >, <=, >=, =, !=, LIKE, NOT LIKE, ILIKE, ~~, !~~, ~, ~*, !~, !~*, IN, NOT IN. String pattern operators: LIKE and ~~ for pattern matching with % and _ wildcards, ILIKE for case-insensitive pattern matching, NOT LIKE and !~~ for negated pattern matching. String regex operators: ~ for regex matching, ~* for case-insensitive regex, !~ and !~* for regex not matching (case-sensitive and insensitive). Integers support the following operators: <, >, <=, >=, =, !=, IN, NOT IN. UUIDs and boolean attributes support equality and inequality only. UUID and time literals must be quoted as string literals. String literals are quoted with single quotes, such as 'string'. Time literals use the same form as when serialized as JSON, such as: CreatedAt > '2025-02-18T23:16:34'. Integer and boolean literals are also supported for attributes of those types. Arrays support the ? operator to to match any element of the array, as in ApprovedBy ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'. Arrays can perform LEN() to check for length, as in LEN(ApprovedBy) > 0. Map support the dot notation to specify a particular map key, as in Labels.tier = 'Backend'. Maps support IS NULL and IS NOT NULL with dot notation to check for key absence or presence, as in Labels.tier IS NULL (key doesn't exist) or Labels.tier IS NOT NULL (key exists). Comparison results can be tested with IS TRUE, IS FALSE, IS NOT TRUE, and IS NOT FALSE. These are useful for nullable columns: MergeSourceID = '<uuid>' IS NOT FALSE matches rows where MergeSourceID equals the value OR is NULL. The IN and NOT IN operators accept a comma-separated list of values in parentheses, such as Slug IN ('slugone', 'slugtwo') or Labels.environment IN ('prod', 'staging'). Conjunctions are supported using the AND operator. An example conjunction is: CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'. Supported attributes for filtering on Trigger: Annotations, BridgeWorkerID, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Hash, InvocationID, Labels, OrganizationID, OtherDataSource, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, Validating, Warn, WhereResource, WhereUnit. The whole string must be query-encoded.
filter string UUID of a Filter entity to apply to the Trigger list. The Filter must be in the same Organization as the user credentials. The Filter's From field must match the entity type being filtered (Trigger). For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
contains string Free text search that approximately matches the specified string against string fields and map keys/values. The search is case-insensitive and uses pattern matching to find entities containing the text. Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. For map fields (like Labels and Annotations), the search matches both map keys and values. The search uses OR logic across all searchable fields, so matching any field will return the entity. If both 'where' and 'contains' parameters are specified, they are combined with AND logic. Searchable fields for Trigger include string and map-type attributes from the queryable attributes list. The whole string must be query-encoded.
include string Include clause for expanding related entities in the response for Trigger. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. Supported attributes for Trigger are BridgeWorkerID, InvocationID, OrganizationID, SpaceID, UnitFilterID. The whole string must be query-encoded.

Responses

Status Description Content-Type Schema
200 OK application/json Array of DeleteResponse
207 Multi-Status: Mixed success and failure results application/json Array of DeleteResponse
400 Trigger request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 Trigger not found. application/json StandardErrorResponse
409 Trigger data conflict. Data has changed since last read. application/json StandardErrorResponse
422 Unable to delete entity application/json StandardErrorResponse
500 Something went wrong while processing Trigger. application/json StandardErrorResponse
default Unexpected error. application/json StandardErrorResponse

Schemas

DeleteResponse

Response for successful delete operation

Properties

Property Type Required Description
Error ResponseError
Message string Response message.

ExtendedTrigger

Properties

Property Type Required Description
BridgeWorker BridgeWorker
Error ResponseError
Invocation Invocation
Organization Organization
Space Space
Trigger Trigger
UnitFilter Filter

StandardErrorResponse

Error response details.

Properties

Property Type Required Description
Code string HTTP status code of the response.
Message string Message returned with the response.

Trigger

Defines an automated function invocation that executes in response to specific Unit lifecycle events in ConfigHub. Triggers can be used to implement validation rules, automated transformations, or other custom logic that should run when configuration changes occur. Each Trigger is associated with a specific Space and can be configured to execute on events.

Triggers can be either validating (checking configuration validity without modifying it) or mutating (making changes to the configuration). They can be disabled, and validating triggers can be set to Warn mode to produce non-blocking ApplyWarnings instead of ApplyGates.

Properties

Property Type Required Description
Annotations object An optional map of Annotation key/value pairs for tools to attach information to entities.
Arguments Array of FunctionArgument Function arguments
BridgeWorkerID string (uuid) Unique identifier for a Bridge Worker to execute the function specified by the Trigger. If unspecified, use the builtin function executor.
CreatedAt string (date-time) The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
CursorID integer (int64) An auto-incrementing sequence number used for pagination.
DeleteGates object An optional set of gates that, if any is present, will block deletion.
Description string A longer description which explains what the trigger checks and how to fix validation failures. Shown as a pop-up when hovering over an ApplyGate in the UI.
Disabled boolean Disabled indicates whether this trigger is currently disabled. When disabled, the trigger will not be executed even when matching events occur.
DisplayName string Friendly name for the entity.
EntityType string The type of entity.
Event string Event specifies the type of event that will activate this trigger. Valid values are Mutation and PostClone
FailOpenAfter integer Duration after which a disconnected BridgeWorker's triggers are treated as fail-open. Can only be set when BridgeWorkerID is set.
FunctionName string Function name
Hash string SHA256 hash of the trigger's specification fields, used to detect changes.
InvocationID string (uuid) InvocationID is the identifier of the function to be invoked, if there is a corresponding Invocation.
Labels object An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them.
OrganizationID string (uuid) Unique identifier for an organization.
OtherDataSource string Specifies the source of additional configuration data to pass to functions that need it (e.g., vet-immutable needs LiveRevisionNum data). Uses revision specifier format such as LiveRevisionNum or Before:HeadRevisionNum.
Slug string Unique URL-safe identifier for the entity.
SpaceID string (uuid) Unique identifier for a space.
SpaceSlug string Slug of the Space this entity belongs to. (readonly)
ToolchainType string ToolchainType specifies the type of toolchain this trigger works with. This determines which configuration formats the trigger can process.
TriggerID string (uuid) TriggerID uniquely identifies a trigger within the system.
UnitFilterID string (uuid) References a Filter entity (with From=Unit) to restrict which Units this Trigger applies to.
UpdatedAt string (date-time) The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format.
Validating boolean Validating indicates whether this is a validating function (true) or not (false). When false, the function can be either mutating (modifying configuration) or readonly returning an AttributeValueList (extracting values without modification). Validating functions check configuration validity without modifying it. This value is returned by ConfigHub based on the corresponding property of the specified function.
Version integer (int64) An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update.
Warn boolean Warn indicates whether this trigger produces ApplyWarnings instead of ApplyGates when its validating function fails. ApplyWarnings are non-blocking.
WhereResource string Restricts which resources within a Unit's configuration data the Trigger's function operates on, using ConfigHub metadata path expressions.
WhereUnit string A filter expression to restrict which Units this Trigger applies to.

TriggerCreateOrUpdateResponse

Properties

Property Type Required Description
Error ResponseError
Trigger Trigger