Skip to main content

Create Event

Create a new event for your application to enable check-in functionality.

Endpoint

POST /api/events

Headers

X-API-Key: your-api-key
Content-Type: application/json

Request

{
"eventId": "event-123",
"accessPoint": "https://your-app.com/api/event-access",
"requestVerifier": "verifier-token-123"
}
FieldTypeRequiredDescription
eventIdstringYesUnique identifier for the event in your system
accessPointstringYesURL endpoint that returns an array of email addresses for event attendees
requestVerifierstringYesToken used to verify requests to the access point

Response

{
"status": true,
"message": "Event created successfully",
"data": {
"externalEventId": "event-123",
"checkInCode": "evt_a1b2c3d4e5f6789012345678901234ab",
"accessPoint": "https://your-app.com/api/event-access",
"application": "app_1234567890abcdef",
"createdAt": "2024-01-15T10:30:00.000Z"
}
}

Response Fields

FieldTypeDescription
externalEventIdstringThe event ID you provided (same as eventId in request)
checkInCodestringUnique check-in code for this event (format: evt_ + 32 hex chars)
accessPointstringThe access point URL you provided
applicationstringApplication ID associated with your API key
createdAtstringEvent creation timestamp

Errors

StatusMessage
400Validation failed / Invalid URL format
401Invalid API key / Application not found
409Event with this external event ID already exists for this application

Example

curl -X POST "https://api.reeng.xyz/api/events" \
-H "X-API-Key: your-api-key" \
-H "Content-Type: application/json" \
-d '{
"eventId": "event-123",
"accessPoint": "https://your-app.com/api/event-access",
"requestVerifier": "verifier-token-123"
}'

Notes

  • The eventId must be unique within your application scope
  • The accessPoint URL must be a valid URL and should return an array of email addresses when called with the requestVerifier as a query parameter
  • The checkInCode is generated automatically and is used to initialize check-ins for this event
  • Events are associated with the application linked to your API key