Ingest an identify event
curl --request POST \
--url https://api.orbit.devotel.io/cdp/v1/{ingest_id}/identify \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-orbit-cdp-nonce: <x-orbit-cdp-nonce>' \
--header 'x-orbit-cdp-signature: <x-orbit-cdp-signature>' \
--header 'x-orbit-cdp-timestamp: <x-orbit-cdp-timestamp>' \
--data '
{
"userId": "user_9f2a",
"traits": {
"email": "jordan@example.com",
"plan": "pro"
}
}
'import requests
url = "https://api.orbit.devotel.io/cdp/v1/{ingest_id}/identify"
payload = {
"userId": "user_9f2a",
"traits": {
"email": "jordan@example.com",
"plan": "pro"
}
}
headers = {
"x-orbit-cdp-signature": "<x-orbit-cdp-signature>",
"x-orbit-cdp-timestamp": "<x-orbit-cdp-timestamp>",
"x-orbit-cdp-nonce": "<x-orbit-cdp-nonce>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-orbit-cdp-signature': '<x-orbit-cdp-signature>',
'x-orbit-cdp-timestamp': '<x-orbit-cdp-timestamp>',
'x-orbit-cdp-nonce': '<x-orbit-cdp-nonce>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({userId: 'user_9f2a', traits: {email: 'jordan@example.com', plan: 'pro'}})
};
fetch('https://api.orbit.devotel.io/cdp/v1/{ingest_id}/identify', 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://api.orbit.devotel.io/cdp/v1/{ingest_id}/identify",
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([
'userId' => 'user_9f2a',
'traits' => [
'email' => 'jordan@example.com',
'plan' => 'pro'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-orbit-cdp-nonce: <x-orbit-cdp-nonce>",
"x-orbit-cdp-signature: <x-orbit-cdp-signature>",
"x-orbit-cdp-timestamp: <x-orbit-cdp-timestamp>"
],
]);
$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://api.orbit.devotel.io/cdp/v1/{ingest_id}/identify"
payload := strings.NewReader("{\n \"userId\": \"user_9f2a\",\n \"traits\": {\n \"email\": \"jordan@example.com\",\n \"plan\": \"pro\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-orbit-cdp-signature", "<x-orbit-cdp-signature>")
req.Header.Add("x-orbit-cdp-timestamp", "<x-orbit-cdp-timestamp>")
req.Header.Add("x-orbit-cdp-nonce", "<x-orbit-cdp-nonce>")
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://api.orbit.devotel.io/cdp/v1/{ingest_id}/identify")
.header("x-orbit-cdp-signature", "<x-orbit-cdp-signature>")
.header("x-orbit-cdp-timestamp", "<x-orbit-cdp-timestamp>")
.header("x-orbit-cdp-nonce", "<x-orbit-cdp-nonce>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"userId\": \"user_9f2a\",\n \"traits\": {\n \"email\": \"jordan@example.com\",\n \"plan\": \"pro\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/cdp/v1/{ingest_id}/identify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-orbit-cdp-signature"] = '<x-orbit-cdp-signature>'
request["x-orbit-cdp-timestamp"] = '<x-orbit-cdp-timestamp>'
request["x-orbit-cdp-nonce"] = '<x-orbit-cdp-nonce>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userId\": \"user_9f2a\",\n \"traits\": {\n \"email\": \"jordan@example.com\",\n \"plan\": \"pro\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"received": true,
"event_id": "<string>",
"contact_id": "<string>",
"contact_created": true
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}CDP
Ingest an identify event
Segment-compatible identify call — ties an anonymous session to a known user and upserts their traits onto a contact. Sign the raw body with your tenant ingest secret (x-orbit-cdp-* headers) and supply either userId (preferred) or anonymousId. Orbit upserts the contact keyed on that identity and reports whether the contact was newly created.
POST
/
cdp
/
v1
/
{ingest_id}
/
identify
Ingest an identify event
curl --request POST \
--url https://api.orbit.devotel.io/cdp/v1/{ingest_id}/identify \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-orbit-cdp-nonce: <x-orbit-cdp-nonce>' \
--header 'x-orbit-cdp-signature: <x-orbit-cdp-signature>' \
--header 'x-orbit-cdp-timestamp: <x-orbit-cdp-timestamp>' \
--data '
{
"userId": "user_9f2a",
"traits": {
"email": "jordan@example.com",
"plan": "pro"
}
}
'import requests
url = "https://api.orbit.devotel.io/cdp/v1/{ingest_id}/identify"
payload = {
"userId": "user_9f2a",
"traits": {
"email": "jordan@example.com",
"plan": "pro"
}
}
headers = {
"x-orbit-cdp-signature": "<x-orbit-cdp-signature>",
"x-orbit-cdp-timestamp": "<x-orbit-cdp-timestamp>",
"x-orbit-cdp-nonce": "<x-orbit-cdp-nonce>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-orbit-cdp-signature': '<x-orbit-cdp-signature>',
'x-orbit-cdp-timestamp': '<x-orbit-cdp-timestamp>',
'x-orbit-cdp-nonce': '<x-orbit-cdp-nonce>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({userId: 'user_9f2a', traits: {email: 'jordan@example.com', plan: 'pro'}})
};
fetch('https://api.orbit.devotel.io/cdp/v1/{ingest_id}/identify', 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://api.orbit.devotel.io/cdp/v1/{ingest_id}/identify",
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([
'userId' => 'user_9f2a',
'traits' => [
'email' => 'jordan@example.com',
'plan' => 'pro'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-orbit-cdp-nonce: <x-orbit-cdp-nonce>",
"x-orbit-cdp-signature: <x-orbit-cdp-signature>",
"x-orbit-cdp-timestamp: <x-orbit-cdp-timestamp>"
],
]);
$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://api.orbit.devotel.io/cdp/v1/{ingest_id}/identify"
payload := strings.NewReader("{\n \"userId\": \"user_9f2a\",\n \"traits\": {\n \"email\": \"jordan@example.com\",\n \"plan\": \"pro\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-orbit-cdp-signature", "<x-orbit-cdp-signature>")
req.Header.Add("x-orbit-cdp-timestamp", "<x-orbit-cdp-timestamp>")
req.Header.Add("x-orbit-cdp-nonce", "<x-orbit-cdp-nonce>")
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://api.orbit.devotel.io/cdp/v1/{ingest_id}/identify")
.header("x-orbit-cdp-signature", "<x-orbit-cdp-signature>")
.header("x-orbit-cdp-timestamp", "<x-orbit-cdp-timestamp>")
.header("x-orbit-cdp-nonce", "<x-orbit-cdp-nonce>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"userId\": \"user_9f2a\",\n \"traits\": {\n \"email\": \"jordan@example.com\",\n \"plan\": \"pro\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/cdp/v1/{ingest_id}/identify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-orbit-cdp-signature"] = '<x-orbit-cdp-signature>'
request["x-orbit-cdp-timestamp"] = '<x-orbit-cdp-timestamp>'
request["x-orbit-cdp-nonce"] = '<x-orbit-cdp-nonce>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userId\": \"user_9f2a\",\n \"traits\": {\n \"email\": \"jordan@example.com\",\n \"plan\": \"pro\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"received": true,
"event_id": "<string>",
"contact_id": "<string>",
"contact_created": true
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Headers
HMAC-SHA256 of the raw request body, keyed by the tenant ingest secret.
Unix-epoch seconds the payload was signed; rejected outside the replay window.
Unique per-request nonce used to reject replays.
Path Parameters
Public, tenant-bound ingest identifier from your CDP source config.
Body
application/json
⌘I