Create subscriptions
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/processes/signals/subscriptions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "my.known.id",
"sink": {
"type": "email",
"externalId": "my.known.id"
},
"filter": {
"topic": "cognite_integrations",
"resource": "<string>",
"category": [
"<string>"
],
"extractorExternalId": "<string>",
"extractorVersion": "<string>"
}
}
]
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/processes/signals/subscriptions"
payload = { "items": [
{
"externalId": "my.known.id",
"sink": {
"type": "email",
"externalId": "my.known.id"
},
"filter": {
"topic": "cognite_integrations",
"resource": "<string>",
"category": ["<string>"],
"extractorExternalId": "<string>",
"extractorVersion": "<string>"
}
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
externalId: 'my.known.id',
sink: {type: 'email', externalId: 'my.known.id'},
filter: {
topic: 'cognite_integrations',
resource: '<string>',
category: ['<string>'],
extractorExternalId: '<string>',
extractorVersion: '<string>'
}
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/processes/signals/subscriptions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/processes/signals/subscriptions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'items' => [
[
'externalId' => 'my.known.id',
'sink' => [
'type' => 'email',
'externalId' => 'my.known.id'
],
'filter' => [
'topic' => 'cognite_integrations',
'resource' => '<string>',
'category' => [
'<string>'
],
'extractorExternalId' => '<string>',
'extractorVersion' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/processes/signals/subscriptions"
payload := strings.NewReader("{\n \"items\": [\n {\n \"externalId\": \"my.known.id\",\n \"sink\": {\n \"type\": \"email\",\n \"externalId\": \"my.known.id\"\n },\n \"filter\": {\n \"topic\": \"cognite_integrations\",\n \"resource\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"extractorExternalId\": \"<string>\",\n \"extractorVersion\": \"<string>\"\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{cluster}.cognitedata.com/api/v1/projects/{project}/processes/signals/subscriptions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"externalId\": \"my.known.id\",\n \"sink\": {\n \"type\": \"email\",\n \"externalId\": \"my.known.id\"\n },\n \"filter\": {\n \"topic\": \"cognite_integrations\",\n \"resource\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"extractorExternalId\": \"<string>\",\n \"extractorVersion\": \"<string>\"\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/processes/signals/subscriptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"externalId\": \"my.known.id\",\n \"sink\": {\n \"type\": \"email\",\n \"externalId\": \"my.known.id\"\n },\n \"filter\": {\n \"topic\": \"cognite_integrations\",\n \"resource\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"extractorExternalId\": \"<string>\",\n \"extractorVersion\": \"<string>\"\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"externalId": "my.known.id",
"sink": {
"type": "email",
"externalId": "my.known.id"
},
"filter": {
"topic": "cognite_integrations",
"resource": "<string>",
"category": [
"<string>"
],
"extractorExternalId": "<string>",
"extractorVersion": "<string>"
},
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000
}
]
}{
"error": {
"code": 400,
"message": "`null` values aren't allowed."
}
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}Create subscriptions
Required capabilities:
subscribeSignalsAcl:WRITE
Create one or more subscriptions in the project. A subscription ties a sink to a topic with a filter that determines which signals will be pushed out to the sink.
POST
/
processes
/
signals
/
subscriptions
Create subscriptions
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/processes/signals/subscriptions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "my.known.id",
"sink": {
"type": "email",
"externalId": "my.known.id"
},
"filter": {
"topic": "cognite_integrations",
"resource": "<string>",
"category": [
"<string>"
],
"extractorExternalId": "<string>",
"extractorVersion": "<string>"
}
}
]
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/processes/signals/subscriptions"
payload = { "items": [
{
"externalId": "my.known.id",
"sink": {
"type": "email",
"externalId": "my.known.id"
},
"filter": {
"topic": "cognite_integrations",
"resource": "<string>",
"category": ["<string>"],
"extractorExternalId": "<string>",
"extractorVersion": "<string>"
}
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
externalId: 'my.known.id',
sink: {type: 'email', externalId: 'my.known.id'},
filter: {
topic: 'cognite_integrations',
resource: '<string>',
category: ['<string>'],
extractorExternalId: '<string>',
extractorVersion: '<string>'
}
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/processes/signals/subscriptions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/processes/signals/subscriptions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'items' => [
[
'externalId' => 'my.known.id',
'sink' => [
'type' => 'email',
'externalId' => 'my.known.id'
],
'filter' => [
'topic' => 'cognite_integrations',
'resource' => '<string>',
'category' => [
'<string>'
],
'extractorExternalId' => '<string>',
'extractorVersion' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/processes/signals/subscriptions"
payload := strings.NewReader("{\n \"items\": [\n {\n \"externalId\": \"my.known.id\",\n \"sink\": {\n \"type\": \"email\",\n \"externalId\": \"my.known.id\"\n },\n \"filter\": {\n \"topic\": \"cognite_integrations\",\n \"resource\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"extractorExternalId\": \"<string>\",\n \"extractorVersion\": \"<string>\"\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{cluster}.cognitedata.com/api/v1/projects/{project}/processes/signals/subscriptions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"externalId\": \"my.known.id\",\n \"sink\": {\n \"type\": \"email\",\n \"externalId\": \"my.known.id\"\n },\n \"filter\": {\n \"topic\": \"cognite_integrations\",\n \"resource\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"extractorExternalId\": \"<string>\",\n \"extractorVersion\": \"<string>\"\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/processes/signals/subscriptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"externalId\": \"my.known.id\",\n \"sink\": {\n \"type\": \"email\",\n \"externalId\": \"my.known.id\"\n },\n \"filter\": {\n \"topic\": \"cognite_integrations\",\n \"resource\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"extractorExternalId\": \"<string>\",\n \"extractorVersion\": \"<string>\"\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"externalId": "my.known.id",
"sink": {
"type": "email",
"externalId": "my.known.id"
},
"filter": {
"topic": "cognite_integrations",
"resource": "<string>",
"category": [
"<string>"
],
"extractorExternalId": "<string>",
"extractorVersion": "<string>"
},
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000
}
]
}{
"error": {
"code": 400,
"message": "`null` values aren't allowed."
}
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}Authorizations
oidc-tokenoauth2-client-credentialsoauth2-open-industrial-dataoauth2-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 accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Body
application/json
Subscriptions to create.
Required array length:
1 - 10 elementsShow child attributes
Show child attributes
Response
Created subscriptions.
Maximum array length:
100Show child attributes
Show child attributes
Last modified on July 10, 2026
Was this page helpful?
⌘I