Ingest a CDP screen view
curl --request POST \
--url https://api.orbit.devotel.io/cdp/v1/{ingest_id}/screen \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"userId": "user_12345",
"anonymousId": "anon_8f3d2c1a",
"name": "ProductDetail",
"category": "Shop",
"properties": {
"product_id": "sku_4412"
},
"context": {
"device": {
"model": "iPhone17,2"
},
"os": {
"name": "iOS",
"version": "26.0"
}
},
"timestamp": "2026-10-11T09:24:00.000Z",
"messageId": "msg_Ps3Lm8Kd"
}
'import requests
url = "https://api.orbit.devotel.io/cdp/v1/{ingest_id}/screen"
payload = {
"userId": "user_12345",
"anonymousId": "anon_8f3d2c1a",
"name": "ProductDetail",
"category": "Shop",
"properties": { "product_id": "sku_4412" },
"context": {
"device": { "model": "iPhone17,2" },
"os": {
"name": "iOS",
"version": "26.0"
}
},
"timestamp": "2026-10-11T09:24:00.000Z",
"messageId": "msg_Ps3Lm8Kd"
}
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({
userId: 'user_12345',
anonymousId: 'anon_8f3d2c1a',
name: 'ProductDetail',
category: 'Shop',
properties: {product_id: 'sku_4412'},
context: {device: {model: 'iPhone17,2'}, os: {name: 'iOS', version: '26.0'}},
timestamp: '2026-10-11T09:24:00.000Z',
messageId: 'msg_Ps3Lm8Kd'
})
};
fetch('https://api.orbit.devotel.io/cdp/v1/{ingest_id}/screen', 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}/screen",
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_12345',
'anonymousId' => 'anon_8f3d2c1a',
'name' => 'ProductDetail',
'category' => 'Shop',
'properties' => [
'product_id' => 'sku_4412'
],
'context' => [
'device' => [
'model' => 'iPhone17,2'
],
'os' => [
'name' => 'iOS',
'version' => '26.0'
]
],
'timestamp' => '2026-10-11T09:24:00.000Z',
'messageId' => 'msg_Ps3Lm8Kd'
]),
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://api.orbit.devotel.io/cdp/v1/{ingest_id}/screen"
payload := strings.NewReader("{\n \"userId\": \"user_12345\",\n \"anonymousId\": \"anon_8f3d2c1a\",\n \"name\": \"ProductDetail\",\n \"category\": \"Shop\",\n \"properties\": {\n \"product_id\": \"sku_4412\"\n },\n \"context\": {\n \"device\": {\n \"model\": \"iPhone17,2\"\n },\n \"os\": {\n \"name\": \"iOS\",\n \"version\": \"26.0\"\n }\n },\n \"timestamp\": \"2026-10-11T09:24:00.000Z\",\n \"messageId\": \"msg_Ps3Lm8Kd\"\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://api.orbit.devotel.io/cdp/v1/{ingest_id}/screen")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"userId\": \"user_12345\",\n \"anonymousId\": \"anon_8f3d2c1a\",\n \"name\": \"ProductDetail\",\n \"category\": \"Shop\",\n \"properties\": {\n \"product_id\": \"sku_4412\"\n },\n \"context\": {\n \"device\": {\n \"model\": \"iPhone17,2\"\n },\n \"os\": {\n \"name\": \"iOS\",\n \"version\": \"26.0\"\n }\n },\n \"timestamp\": \"2026-10-11T09:24:00.000Z\",\n \"messageId\": \"msg_Ps3Lm8Kd\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/cdp/v1/{ingest_id}/screen")
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 \"userId\": \"user_12345\",\n \"anonymousId\": \"anon_8f3d2c1a\",\n \"name\": \"ProductDetail\",\n \"category\": \"Shop\",\n \"properties\": {\n \"product_id\": \"sku_4412\"\n },\n \"context\": {\n \"device\": {\n \"model\": \"iPhone17,2\"\n },\n \"os\": {\n \"name\": \"iOS\",\n \"version\": \"26.0\"\n }\n },\n \"timestamp\": \"2026-10-11T09:24:00.000Z\",\n \"messageId\": \"msg_Ps3Lm8Kd\"\n}"
response = http.request(request)
puts response.read_body{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Misc
Ingest a CDP screen view
Record a mobile-app screen view (Segment-compatible screen) under the tenant’s ingest source ingest_id — the mobile equivalent of page, with the same body shape (userId or anonymousId, optional name/category, and properties) so downstream consumers can split mobile screens from web pageviews by the event type. Authenticates with HMAC-SHA256 of the raw body using the source’s ingest secret.
POST
/
cdp
/
v1
/
{ingest_id}
/
screen
Ingest a CDP screen view
curl --request POST \
--url https://api.orbit.devotel.io/cdp/v1/{ingest_id}/screen \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"userId": "user_12345",
"anonymousId": "anon_8f3d2c1a",
"name": "ProductDetail",
"category": "Shop",
"properties": {
"product_id": "sku_4412"
},
"context": {
"device": {
"model": "iPhone17,2"
},
"os": {
"name": "iOS",
"version": "26.0"
}
},
"timestamp": "2026-10-11T09:24:00.000Z",
"messageId": "msg_Ps3Lm8Kd"
}
'import requests
url = "https://api.orbit.devotel.io/cdp/v1/{ingest_id}/screen"
payload = {
"userId": "user_12345",
"anonymousId": "anon_8f3d2c1a",
"name": "ProductDetail",
"category": "Shop",
"properties": { "product_id": "sku_4412" },
"context": {
"device": { "model": "iPhone17,2" },
"os": {
"name": "iOS",
"version": "26.0"
}
},
"timestamp": "2026-10-11T09:24:00.000Z",
"messageId": "msg_Ps3Lm8Kd"
}
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({
userId: 'user_12345',
anonymousId: 'anon_8f3d2c1a',
name: 'ProductDetail',
category: 'Shop',
properties: {product_id: 'sku_4412'},
context: {device: {model: 'iPhone17,2'}, os: {name: 'iOS', version: '26.0'}},
timestamp: '2026-10-11T09:24:00.000Z',
messageId: 'msg_Ps3Lm8Kd'
})
};
fetch('https://api.orbit.devotel.io/cdp/v1/{ingest_id}/screen', 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}/screen",
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_12345',
'anonymousId' => 'anon_8f3d2c1a',
'name' => 'ProductDetail',
'category' => 'Shop',
'properties' => [
'product_id' => 'sku_4412'
],
'context' => [
'device' => [
'model' => 'iPhone17,2'
],
'os' => [
'name' => 'iOS',
'version' => '26.0'
]
],
'timestamp' => '2026-10-11T09:24:00.000Z',
'messageId' => 'msg_Ps3Lm8Kd'
]),
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://api.orbit.devotel.io/cdp/v1/{ingest_id}/screen"
payload := strings.NewReader("{\n \"userId\": \"user_12345\",\n \"anonymousId\": \"anon_8f3d2c1a\",\n \"name\": \"ProductDetail\",\n \"category\": \"Shop\",\n \"properties\": {\n \"product_id\": \"sku_4412\"\n },\n \"context\": {\n \"device\": {\n \"model\": \"iPhone17,2\"\n },\n \"os\": {\n \"name\": \"iOS\",\n \"version\": \"26.0\"\n }\n },\n \"timestamp\": \"2026-10-11T09:24:00.000Z\",\n \"messageId\": \"msg_Ps3Lm8Kd\"\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://api.orbit.devotel.io/cdp/v1/{ingest_id}/screen")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"userId\": \"user_12345\",\n \"anonymousId\": \"anon_8f3d2c1a\",\n \"name\": \"ProductDetail\",\n \"category\": \"Shop\",\n \"properties\": {\n \"product_id\": \"sku_4412\"\n },\n \"context\": {\n \"device\": {\n \"model\": \"iPhone17,2\"\n },\n \"os\": {\n \"name\": \"iOS\",\n \"version\": \"26.0\"\n }\n },\n \"timestamp\": \"2026-10-11T09:24:00.000Z\",\n \"messageId\": \"msg_Ps3Lm8Kd\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/cdp/v1/{ingest_id}/screen")
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 \"userId\": \"user_12345\",\n \"anonymousId\": \"anon_8f3d2c1a\",\n \"name\": \"ProductDetail\",\n \"category\": \"Shop\",\n \"properties\": {\n \"product_id\": \"sku_4412\"\n },\n \"context\": {\n \"device\": {\n \"model\": \"iPhone17,2\"\n },\n \"os\": {\n \"name\": \"iOS\",\n \"version\": \"26.0\"\n }\n },\n \"timestamp\": \"2026-10-11T09:24:00.000Z\",\n \"messageId\": \"msg_Ps3Lm8Kd\"\n}"
response = http.request(request)
puts response.read_body{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Headers
Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.
Required string length:
1 - 255Sandbox opt-in for Clerk-session-authenticated requests — see Test mode explained for the full credential-header matrix and worked samples. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.
Available options:
true, false Path Parameters
Body
application/json
Known-user identifier (supply userId or anonymousId — at least one is required).
Example:
"user_12345"
Anonymous session identifier.
Example:
"anon_8f3d2c1a"
The screen name, e.g. ProductDetail.
Example:
"ProductDetail"
Optional screen category, e.g. Shop.
Example:
"Shop"
Screen properties (product id, referrer screen, …).
Example:
{ "product_id": "sku_4412" }
Segment context block (device, os, app version, …).
Example:
{
"device": { "model": "iPhone17,2" },
"os": { "name": "iOS", "version": "26.0" }
}
When the screen view occurred (ISO 8601).
Example:
"2026-10-11T09:24:00.000Z"
Idempotency key — retries with the same messageId deduplicate.
Example:
"msg_Ps3Lm8Kd"
Response
The ingest acknowledgement — received, the stored event_id, and the resolved contact_id — in the standard { data, meta } envelope.