How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cognite Workflow triggers API

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

Cognite Workflow triggers API is one of 90 APIs that Cognite publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include WorkflowTriggers. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 5 paths, and defines 77 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://{cluster}.cognitedata.com/api/v1/projects/{project}.

6 operations 5 paths 77 schemas 2 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.cognitedata.com
Authentication
HTTP Bearer, OAuth 2.0, OAuth 2.0, OAuth 2.0, OpenID Connect
Resource Areas
1

Authentication & Security 5

Cognite Workflow triggers API declares 5 security schemes for authenticating requests. It accepts HTTP bearer tokens (OpenID Connect or OAuth2 token) (oidc-token). It supports OAuth 2.0 (oauth2-client-credentials) using the clientCredentials flow, exposing 1 scope. It supports OAuth 2.0 (oauth2-auth-code) using the authorizationCode flow, exposing 1 scope. It supports OAuth 2.0 (oauth2-open-industrial-data) using the clientCredentials flow, exposing 1 scope. It supports OpenID Connect (org-oidc-token) discovered at https://auth.cognite.com/.well-known/openid-configuration. By default, every request must be authenticated.

  • oidc-token — Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to acce…
  • oauth2-client-credentials — Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to acce…
  • oauth2-auth-code — Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to acce…
  • oauth2-open-industrial-data — Auth flow for Open Industrial Data. Get your client secret from https://hub.cognite.com/open-industrial-data-211.
  • org-oidc-token — Access token issued by the Cognite authorization server, and valid for the target organization. The token must be an OpenID Connect token, and it can be obtain…

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 2 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Workflow triggers 6

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

GET
/workflows/triggers
List triggers
FetchAllTriggers 2 params → 200
POST
/workflows/triggers
Create or update triggers
CreateOrUpdateTriggers body → 200
POST
/workflows/triggers/delete
Delete triggers
deleteTriggers body → 200
GET
/workflows/triggers/{triggerExternalId}/history
Get the run history of a trigger
getTriggerHistory 3 params → 200404
POST
/workflows/triggers/{triggerExternalId}/pause
Pause a trigger
pauseTrigger 1 param → 200404
POST
/workflows/triggers/{triggerExternalId}/resume
Resume a trigger
resumeTrigger 1 param → 200404

Schemas 77

The contract defines 77 schemas that model the data the API accepts and returns. The most detailed are TriggerView (9 properties), SyncEdgeTableExpressionV3 (5 properties), SyncNodeTableExpressionV3 (5 properties), Error (4 properties). Each schema is shown below with its type and property counts.

