Events
Record event
Record one behavioral event for a person and/or custom object. This is the real-time path — it triggers journey enrollment. Unknown subjects still ingest and are linked later.
POST
/
api
/
v1
/
cdp
/
events
Record event
curl --request POST \
--url https://www.useboom.ai/api/v1/cdp/events \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"externalId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"personExternalId": "<string>",
"customObjectType": "<string>",
"customObjectExternalId": "<string>",
"properties": {}
}
'import requests
url = "https://www.useboom.ai/api/v1/cdp/events"
payload = {
"name": "<string>",
"externalId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"personExternalId": "<string>",
"customObjectType": "<string>",
"customObjectExternalId": "<string>",
"properties": {}
}
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({
name: '<string>',
externalId: '<string>',
timestamp: '2023-11-07T05:31:56Z',
personExternalId: '<string>',
customObjectType: '<string>',
customObjectExternalId: '<string>',
properties: {}
})
};
fetch('https://www.useboom.ai/api/v1/cdp/events', 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://www.useboom.ai/api/v1/cdp/events",
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([
'name' => '<string>',
'externalId' => '<string>',
'timestamp' => '2023-11-07T05:31:56Z',
'personExternalId' => '<string>',
'customObjectType' => '<string>',
'customObjectExternalId' => '<string>',
'properties' => [
]
]),
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://www.useboom.ai/api/v1/cdp/events"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"externalId\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"personExternalId\": \"<string>\",\n \"customObjectType\": \"<string>\",\n \"customObjectExternalId\": \"<string>\",\n \"properties\": {}\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://www.useboom.ai/api/v1/cdp/events")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"externalId\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"personExternalId\": \"<string>\",\n \"customObjectType\": \"<string>\",\n \"customObjectExternalId\": \"<string>\",\n \"properties\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.useboom.ai/api/v1/cdp/events")
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 \"name\": \"<string>\",\n \"externalId\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"personExternalId\": \"<string>\",\n \"customObjectType\": \"<string>\",\n \"customObjectExternalId\": \"<string>\",\n \"properties\": {}\n}"
response = http.request(request)
puts response.read_body{
"created": true,
"externalId": "<string>",
"eventId": "<string>",
"personId": "<string>",
"personExternalId": "<string>",
"customObjectType": "<string>",
"customObjectExternalId": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
Organization API key, sent as Authorization: Bearer boom_org_....
Body
application/json
Event name, e.g. "checkout_completed". Letters, numbers, underscores only.
Required string length:
1 - 255Pattern:
^[a-zA-Z0-9_]+$Your stable id for this event (idempotency key). Re-recording returns created: false.
Required string length:
1 - 255When the event occurred, ISO 8601. Defaults to now if omitted.
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Subject: the person externalId this event is about.
Required string length:
1 - 255Subject: the custom-object type name. Must be paired with customObjectExternalId.
Required string length:
1 - 255Subject: the custom-object externalId. Must be paired with customObjectType.
Required string length:
1 - 255Free-form event payload.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Record event
curl --request POST \
--url https://www.useboom.ai/api/v1/cdp/events \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"externalId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"personExternalId": "<string>",
"customObjectType": "<string>",
"customObjectExternalId": "<string>",
"properties": {}
}
'import requests
url = "https://www.useboom.ai/api/v1/cdp/events"
payload = {
"name": "<string>",
"externalId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"personExternalId": "<string>",
"customObjectType": "<string>",
"customObjectExternalId": "<string>",
"properties": {}
}
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({
name: '<string>',
externalId: '<string>',
timestamp: '2023-11-07T05:31:56Z',
personExternalId: '<string>',
customObjectType: '<string>',
customObjectExternalId: '<string>',
properties: {}
})
};
fetch('https://www.useboom.ai/api/v1/cdp/events', 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://www.useboom.ai/api/v1/cdp/events",
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([
'name' => '<string>',
'externalId' => '<string>',
'timestamp' => '2023-11-07T05:31:56Z',
'personExternalId' => '<string>',
'customObjectType' => '<string>',
'customObjectExternalId' => '<string>',
'properties' => [
]
]),
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://www.useboom.ai/api/v1/cdp/events"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"externalId\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"personExternalId\": \"<string>\",\n \"customObjectType\": \"<string>\",\n \"customObjectExternalId\": \"<string>\",\n \"properties\": {}\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://www.useboom.ai/api/v1/cdp/events")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"externalId\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"personExternalId\": \"<string>\",\n \"customObjectType\": \"<string>\",\n \"customObjectExternalId\": \"<string>\",\n \"properties\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.useboom.ai/api/v1/cdp/events")
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 \"name\": \"<string>\",\n \"externalId\": \"<string>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"personExternalId\": \"<string>\",\n \"customObjectType\": \"<string>\",\n \"customObjectExternalId\": \"<string>\",\n \"properties\": {}\n}"
response = http.request(request)
puts response.read_body{
"created": true,
"externalId": "<string>",
"eventId": "<string>",
"personId": "<string>",
"personExternalId": "<string>",
"customObjectType": "<string>",
"customObjectExternalId": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}