Create a new custom event

Create a new custom event.

POST /events/custom

Create a new custom event

cURL

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
}
'

200

{
  "name": "<string>",
  "userId": "<string>",
  "externalUserId": "<string>"
}

Authorizations

x-api-token · string · header · required

Body

application/json

eventName · string · required

The name of the custom event

payload · object · required

The payload of the event. An object made up of any key, value pairs you want to store with the event.

userId · string · required

The Nudj ID or the external ID of the user to log the event for

nonce · string · required

Minimum string length: 1

communityId · string | null

The community that the event belongs to

Pattern: ^[0-9a-fA-F]{24}$

autoCreateUser · boolean · default: false

Whether to automatically create a user if they don't exist

Response

200

application/json

Successful response

The payload of the event. An object made up of any key, value pairs you want to store with the event.

name · string · required

The name of the custom event

userId · string · required

The Nudj ID of the user the event has been logged for

Pattern: ^[0-9a-fA-F]{24}$

externalUserId · string

The external ID of the user the event has been logged for