EqualsFilterV3
object
1 property 1 required
TriggerRule
PropertyIdentifierV3
string
DataModelsNestedFilter
object
1 property 1 required
SyncNodeTableExpressionV3
object
The synchronization query to use when we listen for changes to nodes. The nodes must also match the specified filter.
5 properties 1 required
TableExpressionPrefixFilterV3
object
1 property 1 required
TableExpressionRangeFilterV3
object
1 property 1 required
SourceSelectorV3
array
ViewPropertyReference
object
2 properties 2 required
ThroughReference
object
Traverse from another table expression using a direct relation. Only applicable when from is specified. The view or container property to use when we traverse…
2 properties 2 required
ContainsAllFilterV3
object
1 property 1 required
UnitReference
object
Target unit reference.
1 property 1 required
InFilterV3
object
1 property 1 required
SyncEdgeTableExpressionV3
object
The synchronization query to use when we listen for changes to edges. The edges must also match the specified filter.
5 properties 1 required
SyncMode
string
Specify whether to sync all instances in a single phase (onePhase - default) or two phases (twoPhase), or to skip the backfill phase noBackfill. With onePhase,…
PrefixFilterV3
object
1 property 1 required
TableExpressionOverlapsFilterV3
object
1 property 1 required
TableExpressionFilterValueRange
Version
string
Identifier for a version. Must be unique for the workflow. No trailing or leading whitespace and no null characters allowed.
SyncSelectV3
object
Define which view to return properties for, and the properties to return. Up to 10 views can be specified per query.
1 property
DataModelingTrigger
object
4 properties 4 required
OverlapsFilterV3
object
1 property 1 required
SourceReference
Reference to a view, or a container
TableExpressionSyncLimit
integer
Limits the number of instances in the result set generated by this table expression. We recommend to to not use a value lower than 100, as this will result in…
cursor
string
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 p…
EpochTimestamp
integer
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
TableExpressionEqualsFilterV3
object
1 property 1 required
TableExpressionChainToDefinition
string
Default: "destination". Applicable when from is an edge result expression. Control which side of the edges in from to chain to. The behavior depends on the dir…
TableExpressionLeafFilter
object
Leaf filter
TableExpressionFilterValue
NodeTableExpressionThrough
DMSFilterProperty
array
A reference to either a DMS base property or a container property. For nodes the DMS base properties are instanceType, version, space, externalId, type, create…
NodeOrEdgeExternalId
string
ContainsAnyFilterV3
object
1 property 1 required
PropertySortV3
object
3 properties 1 required
DMSVersion
string
metadata
object
Custom, application-specific metadata. String key - String value. Keys have a maximum length of 32 characters, values a maximum of 255, and there can be a maxi…
TableExpressionInFilterV3
object
1 property 1 required
FilterDefinition
object
A filter Domain Specific Language (DSL) used to create advanced filter queries.
FilterValue
DataModelsLeafFilter
object
Leaf filter
CronTrigger
object
3 properties 2 required
RawPropertyValueV3
A value matching the data type of the defined property
ExecutionInput
object
Input data to the workflow. The content of the input data can be used as input to the workflow tasks using references. The input data should be in JSON format,…
UnitSystemReference
object
Target system to convert data to. Can be used instead of targetUnit to identify the unit to convert to.
1 property 1 required
TableExpressionContainsAnyFilterV3
object
1 property 1 required
TableExpressionDataModelsBoolFilter
object
Build a new query by combining other queries, using boolean operators. We support the and, or, and not boolean operators.
HasExistingDataFilterV3
object
1 property 1 required
MatchAllFilter
object
1 property 1 required
SyncTableExpressionV3
TableExpressionFilterDefinition
object
A filter Domain Specific Language (DSL) used to create advanced filter queries.
DataModelsBoolFilter
object
Build a new query by combining other queries, using boolean operators. We support the and, or, and not boolean operators.
BackfillSort
array
Optionally sort synced instances during the backfill phase of a two-phase sync. The properties sorted on must have a cursorable index on them. Can only be spec…
ViewReference
object
Reference to a view
4 properties 4 required
Authentication
object
1 property 1 required
FilterValueRange
RangeFilterV3
object
1 property 1 required
ContainerReference
object
Reference to an existing container
3 properties 3 required
InstanceReferenceFilterV3
object
1 property 1 required
nextCursor
string
Cursor to get the next page of results. If not present, no more results are available.
SpaceSpecification
string
TableExpressionFilterValueList
DMSExternalId
string
TableExpressionContainsAllFilterV3
object
1 property 1 required
RangeValue
Value you wish to find in the provided property using a range clause.
ParameterizedPropertyValueV3
object
A parameterized value
1 property 1 required
TriggerView
object
9 properties
limit
integer
The maximum number of results to return.
WorkflowExternalId
string
Identifier for a workflow. Must be unique for the project. No trailing or leading whitespace and no null characters allowed.
TargetUnits
array
Properties to convert to another unit. The API can only convert to another unit, if a unit has been defined as part of the type on the underlying container bei…
RawPropertyValueListV3
array
A list of values
FilterValueList
ReferencedPropertyValueV3
object
A property reference value
1 property 1 required
DMSExistsFilter
object
1 property 1 required
Error
object
Cognite API error.
4 properties 2 required
TargetUnit
object
Describes a target unit for a property.
2 properties 2 required
TriggerExternalId
string
Identifier for a trigger. Must be unique for the project. No trailing or leading whitespace and no null characters allowed.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cognite-workflow-triggers-api-openapi.yml Raw ↑

Other APIs Cognite publishes across the network.

Cognite Data Fusion API
Cognite 3D Asset Mapping API
Cognite 3D Files API
Cognite 3D Jobs API
Cognite 3D Model Revisions API
Cognite 3D Models API
Cognite Annotations API
Cognite Assets API
Cognite Connections API
Cognite Containers API
Cognite Data models API
Cognite Data point subscriptions API
Where this information came from

This is an independent, third-party profile of Cognite Workflow triggers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.