Create a new custom event
curl --request POST \
--url https://{subdomain}.nudj.cx/api/v2/admin/events/custom \
--header 'Content-Type: application/json' \
--header 'x-api-token: <api-key>' \
--data '
{
"eventName": "<string>",
"payload": {},
"userId": "<string>",
"nonce": "<string>",
"communityId": "<string>",
"autoCreateUser": false
}
'import requests
url = "https://{subdomain}.nudj.cx/api/v2/admin/events/custom"
payload = {
"eventName": "<string>",
"payload": {},
"userId": "<string>",
"nonce": "<string>",
"communityId": "<string>",
"autoCreateUser": False
}
headers = {
"x-api-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
eventName: '<string>',
payload: {},
userId: '<string>',
nonce: '<string>',
communityId: '<string>',
autoCreateUser: false
})
};
fetch('https://{subdomain}.nudj.cx/api/v2/admin/events/custom', 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://{subdomain}.nudj.cx/api/v2/admin/events/custom",
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([
'eventName' => '<string>',
'payload' => [
],
'userId' => '<string>',
'nonce' => '<string>',
'communityId' => '<string>',
'autoCreateUser' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-token: <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 := "https://{subdomain}.nudj.cx/api/v2/admin/events/custom"
payload := strings.NewReader("{\n \"eventName\": \"<string>\",\n \"payload\": {},\n \"userId\": \"<string>\",\n \"nonce\": \"<string>\",\n \"communityId\": \"<string>\",\n \"autoCreateUser\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-token", "<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("https://{subdomain}.nudj.cx/api/v2/admin/events/custom")
.header("x-api-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"eventName\": \"<string>\",\n \"payload\": {},\n \"userId\": \"<string>\",\n \"nonce\": \"<string>\",\n \"communityId\": \"<string>\",\n \"autoCreateUser\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.nudj.cx/api/v2/admin/events/custom")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"eventName\": \"<string>\",\n \"payload\": {},\n \"userId\": \"<string>\",\n \"nonce\": \"<string>\",\n \"communityId\": \"<string>\",\n \"autoCreateUser\": false\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"userId": "<string>",
"externalUserId": "<string>"
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}Events
Create a new custom event
Create a new custom event.
POST
/
events
/
custom
Create a new custom event
curl --request POST \
--url https://{subdomain}.nudj.cx/api/v2/admin/events/custom \
--header 'Content-Type: application/json' \
--header 'x-api-token: <api-key>' \
--data '
{
"eventName": "<string>",
"payload": {},
"userId": "<string>",
"nonce": "<string>",
"communityId": "<string>",
"autoCreateUser": false
}
'import requests
url = "https://{subdomain}.nudj.cx/api/v2/admin/events/custom"
payload = {
"eventName": "<string>",
"payload": {},
"userId": "<string>",
"nonce": "<string>",
"communityId": "<string>",
"autoCreateUser": False
}
headers = {
"x-api-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
eventName: '<string>',
payload: {},
userId: '<string>',
nonce: '<string>',
communityId: '<string>',
autoCreateUser: false
})
};
fetch('https://{subdomain}.nudj.cx/api/v2/admin/events/custom', 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://{subdomain}.nudj.cx/api/v2/admin/events/custom",
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([
'eventName' => '<string>',
'payload' => [
],
'userId' => '<string>',
'nonce' => '<string>',
'communityId' => '<string>',
'autoCreateUser' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-token: <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 := "https://{subdomain}.nudj.cx/api/v2/admin/events/custom"
payload := strings.NewReader("{\n \"eventName\": \"<string>\",\n \"payload\": {},\n \"userId\": \"<string>\",\n \"nonce\": \"<string>\",\n \"communityId\": \"<string>\",\n \"autoCreateUser\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-token", "<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("https://{subdomain}.nudj.cx/api/v2/admin/events/custom")
.header("x-api-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"eventName\": \"<string>\",\n \"payload\": {},\n \"userId\": \"<string>\",\n \"nonce\": \"<string>\",\n \"communityId\": \"<string>\",\n \"autoCreateUser\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.nudj.cx/api/v2/admin/events/custom")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"eventName\": \"<string>\",\n \"payload\": {},\n \"userId\": \"<string>\",\n \"nonce\": \"<string>\",\n \"communityId\": \"<string>\",\n \"autoCreateUser\": false\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"userId": "<string>",
"externalUserId": "<string>"
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}Authorizations
Body
application/json
The name of the custom event
The payload of the event. An object made up of any key, value pairs you want to store with the event.
The Nudj ID or the external ID of the user to log the event for
Minimum string length:
1The community that the event belongs to
Pattern:
^[0-9a-fA-F]{24}$Whether to automatically create a user if they don't exist
Response
Successful response
The payload of the event. An object made up of any key, value pairs you want to store with the event.
Was this page helpful?
⌘I

