Workflow triggers

Triggers allow you to automate the execution of your data workflows based on specific conditions, such as scheduled times (defined by cron expressions).

List triggers

Required capabilities: workflowOrchestrationACL:READ

List all triggers. The results are sorted by externalId in ascending order.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
query Parameters
limit
integer (limit) [ 1 .. 1000 ]
Default: 100

The maximum number of results to return.

cursor
string (cursor)

Cursor to use for paging through results. This cursor is returned in the response of a previous request as nextCursor. If not specified, start from the first page of results.

Example: cursor=4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo
Responses
200

List of triggers

get/workflows/triggers
Response samples
application/json
{
  • "items": [
    ],
  • "nextCursor": "4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"
}

Create or update triggers

Required capabilities: workflowOrchestrationACL:WRITE

Create or update a trigger.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required
Array of objects = 1 items
Responses
200

List of created or updated triggers

post/workflows/triggers
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
{
  • "items": [
    ]
}

Delete triggers

Required capabilities: workflowOrchestrationACL:WRITE

Delete a trigger.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required
Array of objects = 1 items
Responses
200

Empty response.

post/workflows/triggers/delete
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
{ }

Get the run history of a trigger

Required capabilities: workflowOrchestrationACL:READ

Get information about every run of a trigger. This includes timing information and a reference to the started execution (or an explanation as to why it failed). The returned items are sorted by fireTime in descending order (newest first), followed by externalId in ascending order.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
triggerExternalId
required
string (TriggerExternalId) <= 255 characters

Identifier for a trigger. Must be unique for the project. No trailing or leading whitespace and no null characters allowed.

query Parameters
limit
integer (limit) [ 1 .. 1000 ]
Default: 100

The maximum number of results to return.

cursor
string (cursor)

Cursor to use for paging through results. This cursor is returned in the response of a previous request as nextCursor. If not specified, start from the first page of results.

Example: cursor=4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo
Responses
200

A list of runs of the trigger

404

The response for a failed request.

get/workflows/triggers/{triggerExternalId}/history
Request samples 
res = client.workflows.triggers.list_runs("my_trigger", limit=None)
Response samples
application/json
{
  • "items": [
    ]
}

Pause a trigger

Required capabilities: workflowOrchestrationACL:WRITE

Pauses a trigger. When paused, the trigger will not fire until it is resumed. Note: For data modeling and records stream triggers, processing continues where the last trigger run left off at pause time, not necessarily starting again on the freshest data. The cursor can become invalid if paused too long (stream retention applies).

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
triggerExternalId
required
string (TriggerExternalId) <= 255 characters

Identifier for a trigger. Must be unique for the project. No trailing or leading whitespace and no null characters allowed.

Responses
200

Empty response.

404

The trigger was not found

post/workflows/triggers/{triggerExternalId}/pause
Response samples
application/json
{ }

Resume a trigger

Required capabilities: workflowOrchestrationACL:WRITE

Resumes a trigger. Once resumed, the trigger will fire according to its configuration. Note: For data modelling and records stream triggers, processing continues where the last trigger run left off at pause time, not necessarily starting again on the freshest data. The cursor can become invalid if paused too long (stream retention applies).

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
triggerExternalId
required
string (TriggerExternalId) <= 255 characters

Identifier for a trigger. Must be unique for the project. No trailing or leading whitespace and no null characters allowed.

Responses
200

Empty response.

404

The trigger was not found

post/workflows/triggers/{triggerExternalId}/resume
Response samples
application/json
{ }
➔ Next to Tasks