curl --request POST \
--url http://localhost:3001/api/v1/events \
--header 'Content-Type: application/json' \
--header 'idempotency-key: <idempotency-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"event": "<string>",
"profile": {
"email": "jsmith@example.com",
"externalId": "<string>",
"properties": {}
},
"data": {},
"referenceId": "<string>",
"redactedDataPaths": [
"<string>"
],
"occurredAt": "2023-11-07T05:31:56Z"
}
'import requests
url = "http://localhost:3001/api/v1/events"
payload = {
"event": "<string>",
"profile": {
"email": "jsmith@example.com",
"externalId": "<string>",
"properties": {}
},
"data": {},
"referenceId": "<string>",
"redactedDataPaths": ["<string>"],
"occurredAt": "2023-11-07T05:31:56Z"
}
headers = {
"idempotency-key": "<idempotency-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'idempotency-key': '<idempotency-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
event: '<string>',
profile: {email: 'jsmith@example.com', externalId: '<string>', properties: {}},
data: {},
referenceId: '<string>',
redactedDataPaths: ['<string>'],
occurredAt: '2023-11-07T05:31:56Z'
})
};
fetch('http://localhost:3001/api/v1/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_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/api/v1/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([
'event' => '<string>',
'profile' => [
'email' => 'jsmith@example.com',
'externalId' => '<string>',
'properties' => [
]
],
'data' => [
],
'referenceId' => '<string>',
'redactedDataPaths' => [
'<string>'
],
'occurredAt' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"idempotency-key: <idempotency-key>",
"x-api-key: <api-key>"
],
]);
$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 := "http://localhost:3001/api/v1/events"
payload := strings.NewReader("{\n \"event\": \"<string>\",\n \"profile\": {\n \"email\": \"jsmith@example.com\",\n \"externalId\": \"<string>\",\n \"properties\": {}\n },\n \"data\": {},\n \"referenceId\": \"<string>\",\n \"redactedDataPaths\": [\n \"<string>\"\n ],\n \"occurredAt\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("idempotency-key", "<idempotency-key>")
req.Header.Add("x-api-key", "<api-key>")
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("http://localhost:3001/api/v1/events")
.header("idempotency-key", "<idempotency-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"event\": \"<string>\",\n \"profile\": {\n \"email\": \"jsmith@example.com\",\n \"externalId\": \"<string>\",\n \"properties\": {}\n },\n \"data\": {},\n \"referenceId\": \"<string>\",\n \"redactedDataPaths\": [\n \"<string>\"\n ],\n \"occurredAt\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/v1/events")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["idempotency-key"] = '<idempotency-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"event\": \"<string>\",\n \"profile\": {\n \"email\": \"jsmith@example.com\",\n \"externalId\": \"<string>\",\n \"properties\": {}\n },\n \"data\": {},\n \"referenceId\": \"<string>\",\n \"redactedDataPaths\": [\n \"<string>\"\n ],\n \"occurredAt\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"eventId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"profileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"matchedJourneys": 4503599627370495,
"enrolledJourneys": 4503599627370495,
"skippedJourneys": 4503599627370495
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}Track event
Accept one server-side identified business event, persist a UserEvent, and trigger matching active Journeys.
curl --request POST \
--url http://localhost:3001/api/v1/events \
--header 'Content-Type: application/json' \
--header 'idempotency-key: <idempotency-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"event": "<string>",
"profile": {
"email": "jsmith@example.com",
"externalId": "<string>",
"properties": {}
},
"data": {},
"referenceId": "<string>",
"redactedDataPaths": [
"<string>"
],
"occurredAt": "2023-11-07T05:31:56Z"
}
'import requests
url = "http://localhost:3001/api/v1/events"
payload = {
"event": "<string>",
"profile": {
"email": "jsmith@example.com",
"externalId": "<string>",
"properties": {}
},
"data": {},
"referenceId": "<string>",
"redactedDataPaths": ["<string>"],
"occurredAt": "2023-11-07T05:31:56Z"
}
headers = {
"idempotency-key": "<idempotency-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'idempotency-key': '<idempotency-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
event: '<string>',
profile: {email: 'jsmith@example.com', externalId: '<string>', properties: {}},
data: {},
referenceId: '<string>',
redactedDataPaths: ['<string>'],
occurredAt: '2023-11-07T05:31:56Z'
})
};
fetch('http://localhost:3001/api/v1/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_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/api/v1/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([
'event' => '<string>',
'profile' => [
'email' => 'jsmith@example.com',
'externalId' => '<string>',
'properties' => [
]
],
'data' => [
],
'referenceId' => '<string>',
'redactedDataPaths' => [
'<string>'
],
'occurredAt' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"idempotency-key: <idempotency-key>",
"x-api-key: <api-key>"
],
]);
$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 := "http://localhost:3001/api/v1/events"
payload := strings.NewReader("{\n \"event\": \"<string>\",\n \"profile\": {\n \"email\": \"jsmith@example.com\",\n \"externalId\": \"<string>\",\n \"properties\": {}\n },\n \"data\": {},\n \"referenceId\": \"<string>\",\n \"redactedDataPaths\": [\n \"<string>\"\n ],\n \"occurredAt\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("idempotency-key", "<idempotency-key>")
req.Header.Add("x-api-key", "<api-key>")
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("http://localhost:3001/api/v1/events")
.header("idempotency-key", "<idempotency-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"event\": \"<string>\",\n \"profile\": {\n \"email\": \"jsmith@example.com\",\n \"externalId\": \"<string>\",\n \"properties\": {}\n },\n \"data\": {},\n \"referenceId\": \"<string>\",\n \"redactedDataPaths\": [\n \"<string>\"\n ],\n \"occurredAt\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/v1/events")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["idempotency-key"] = '<idempotency-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"event\": \"<string>\",\n \"profile\": {\n \"email\": \"jsmith@example.com\",\n \"externalId\": \"<string>\",\n \"properties\": {}\n },\n \"data\": {},\n \"referenceId\": \"<string>\",\n \"redactedDataPaths\": [\n \"<string>\"\n ],\n \"occurredAt\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"eventId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"profileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"matchedJourneys": 4503599627370495,
"enrolledJourneys": 4503599627370495,
"skippedJourneys": 4503599627370495
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}Authorizations
Unified API key for server-side SDK and API integrations
Headers
Required idempotency key. Reusing it with the same request replays the original event response; reusing it with a different request returns 409.
1 - 255Body
Free-form business event name, for example order.created.
1 - 255Profile identity and optional durable Profile Property input.
Show child attributes
Show child attributes
One-event payload for this event. This is not copied into Profile Properties.
Show child attributes
Show child attributes
Safe caller correlation id. It is not used for idempotency; use the Idempotency-Key header for that.
1 - 255Event state paths to redact before durable retention. Paths must live under /event/.
^\/event\/Event time. If omitted, Segmentflow uses receipt time.
^(?:(?:\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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Response
Default Response
Durable UserEvent id.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Resolved Profile id.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Count of active Journeys whose entry event matched.
0 <= x <= 9007199254740991Count of Journey enrollments started from this event.
0 <= x <= 9007199254740991Count of matched Journeys skipped by filters or eligibility.
0 <= x <= 9007199254740991
