Skip to main content
POST
/
events
/
custom
/
link
Create a new event link
curl --request POST \
  --url https://{subdomain}.nudj.cx/api/v2/admin/events/custom/link \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: <api-key>' \
  --data '
{
  "eventName": "<string>",
  "payload": {},
  "communityId": "<string>",
  "expiryTime": 3600,
  "isSingleUse": true
}
'
{
  "url": "<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.

​
communityId
string | null

The community that the event belongs to

Pattern: ^[0-9a-fA-F]{24}$
​
expiryTime
number
default:3600

Amount of time (in seconds) until the link will expire

​
isSingleUse
boolean
default:true

Whether the link should be able to be used by a single user (true) or multiple users (false)

Response

Successful response

​
url
string
required

The generated event link