Create or update a tracking-plan event
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/cdp/tracking-plan \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"event_name": "Order Completed",
"description": "Fired when a checkout completes successfully.",
"properties_schema": {
"properties": {
"order_id": {
"type": "string"
},
"total": {
"type": "number"
}
},
"required": [
"order_id",
"total"
]
},
"enforcement": "strict"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/cdp/tracking-plan"
payload = {
"event_name": "Order Completed",
"description": "Fired when a checkout completes successfully.",
"properties_schema": {
"properties": {
"order_id": { "type": "string" },
"total": { "type": "number" }
},
"required": ["order_id", "total"]
},
"enforcement": "strict"
}
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({
event_name: 'Order Completed',
description: 'Fired when a checkout completes successfully.',
properties_schema: {
properties: {order_id: {type: 'string'}, total: {type: 'number'}},
required: ['order_id', 'total']
},
enforcement: 'strict'
})
};
fetch('https://api.orbit.devotel.io/api/v1/cdp/tracking-plan', 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/api/v1/cdp/tracking-plan",
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([
'event_name' => 'Order Completed',
'description' => 'Fired when a checkout completes successfully.',
'properties_schema' => [
'properties' => [
'order_id' => [
'type' => 'string'
],
'total' => [
'type' => 'number'
]
],
'required' => [
'order_id',
'total'
]
],
'enforcement' => 'strict'
]),
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/api/v1/cdp/tracking-plan"
payload := strings.NewReader("{\n \"event_name\": \"Order Completed\",\n \"description\": \"Fired when a checkout completes successfully.\",\n \"properties_schema\": {\n \"properties\": {\n \"order_id\": {\n \"type\": \"string\"\n },\n \"total\": {\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"order_id\",\n \"total\"\n ]\n },\n \"enforcement\": \"strict\"\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/api/v1/cdp/tracking-plan")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"event_name\": \"Order Completed\",\n \"description\": \"Fired when a checkout completes successfully.\",\n \"properties_schema\": {\n \"properties\": {\n \"order_id\": {\n \"type\": \"string\"\n },\n \"total\": {\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"order_id\",\n \"total\"\n ]\n },\n \"enforcement\": \"strict\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/cdp/tracking-plan")
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 \"event_name\": \"Order Completed\",\n \"description\": \"Fired when a checkout completes successfully.\",\n \"properties_schema\": {\n \"properties\": {\n \"order_id\": {\n \"type\": \"string\"\n },\n \"total\": {\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"order_id\",\n \"total\"\n ]\n },\n \"enforcement\": \"strict\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"event_name": "<string>",
"description": "<string>",
"properties_schema": {},
"required_properties": [
"<string>"
],
"enforcement": "soft",
"created_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}CDP
Create or update a tracking-plan event
Upsert one event’s declared schema in the tracking plan. Supply the event_name, an optional human description, a properties_schema describing allowed/required properties, and an enforcement mode — soft records violations without blocking ingest, strict rejects non-conforming events. Required-property lists from required_properties and properties_schema.required are merged and de-duplicated. Owner / admin / developer only.
POST
/
api
/
v1
/
cdp
/
tracking-plan
Create or update a tracking-plan event
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/cdp/tracking-plan \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"event_name": "Order Completed",
"description": "Fired when a checkout completes successfully.",
"properties_schema": {
"properties": {
"order_id": {
"type": "string"
},
"total": {
"type": "number"
}
},
"required": [
"order_id",
"total"
]
},
"enforcement": "strict"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/cdp/tracking-plan"
payload = {
"event_name": "Order Completed",
"description": "Fired when a checkout completes successfully.",
"properties_schema": {
"properties": {
"order_id": { "type": "string" },
"total": { "type": "number" }
},
"required": ["order_id", "total"]
},
"enforcement": "strict"
}
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({
event_name: 'Order Completed',
description: 'Fired when a checkout completes successfully.',
properties_schema: {
properties: {order_id: {type: 'string'}, total: {type: 'number'}},
required: ['order_id', 'total']
},
enforcement: 'strict'
})
};
fetch('https://api.orbit.devotel.io/api/v1/cdp/tracking-plan', 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/api/v1/cdp/tracking-plan",
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([
'event_name' => 'Order Completed',
'description' => 'Fired when a checkout completes successfully.',
'properties_schema' => [
'properties' => [
'order_id' => [
'type' => 'string'
],
'total' => [
'type' => 'number'
]
],
'required' => [
'order_id',
'total'
]
],
'enforcement' => 'strict'
]),
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/api/v1/cdp/tracking-plan"
payload := strings.NewReader("{\n \"event_name\": \"Order Completed\",\n \"description\": \"Fired when a checkout completes successfully.\",\n \"properties_schema\": {\n \"properties\": {\n \"order_id\": {\n \"type\": \"string\"\n },\n \"total\": {\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"order_id\",\n \"total\"\n ]\n },\n \"enforcement\": \"strict\"\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/api/v1/cdp/tracking-plan")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"event_name\": \"Order Completed\",\n \"description\": \"Fired when a checkout completes successfully.\",\n \"properties_schema\": {\n \"properties\": {\n \"order_id\": {\n \"type\": \"string\"\n },\n \"total\": {\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"order_id\",\n \"total\"\n ]\n },\n \"enforcement\": \"strict\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/cdp/tracking-plan")
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 \"event_name\": \"Order Completed\",\n \"description\": \"Fired when a checkout completes successfully.\",\n \"properties_schema\": {\n \"properties\": {\n \"order_id\": {\n \"type\": \"string\"\n },\n \"total\": {\n \"type\": \"number\"\n }\n },\n \"required\": [\n \"order_id\",\n \"total\"\n ]\n },\n \"enforcement\": \"strict\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"event_name": "<string>",
"description": "<string>",
"properties_schema": {},
"required_properties": [
"<string>"
],
"enforcement": "soft",
"created_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Body
application/json
Required string length:
1 - 200Maximum string length:
2000JSON-Schema-style definition of the event's properties (properties, required, optional classification).
Maximum array length:
64Available options:
soft, strict Response
200 - application/json
The upserted tracking-plan event
⌘I