Skip to main content
POST
/
v2
/
create-events
Create Events V2
curl --request POST \
  --url 'https://api.example.com/v2/create-events?api_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tenant": "<string>",
  "market": "<string>",
  "events": [
    {
      "transaction_id": "<string>",
      "user_id": "<string>",
      "session_id": "<string>",
      "dsid": "<string>",
      "event_type": "<unknown>"
    }
  ]
}
'
import requests

url = "https://api.example.com/v2/create-events?api_key="

payload = {
"tenant": "<string>",
"market": "<string>",
"events": [
{
"transaction_id": "<string>",
"user_id": "<string>",
"session_id": "<string>",
"dsid": "<string>",
"event_type": "<unknown>"
}
]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
tenant: '<string>',
market: '<string>',
events: [
{
transaction_id: '<string>',
user_id: '<string>',
session_id: '<string>',
dsid: '<string>',
event_type: '<unknown>'
}
]
})
};

fetch('https://api.example.com/v2/create-events?api_key=', 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.example.com/v2/create-events?api_key=",
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([
'tenant' => '<string>',
'market' => '<string>',
'events' => [
[
'transaction_id' => '<string>',
'user_id' => '<string>',
'session_id' => '<string>',
'dsid' => '<string>',
'event_type' => '<unknown>'
]
]
]),
CURLOPT_HTTPHEADER => [
"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.example.com/v2/create-events?api_key="

payload := strings.NewReader("{\n \"tenant\": \"<string>\",\n \"market\": \"<string>\",\n \"events\": [\n {\n \"transaction_id\": \"<string>\",\n \"user_id\": \"<string>\",\n \"session_id\": \"<string>\",\n \"dsid\": \"<string>\",\n \"event_type\": \"<unknown>\"\n }\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

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.example.com/v2/create-events?api_key=")
.header("Content-Type", "application/json")
.body("{\n \"tenant\": \"<string>\",\n \"market\": \"<string>\",\n \"events\": [\n {\n \"transaction_id\": \"<string>\",\n \"user_id\": \"<string>\",\n \"session_id\": \"<string>\",\n \"dsid\": \"<string>\",\n \"event_type\": \"<unknown>\"\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/create-events?api_key=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"tenant\": \"<string>\",\n \"market\": \"<string>\",\n \"events\": [\n {\n \"transaction_id\": \"<string>\",\n \"user_id\": \"<string>\",\n \"session_id\": \"<string>\",\n \"dsid\": \"<string>\",\n \"event_type\": \"<unknown>\"\n }\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}
This page does not apply to installs made in 2025 or later of the Depict Shopify apps

Authorizations

api_key
string
query
required

Body

application/json
tenant
string
required

Identifier associated with the API integration

Minimum string length: 1
market
string
required

Market identifier

Minimum string length: 1
events
(UserTransactionMappingEvent · object | PurchaseEvent · object | ProductUnavailableEvent · object)[]
required

Response

Successful Response