Create a new event link

Creates a link to the Nudj platform. When a user follows the link and registers/signs in, they will have the event logged on their behalf.

POST /events/custom/link

Create a new event link

cURL

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

200

{
  "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

200

application/json

Successful response

url · string · required

The generated event link