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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Cognite

Cognite Signals API

A signal is a notification that something has occurred in a CDF process. Users and systems may listen to signals by creating a sink and attaching subscriptions with a filter that matches the signals they are interested in.Subscriptions tie sinks to topics. Each topic represents some CDF resource like integrations or workflows. When a signal is emitted for a resource, all subscriptions for that resource's topic are evaluated. If the signal matches the subscription filter, it is pushed to the the sink.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 11 operations across 10 paths, and defines 59 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}.

11 operations 10 paths 59 schemas 2 GET9 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
Contact
Cognite Support
Resource Areas
1

Authentication & Security 5

Cognite Signals 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 11

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

Signals 11

A signal is a notification that something has occurred in a CDF process. Users and systems may listen to signals by creating a sink and attaching subscriptions with a filter that…

GET
/processes/signals/sinks
List sinks
listSignalSinks 2 params → 200400422
POST
/processes/signals/sinks
Create sinks
createSignalSinks body → 200400422
POST
/processes/signals/sinks/byids
Retrieve sinks by external IDs
retrieveSignalSinksByIds body → 200400422
POST
/processes/signals/sinks/delete
Delete sinks
deleteSignalSinks body → 200400422
POST
/processes/signals/sinks/update
Update sinks
updateSignalSinks body → 200400422
POST
/processes/signals/subscriptions
Create subscriptions
createSignalSubscriptions body → 200400422
POST
/processes/signals/subscriptions/list
Filter subscriptions
filterSignalSubscriptions body → 200400422
POST
/processes/signals/subscriptions/update
Update subscriptions
updateSignalSubscriptions body → 200400422
POST
/processes/signals/subscriptions/delete
Delete subscriptions
deleteSignalSubscriptions body → 200400422
POST
/processes/signals/list
List signals.
listSignals body → 200400422
GET
/processes/signals/topics
List topics
listSignalTopics → 200400

Schemas 59

The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are SignalsNotificationRead (9 properties), FilterSubscriptionsBase (5 properties), SubscriptionRead (5 properties), UserSink (5 properties). Each schema is shown below with its type and property counts.

SubscriptionFilterRequest
object
Request for filtering subscriptions.
3 properties
UpdateHostedExtractorsSubscriptionFilter
object
FilterWorkflowsSubscriptions
object
2 properties 1 required
FilterIsNull
object
Filter on whether the field is null.
1 property 1 required
SignalSeverity
string
The severity level of the signal.
UserSinkUpdateItem
object
Update a user sink.
3 properties 3 required
SubscriptionRead
object
A subscription item which includes the sink and filters available for that subscription. The filters here would be the metadata from the service the subscripti…
5 properties 5 required
Items_SubscriptionRead_WithCursor
object
2 properties 1 required
FilterSubscriptionsBase
object
5 properties
TopicRead
object
A topic supported by the signals service.
3 properties 3 required
UserSinkUpdate
object
Update request for a user sink.
EmailSinkUpdate
object
Update request for an email sink.
1 property
Items_SinkRead
object
1 property 1 required
EmailSinkUpdateItem
object
Update an e-mail sink.
3 properties 3 required
EpochTimestamp
integer
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
WorkflowsSubscriptionFilter
object
1 property 1 required
Items_TopicRead
object
List of topics.
1 property 1 required
IntegrationsSubscriptionFilter
object
3 properties 1 required
SubscriptionFilter
Filter used to select which signals will be received by a subscription. Omitted fields are ignored when filtering, allowing signals with any value in that fiel…
HostedExtractorsSignalMetadata
object
Metadata specific to hosted extractor signals.
3 properties
CurrentUserSinkId
object
1 property 2 required
CurrentUserSinkUpdateItem
object
Update the sink for the user making the request.
2 properties 3 required
SinkWrite
SupportedTopics
string
Topics supported by the service.
SignalsFilter
object
Filter for signals to list.
4 properties 1 required
UpdateIntegrationsSubscriptionFilter
object
2 properties
Items_SinkWrite
object
1 property 1 required
SignalsNotificationRead
object
A signal item
9 properties 8 required
Items_DeleteSinks
object
2 properties 1 required
Items_SubscriptionWrite
object
1 property 1 required
UserSink
object
Description of a user sink. The external ID of the sink matches a user in the user profiles API.
5 properties 4 required
UserSinkWrite
object
Request to create a user sink. The external ID of the sink must match a user in the user profiles API.
2 properties 2 required
ConcreteSinkId
ID of a sink.
SubscriptionUpdateItem
object
Update an existing subscription.
2 properties 2 required
UpdateWorkflowsSubscriptionFilter
object
SubscriptionFilterUpdate
object
3 properties
Items_UpdateSubscriptions
object
List of subscription updates.
1 property 1 required
SinkRead
EmailSinkWrite
object
Request to create an e-mail sink.
3 properties 3 required
RefSinkId
Reference to a sink. If the type is "user", the user must exist in the user profiles API.
Items_SignalRead_WithCursor
object
List of signals.
2 properties 1 required
UserSinkId
object
2 properties 2 required
WorkflowSignalMetadata
object
Metadata specific to workflow signals.
Items_SubscriptionRead
object
1 property 1 required
CogniteExternalId
string
The external ID provided by the client. Must be unique for the resource type.
SubscriptionWrite
object
Request to create a subscription.
3 properties 3 required
EmailSinkId
object
2 properties 2 required
IntegrationSignalMetadata
object
Metadata specific to integration signals.
2 properties
Items_RetrieveSinks
object
2 properties 1 required
HostedExtractorsSubscriptionFilter
object
1 property 1 required
SinkUpdateItem
Items_SinkRead_WithCursor
object
2 properties 1 required
Error
object
Cognite API error.
4 properties 2 required
EmailSink
object
Description of an e-mail sink.
5 properties 5 required
FilterIntegrationsSubscriptions
object
2 properties 1 required
HostedExtractorFilterProperties
object
Common properties for filtering hosted extractor signals.
3 properties
Items_SinkUpdate
object
1 property 1 required
FilterHostedExtractorsSubscriptions
object
2 properties 1 required
Items_DeleteSubscriptions
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cognite-signals-api-openapi.yml Raw ↑

Other APIs Cognite publishes across the network.

Cognite Data Fusion API
AE Profile APIs.io
Cognite 3D Asset Mapping API
AE Profile APIs.io
Cognite 3D Files API
AE Profile APIs.io
Cognite 3D Jobs API
AE Profile APIs.io
Cognite 3D Model Revisions API
AE Profile APIs.io
Cognite 3D Models API
AE Profile APIs.io
Cognite Annotations API
AE Profile APIs.io
Cognite Assets API
AE Profile APIs.io
Cognite Connections API
AE Profile APIs.io
Cognite Containers API
AE Profile APIs.io
Cognite Data models API
AE Profile APIs.io
Cognite Data point subscriptions API
AE Profile APIs.io
#Signals
← Back to C APIs
API Details
ID
cognite:cognite-signals-api
Base URL
https://api.cognitedata.com
Docs
https://api-docs.cognite.com/
Provider
Cognite
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=cognite-signals-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/cognite-signals-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Cognite Signals 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.