Skip to main content
POST
/
api
/
projects
/
{projectId}
/
test-events
Create test event
curl --request POST \
  --url https://api.example.com/api/projects/{projectId}/test-events \
  --header 'Content-Type: application/json' \
  --data '
{
  "testEvent": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "context": "<string>",
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
'
import requests

url = "https://api.example.com/api/projects/{projectId}/test-events"

payload = { "testEvent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"context": "<string>",
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
} }
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({
testEvent: {
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
context: '<string>',
userId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
documentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
})
};

fetch('https://api.example.com/api/projects/{projectId}/test-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://api.example.com/api/projects/{projectId}/test-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([
'testEvent' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'context' => '<string>',
'userId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'documentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
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/api/projects/{projectId}/test-events"

payload := strings.NewReader("{\n \"testEvent\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"context\": \"<string>\",\n \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"documentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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/api/projects/{projectId}/test-events")
.header("Content-Type", "application/json")
.body("{\n \"testEvent\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"context\": \"<string>\",\n \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"documentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/projects/{projectId}/test-events")

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 \"testEvent\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"context\": \"<string>\",\n \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"documentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "context": "<string>",
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Path Parameters

projectId
string<uuid>
required

ID of the project to create the test event in

Body

application/json
testEvent
object
required

Test event data to create

Response

200 - application/json

The created test event

The created test event

id
string<uuid>
required

Unique identifier of the test event

name
string
required

Name of the test event

context
string
required

JSON context data for the test event

category
enum<string>
required

Category of the test event (private, shared, or global)

Available options:
private,
shared,
global
projectId
string<uuid>
required

ID of the project this test event belongs to

userId
string<uuid> | null

ID of the user who owns this test event (for private events)

documentId
string<uuid> | null

ID of the document this test event is associated with