Skip to main content
POST
/
processes
/
signals
/
sinks
Create sinks
curl --request POST \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/processes/signals/sinks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "type": "email",
      "externalId": "my.known.id",
      "emailAddress": "<string>"
    }
  ]
}
'
import requests

url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/processes/signals/sinks"

payload = { "items": [
{
"type": "email",
"externalId": "my.known.id",
"emailAddress": "<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: [{type: 'email', externalId: 'my.known.id', emailAddress: '<string>'}]})
};

fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/processes/signals/sinks', 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/sinks",
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' => [
[
'type' => 'email',
'externalId' => 'my.known.id',
'emailAddress' => '<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/sinks"

payload := strings.NewReader("{\n \"items\": [\n {\n \"type\": \"email\",\n \"externalId\": \"my.known.id\",\n \"emailAddress\": \"<string>\"\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/sinks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"type\": \"email\",\n \"externalId\": \"my.known.id\",\n \"emailAddress\": \"<string>\"\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/processes/signals/sinks")

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 \"type\": \"email\",\n \"externalId\": \"my.known.id\",\n \"emailAddress\": \"<string>\"\n }\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "items": [
    {
      "type": "email",
      "externalId": "my.known.id",
      "emailAddress": "<string>",
      "createdTime": 1730204346000,
      "lastUpdatedTime": 1730204346000
    }
  ]
}
{
"error": {
"code": 400,
"message": "`null` values aren't allowed."
}
}
{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}

Authorizations

Authorization
string
header
required

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

Sinks to create.

items
(EmailSinkWrite · object | UserSinkWrite · object)[]
required
Required array length: 1 - 100 elements

Request to create an e-mail sink.

Response

Created sinks.

items
(EmailSinkWrite · object | UserSinkWrite · object)[]
required
Required array length: 1 - 100 elements

Description of an e-mail sink.

Last modified on July 10, 2026